From 5673efbb144600aea4e4310a8d7b16e8929d9bab Mon Sep 17 00:00:00 2001 From: Alex Obukhov Date: Fri, 6 Mar 2020 00:55:16 +0100 Subject: [PATCH 1/3] Add license to the packaged helmchart Signed-off-by: Alex Obukhov --- README.md | 76 +----------- keratin-authn-server/Chart.yaml | 4 +- keratin-authn-server/LICENSE | 201 ++++++++++++++++++++++++++++++++ keratin-authn-server/README.md | 77 ++++++++++++ 4 files changed, 284 insertions(+), 74 deletions(-) create mode 100644 keratin-authn-server/LICENSE create mode 100644 keratin-authn-server/README.md diff --git a/README.md b/README.md index b96324b..188eb80 100644 --- a/README.md +++ b/README.md @@ -1,77 +1,7 @@ # Keratin helm charts -This chart makes it easier to deploy [keratin auth server](https://keratin.tech/) to k8s cluster. +Helm chart(s) for components of keratin authn service -*This is a beta version of the chart. Feel free to use it and provide feedback* +## authn-server [[readme](https://github.com/keratin/helm-charts/blob/master/keratin-authn-server/README.md)] -## Chart configuration - -Minimal values file: -``` -appSettings: - authnUrl: "https://auth.example.com" - appDomains: "app.example.com,app2.example.com" - -internalApi: - username: "user for internal api" - password: "password for internal api" - -secretKeyBase: "random secret string" -``` - -Random secret string and password can be generated for example with the following command: - -``` -openssl rand -base64 48 -``` - -In this case redis and mariadb instances will be deployed automatically from bitnami charts. - -If you use managed versions of redis or database you can override these settings with the following values: -``` -persistence: - databaseUrl: "mysql://user:password@host:3306/dbname" - redisUrl: "redis://host:6379/0" - - -redis: - enabled: false - -mariadb: - enabled: false -``` - -## Installation - -Add repository first: - -```bash -helm repo add keratin https://keratin.github.io/helm-repo/charts/ -``` - -Create values.yaml file as described above. - -Install helm chart into your kubernetes with the following command (command for helm3) - -```bash -helm upgrade --install --atomic -n -f ./values.yaml keratin/keratin-authn-server -``` - -### Helm2 installation - -If you want to install the chart with helm of version 2 install the 0.0.* version of the chart: - -```bash -# This is the command for helm2 -helm install --name -n -f ./values.yaml --version 0.0.1 keratin/keratin-authn-server -``` - -## Building the chart - -You need to build the chart only if you fork it and modify the templates. If you just install the chart - these steps are not needed. - -To download dependencies - -```bash -helm dep up ./keratin-authn-server/ -``` +Authentication service that keeps you in control without forcing you to be an expert in web security. \ No newline at end of file diff --git a/keratin-authn-server/Chart.yaml b/keratin-authn-server/Chart.yaml index 6ba3ac1..77b01b1 100644 --- a/keratin-authn-server/Chart.yaml +++ b/keratin-authn-server/Chart.yaml @@ -1,10 +1,12 @@ apiVersion: v2 name: keratin-authn-server description: Ready to use authn microservice +home: https://keratin.tech +icon: https://keratin.tech/pangolin-logo-dark.gif type: application version: 0.1.0 -appVersion: 1.7.0 +appVersion: 1.8.0 maintainers: - email: a.a.obukhov@gmail.com name: Aleks Obukhov diff --git a/keratin-authn-server/LICENSE b/keratin-authn-server/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/keratin-authn-server/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/keratin-authn-server/README.md b/keratin-authn-server/README.md new file mode 100644 index 0000000..b96324b --- /dev/null +++ b/keratin-authn-server/README.md @@ -0,0 +1,77 @@ +# Keratin helm charts + +This chart makes it easier to deploy [keratin auth server](https://keratin.tech/) to k8s cluster. + +*This is a beta version of the chart. Feel free to use it and provide feedback* + +## Chart configuration + +Minimal values file: +``` +appSettings: + authnUrl: "https://auth.example.com" + appDomains: "app.example.com,app2.example.com" + +internalApi: + username: "user for internal api" + password: "password for internal api" + +secretKeyBase: "random secret string" +``` + +Random secret string and password can be generated for example with the following command: + +``` +openssl rand -base64 48 +``` + +In this case redis and mariadb instances will be deployed automatically from bitnami charts. + +If you use managed versions of redis or database you can override these settings with the following values: +``` +persistence: + databaseUrl: "mysql://user:password@host:3306/dbname" + redisUrl: "redis://host:6379/0" + + +redis: + enabled: false + +mariadb: + enabled: false +``` + +## Installation + +Add repository first: + +```bash +helm repo add keratin https://keratin.github.io/helm-repo/charts/ +``` + +Create values.yaml file as described above. + +Install helm chart into your kubernetes with the following command (command for helm3) + +```bash +helm upgrade --install --atomic -n -f ./values.yaml keratin/keratin-authn-server +``` + +### Helm2 installation + +If you want to install the chart with helm of version 2 install the 0.0.* version of the chart: + +```bash +# This is the command for helm2 +helm install --name -n -f ./values.yaml --version 0.0.1 keratin/keratin-authn-server +``` + +## Building the chart + +You need to build the chart only if you fork it and modify the templates. If you just install the chart - these steps are not needed. + +To download dependencies + +```bash +helm dep up ./keratin-authn-server/ +``` From e46c2a3b307c768144dcd71dbed4144dc562ce06 Mon Sep 17 00:00:00 2001 From: Alex Obukhov Date: Fri, 6 Mar 2020 00:56:13 +0100 Subject: [PATCH 2/3] Add docs to README.md Signed-off-by: Alex Obukhov --- keratin-authn-server/README.md | 66 ++++++++++++++++++++++++++++------ 1 file changed, 56 insertions(+), 10 deletions(-) diff --git a/keratin-authn-server/README.md b/keratin-authn-server/README.md index b96324b..fd48d6f 100644 --- a/keratin-authn-server/README.md +++ b/keratin-authn-server/README.md @@ -1,6 +1,6 @@ # Keratin helm charts -This chart makes it easier to deploy [keratin auth server](https://keratin.tech/) to k8s cluster. +This chart makes it easier to deploy [keratin authn server](https://keratin.tech/) to k8s cluster. *This is a beta version of the chart. Feel free to use it and provide feedback* @@ -66,12 +66,58 @@ If you want to install the chart with helm of version 2 install the 0.0.* versio helm install --name -n -f ./values.yaml --version 0.0.1 keratin/keratin-authn-server ``` -## Building the chart - -You need to build the chart only if you fork it and modify the templates. If you just install the chart - these steps are not needed. - -To download dependencies - -```bash -helm dep up ./keratin-authn-server/ -``` +## Configuration + +The following table lists the configurable parameters of the Adminer chart and the default values. + +| Parameter | Description | Default | +| --------------------------------- | ----------------------------------------------------------------------- | --------------------------- | +| **Image** | +| `image.repository` | Image | `keratin/authn-server` | +| `image.pullPolicy` | Image pull policy | `IfNotPresent` | +| **Config** | +| `appSettings.authnUrl` | The base URL of the AuthN service | `-` | +| `appSettings.appDomains` | Comma-delimited list of application trusted domains | `-` | +| `internalApi.username` | HTTP Basic Auth username to access internal API | `-` | +| `internalApi.password` | HTTP Basic Auth password to access internal API | `-` | +| `secretKeyBase` | Random string to derive HMAC keys used by AuthN from | `-` | +| **Service** | +| `service.type` | Service type | `ClusterIP` | +| `service.port` | The service port | `80` | +| **Service for internal API** | +| `serviceInternal.type` | Service type | `ClusterIP` | +| `serviceInternal.port` | The service port | `8080` | +| **Ingress** | +| `ingress.enabled` | Enables Ingress | `false` | +| `ingress.annotations` | Ingress annotations | `{}` | +| `ingress.labels` | Custom labels | `{}` | +| `ingress.hosts` | Ingress accepted hostnames | `[]` | +| `ingress.tls` | Ingress TLS configuration | `[]` | +| **Ingress for internal API** (if you have services outside of kubernetes cluster) | +| `ingressInternal.enabled` | Enables Ingress | `false` | +| `ingressInternal.annotations` | Ingress annotations | `{}` | +| `ingressInternal.labels` | Custom labels | `{}` | +| `ingressInternal.hosts` | Ingress accepted hostnames | `[]` | +| `ingressInternal.tls` | Ingress TLS configuration | `[]` | +| **Resources** | +| `resources` | CPU/Memory resource requests/limits | `{}` | +| **Tolerations** | +| `tolerations` | Add tolerations | `[]` | +| **NodeSelector** | +| `nodeSelector` | node labels for pod assignment | `{}` | +| **Affinity** | +| `affinity` | node/pod affinities | `{}` | + +## Credits + +Initially inspired from https://github.com/mogaal/helm-charts/tree/master/adminer. + +## Contributing + +Feel free to contribute by making a [pull request](https://github.com/kratin/helm-charts/pull/new/master). + +Please read the official [Contribution Guide](https://github.com/helm/charts/blob/master/CONTRIBUTING.md) from Helm for more information on how you can contribute to this Chart. + +## License + +[Apache License 2.0](LICENSE.md) \ No newline at end of file From ad652f6059abf08ba29390c8f36b9e0e01bf6732 Mon Sep 17 00:00:00 2001 From: Alex Obukhov Date: Fri, 6 Mar 2020 00:56:52 +0100 Subject: [PATCH 3/3] Bump chart version Signed-off-by: Alex Obukhov --- keratin-authn-server/Chart.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/keratin-authn-server/Chart.yaml b/keratin-authn-server/Chart.yaml index 77b01b1..4f6c452 100644 --- a/keratin-authn-server/Chart.yaml +++ b/keratin-authn-server/Chart.yaml @@ -5,7 +5,7 @@ home: https://keratin.tech icon: https://keratin.tech/pangolin-logo-dark.gif type: application -version: 0.1.0 +version: 0.1.1 appVersion: 1.8.0 maintainers: - email: a.a.obukhov@gmail.com