From bfa105970ac9f93dde02daf9f73f159f0f9119bf Mon Sep 17 00:00:00 2001 From: Jeffrey Regan Date: Tue, 8 May 2018 10:16:03 -0700 Subject: [PATCH] add license --- CONTRIBUTING.md | 40 ++++++ LICENSE | 201 +++++++++++++++++++++++++++++ OWNERS | 8 ++ demos/data/ldap/base/tests/test.sh | 66 +++++++--- docs/kustomization.yaml | 14 ++ 5 files changed, 308 insertions(+), 21 deletions(-) create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 OWNERS diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..bd34b6ff7c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,40 @@ +# Contributing guidelines + +[Contributor License Agreement]: https://git.k8s.io/community/CLA.md +[github workflow guide]: https://github.com/kubernetes/community/blob/master/contributors/guide/github-workflow.md +[CNCF code of conduct]: https://github.com/cncf/foundation/blob/master/code-of-conduct.md + +## Contributing A Patch + +1. Kubernetes projects require contributors to sign the + [Contributor License Agreement] before pull requests + can be considered. +1. Submit an issue describing your proposed change to + the repo in question. +1. The [repo owners](OWNERS) will respond to your issue + promptly. +1. If your proposed change is accepted, and you haven't + already done so, sign a Contributor License + Agreement (see details above). +1. Fork the desired repo, develop and test your code. + See the [github workflow guide] for more information. +1. For new features, provide a markdown based demo following + the pattern established in the `demos` directory. + Run `bin/pre-commit.sh` to test your demo. +1. Submit a pull request. + + +## Community, discussion, contribution, and support + +Learn how to engage with the Kubernetes community on +the [community page](http://kubernetes.io/community/). + +You can reach the maintainers of this project at: + +- [Slack](http://slack.k8s.io/) +- [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-kustomize) + +## Code of conduct + +Participation in the Kubernetes community is governed +by the [CNCF code of conduct]. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000..8dada3edaf --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/OWNERS b/OWNERS new file mode 100644 index 0000000000..b19fc37e66 --- /dev/null +++ b/OWNERS @@ -0,0 +1,8 @@ +# See https://github.com/kubernetes/community/blob/master/community-membership.md + +approvers: + - droot + - liujingfang1 + - mengqiy + - monopole + - pwittrock diff --git a/demos/data/ldap/base/tests/test.sh b/demos/data/ldap/base/tests/test.sh index de5ebd5cd2..f7b0c42f4b 100755 --- a/demos/data/ldap/base/tests/test.sh +++ b/demos/data/ldap/base/tests/test.sh @@ -1,17 +1,31 @@ #!/bin/bash - -# This script validates that this package works as expected with kustomize. -# The validation makes sure following steps are correctly executed and the output is as expected +# Copyright 2018 The Kubernetes Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# ---------------------------------------------------- +# +# This script tests the ldap kustomization demo +# against a real cluster. +# # - deploy a ldap server by the output of kustomize # - add a user # - query a user # - delete a user # -# This script should be called as -# test.sh -# -# Testing passes if exit code is 0 -# Tesging fails if exit code is 1 +# This script is a test that (passes|fails) if exit +# code is (0|1). + set -x function exit_with { @@ -21,14 +35,14 @@ function exit_with { } # make sure kustomize and kubectl are available -command -v kustomize >/dev/null 2>&1 || { exit_with "Require kustomize but it's not installed. Aborting."; } -command -v kubectl >/dev/null 2>&1 || { exit_with "Require kubectl but it's not installed. Aborting."; } +command -v kustomize >/dev/null 2>&1 || \ + { exit_with "Require kustomize but it's not installed. Aborting."; } +command -v kubectl >/dev/null 2>&1 || \ + { exit_with "Require kubectl but it's not installed. Aborting."; } # set namespace to default kubectl config set-context $(kubectl config current-context) --namespace=default -# run kustomize -# kustomize build $1 | kubectl apply -f - || { exit_with "Failed to run kubectl apply"; } echo Kustomizing \"$1\" ls $1 kustomize build $1 > generatedResources.yaml @@ -56,23 +70,33 @@ EOF # add a user pod_ldiffile="/tmp/user.ldif" -kubectl cp $ldiffile ${namespace}/${pod}:${pod_ldiffile} || { exit_with "Failed to copy ldif file to Pod ${pod}"; } -kubectl exec ${pod} -c ${container} -- ldapadd -x -H ldap://localhost -D "cn=admin,dc=example,dc=org" -w admin \ --f ${pod_ldiffile} || { exit_with "Failed to add a user"; } +kubectl cp $ldiffile ${namespace}/${pod}:${pod_ldiffile} || \ + { exit_with "Failed to copy ldif file to Pod ${pod}"; } + +kubectl exec ${pod} -c ${container} -- \ + ldapadd -x -H ldap://localhost -D "cn=admin,dc=example,dc=org" -w admin \ + -f ${pod_ldiffile} || { exit_with "Failed to add a user"; } # query the added user -r=$(kubectl exec ${pod} -c ${container} -- ldapsearch -x -H ldap://localhost -b dc=example,dc=org \ --D "cn=admin,dc=example,dc=org" -w admin) +r=$(kubectl exec ${pod} -c ${container} -- \ + ldapsearch -x -H ldap://localhost -b dc=example,dc=org \ + -D "cn=admin,dc=example,dc=org" -w admin) + user_count=$(echo ${r} | grep "cn: The Postmaster" | wc -l) [[ ${user_count} -eq 0 ]] && { exit_with "Couldn't find the new added user"; } # delete the added user -kubectl exec ${pod} -c ${container} -- ldapdelete -v -x -H ldap://localhost "cn=The Postmaster,dc=example,dc=org" \ --D "cn=admin,dc=example,dc=org" -w admin || { exit_with "Failed to delete the user"; } -r=$(kubectl exec ${pod} -c ${container} -- ldapsearch -x -H ldap://localhost -b dc=example,dc=org -D "cn=admin,dc=example,dc=org" -w admin) +kubectl exec ${pod} -c ${container} -- \ + ldapdelete -v -x -H ldap://localhost "cn=The Postmaster,dc=example,dc=org" \ + -D "cn=admin,dc=example,dc=org" -w admin || \ + { exit_with "Failed to delete the user"; } + +r=$(kubectl exec ${pod} -c ${container} -- \ + ldapsearch -x -H ldap://localhost -b dc=example,dc=org \ + -D "cn=admin,dc=example,dc=org" -w admin) user_count=$(echo ${r} | grep "cn: The Postmaster" | wc -l) [[ ${user_count} -ne 0 ]] && { exit_with "The user hasn't been deleted."; } # kubectl delete kubectl delete -f generatedResources.yaml -rm $ldiffile \ No newline at end of file +rm $ldiffile diff --git a/docs/kustomization.yaml b/docs/kustomization.yaml index b0ad1c1b5c..19762dd787 100644 --- a/docs/kustomization.yaml +++ b/docs/kustomization.yaml @@ -1,3 +1,17 @@ +# Copyright 2018 The Kubernetes Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# # ---------------------------------------------------- # Example kustomization.yaml content. #