diff --git a/INSTALL.md b/INSTALL.md index 0472c79..edd5fd4 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -77,5 +77,5 @@ The Helm Chart can be configured using the following parameters. For a full over ### Prerequisites - Kubernetes 1.19+ -- Helm 3.10.2+ +- Helm 3.2.0+ - PV provisioner support in the underlying infrastructure \ No newline at end of file diff --git a/charts/discoveryfinder/.helmignore b/charts/discoveryfinder/.helmignore index 0e8a0eb..5480d6b 100644 --- a/charts/discoveryfinder/.helmignore +++ b/charts/discoveryfinder/.helmignore @@ -21,3 +21,6 @@ .idea/ *.tmproj .vscode/ +# Accept only values.yaml +values?*.yaml +values?*.yml \ No newline at end of file diff --git a/charts/discoveryfinder/Chart.yaml b/charts/discoveryfinder/Chart.yaml index fd0b557..1de22bb 100644 --- a/charts/discoveryfinder/Chart.yaml +++ b/charts/discoveryfinder/Chart.yaml @@ -19,7 +19,9 @@ apiVersion: v2 name: discoveryfinder description: Tractus-X Discovery Finder Helm Chart - +home: https://eclipse-tractusx.github.io/ +sources: + - https://github.com/eclipse-tractusx/sldt-discovery-finder type: application version: 0.1.6 appVersion: 0.2.3-M1 diff --git a/charts/discoveryfinder/LICENSE b/charts/discoveryfinder/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/charts/discoveryfinder/LICENSE @@ -0,0 +1,202 @@ + + 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/charts/discoveryfinder/README.md b/charts/discoveryfinder/README.md new file mode 100644 index 0000000..97dc69f --- /dev/null +++ b/charts/discoveryfinder/README.md @@ -0,0 +1,68 @@ +# discoveryfinder + +![Version: 0.1.5](https://img.shields.io/badge/Version-0.1.5-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.2.2-M1](https://img.shields.io/badge/AppVersion-0.2.2--M1-informational?style=flat-square) + +**Tractus-X Discovery Finder Helm Chart**
+This chart installs the Discovery Finder and its direct dependencies. + +## Requirements + +| Repository | Name | Version | +|------------|------|---------| +| https://charts.bitnami.com/bitnami | postgresql | 12.2.3 | + +## Prerequisites +- Kubernetes 1.19+ +- Helm 3.2.0+ +- PV provisioner support in the underlying infrastructure + +## Install +``` +helm dep up charts/discoveryfinder +kubectl create namespace discovery +helm install discoveryfinder -n discovery charts/discoveryfinder +``` + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| discoveryfinder.authentication | bool | `true` | | +| discoveryfinder.containerPort | int | `4243` | | +| discoveryfinder.dataSource.driverClassName | string | `"org.postgresql.Driver"` | | +| discoveryfinder.dataSource.password | string | `"password"` | | +| discoveryfinder.dataSource.sqlInitPlatform | string | `"pg"` | | +| discoveryfinder.dataSource.url | string | `"jdbc:postgresql://database:5432"` | | +| discoveryfinder.dataSource.user | string | `"user"` | | +| discoveryfinder.host | string | `"localhost"` | | +| discoveryfinder.idp.issuerUri | string | `"https://idp-url"` | | +| discoveryfinder.idp.publicClientId | string | `"idpClientID"` | | +| discoveryfinder.image.imagePullPolicy | string | `"IfNotPresent"` | | +| discoveryfinder.image.registry | string | `"docker.io"` | | +| discoveryfinder.image.repository | string | `"tractusx/sldt-discovery-finder"` | | +| discoveryfinder.ingress.annotations."cert-manager.io/cluster-issuer" | string | `"selfsigned-cluster-issuer"` | | +| discoveryfinder.ingress.annotations."nginx.ingress.kubernetes.io/cors-allow-credentials" | string | `"true"` | | +| discoveryfinder.ingress.annotations."nginx.ingress.kubernetes.io/enable-cors" | string | `"true"` | | +| discoveryfinder.ingress.annotations."nginx.ingress.kubernetes.io/rewrite-target" | string | `"/$2"` | | +| discoveryfinder.ingress.annotations."nginx.ingress.kubernetes.io/use-regex" | string | `"true"` | | +| discoveryfinder.ingress.annotations."nginx.ingress.kubernetes.io/x-forwarded-prefix" | string | `"/discoveryfinder"` | | +| discoveryfinder.ingress.className | string | `"nginx"` | | +| discoveryfinder.ingress.enabled | bool | `false` | | +| discoveryfinder.ingress.tls | bool | `false` | | +| discoveryfinder.ingress.urlPrefix | string | `"/discoveryfinder"` | | +| discoveryfinder.properties.discoveryfinder | string | `nil` | | +| discoveryfinder.replicaCount | int | `1` | | +| discoveryfinder.resources.limits.memory | string | `"1024Mi"` | | +| discoveryfinder.resources.requests.memory | string | `"512Mi"` | | +| discoveryfinder.service.port | int | `8080` | | +| discoveryfinder.service.type | string | `"ClusterIP"` | | +| enablePostgres | bool | `true` | | +| postgresql.auth.database | string | `"discoveryfinder"` | | +| postgresql.auth.password | string | `"password"` | | +| postgresql.auth.username | string | `"catenax"` | | +| postgresql.primary.persistence.enabled | bool | `true` | | +| postgresql.primary.persistence.size | string | `"50Gi"` | | +| postgresql.service.ports.postgresql | int | `5432` | | + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0) diff --git a/charts/discoveryfinder/templates/ConfigMap.yaml b/charts/discoveryfinder/templates/ConfigMap.yaml index ac658e3..93778cc 100644 --- a/charts/discoveryfinder/templates/ConfigMap.yaml +++ b/charts/discoveryfinder/templates/ConfigMap.yaml @@ -1,3 +1,21 @@ +# Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH +# Copyright (c) 2023 Contributors to the Eclipse Foundation +# +# See the NOTICE file(s) distributed with this work for additional +# information regarding copyright ownership. +# +# This program and the accompanying materials are made available under the +# terms of the Apache License, Version 2.0 which is available at +# https://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. +# +# SPDX-License-Identifier: Apache-2.0 +############################################################### apiVersion: v1 kind: ConfigMap metadata: diff --git a/charts/discoveryfinder/templates/deployment.yaml b/charts/discoveryfinder/templates/deployment.yaml index b67c18f..65dca76 100644 --- a/charts/discoveryfinder/templates/deployment.yaml +++ b/charts/discoveryfinder/templates/deployment.yaml @@ -1,3 +1,21 @@ +# Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH +# Copyright (c) 2023 Contributors to the Eclipse Foundation + # + # See the NOTICE file(s) distributed with this work for additional + # information regarding copyright ownership. + # + # This program and the accompanying materials are made available under the + # terms of the Apache License, Version 2.0 which is available at + # https://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. + # + # SPDX-License-Identifier: Apache-2.0 + ############################################################### {{- $deployment_name := printf "cx-%s" .Release.Name }} {{- $sec_name := printf "%s-sec" $deployment_name }} {{- $svc_name := printf "%s-svc" $deployment_name }}