From 158bf5abd5ab939c1c9fc325736d9f9e3928f83a Mon Sep 17 00:00:00 2001 From: adkumar1 Date: Thu, 22 Feb 2024 16:35:43 +0530 Subject: [PATCH 1/7] updated Installation steps --- CHANGELOG.md | 1 + INSTALL.md | 20 ++++++++++---------- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4ecd5233..da3fad7f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) ## [Unreleased] ### Changed - Updated Spring Boot and its transitive dependencies +- Updated installation steps in Install.md ## [2.1.9] - 2024-01-30 diff --git a/INSTALL.md b/INSTALL.md index 7c448abd..d5681c31 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -2,24 +2,25 @@ Helm charts are provided inside https://github.com/eclipse-tractusx/sd-factory -1.) Using helm commands:
+1.) Installation from released chart:
How to install application using helm:
helm install ReleaseName ChartName - a.) Add helm repository in tractusx: - helm repo add sd-factory https://eclipse-tractusx.github.io/charts/dev + a.) Add helm repository for sdfactory: + helm repo add [name] https://eclipse-tractusx.github.io/charts/dev b.) To search the specific repo in helm repositories - helm search repo sd-factory/sdfactory + helm search repo [name]/sdfactory c.) To install using helm command: - helm install sdf sd-factory/sdfactory + helm install [ReleaseName] [name]/sdfactory -2.) Local installation: +2.) Installation from repository: a.) git clone https://github.com/eclipse-tractusx/sd-factory.git - b.) Modify values file according to your requirement - c.) You need to define the secrets as well in values.yaml + b.) cd sd-factory + c.) Modify values file according to your requirement + d.) You need to define the secrets as well in values.yaml secret: jwkSetUri: -> JWK Set URL clientId: -> Custodian wallet client id @@ -34,7 +35,6 @@ How to install application using helm:
clearingHouseClientId: -> Client id for Clearing House clearingHouseClientSecret: -> Clearing house for Client secret - d.) These secrets should be defined in Hashicorp vault e.) Deploy in a kubernetes cluster - helm install sdfactory charts/SDFactory/ -n NameSpace + helm install [name] charts/sdfactory/ -n [NameSpace] From fd56be9a69b8b877ab3ce34f2d2024761be66068 Mon Sep 17 00:00:00 2001 From: adkumar1 Date: Fri, 23 Feb 2024 22:15:43 +0530 Subject: [PATCH 2/7] command update --- INSTALL.md | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index d5681c31..543f5d14 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,22 +1,22 @@ ## Installation Steps -Helm charts are provided inside https://github.com/eclipse-tractusx/sd-factory - -1.) Installation from released chart:
+Helm chart is provided inside https://github.com/eclipse-tractusx/sd-factory How to install application using helm:
- helm install ReleaseName ChartName + helm install [ReleaseName] [ChartName] + +1.) Installation from released chart:
- a.) Add helm repository for sdfactory: - helm repo add [name] https://eclipse-tractusx.github.io/charts/dev + a.) Add helm repository for tractusx-dev: + helm repo add tractusx-dev https://eclipse-tractusx.github.io/charts/dev b.) To search the specific repo in helm repositories - helm search repo [name]/sdfactory - c.) To install using helm command: - helm install [ReleaseName] [name]/sdfactory + helm search repo tractusx-dev/sdfactory + c.) To install using helm command in kubernetes cluster + helm install [ReleaseName] tractusx-dev/sdfactory -n [NameSpace] 2.) Installation from repository: - + a.) git clone https://github.com/eclipse-tractusx/sd-factory.git b.) cd sd-factory c.) Modify values file according to your requirement @@ -36,5 +36,4 @@ How to install application using helm:
clearingHouseClientSecret: -> Clearing house for Client secret e.) Deploy in a kubernetes cluster - helm install [name] charts/sdfactory/ -n [NameSpace] - + helm install [name] charts/sdfactory/ -n [NameSpace] \ No newline at end of file From 389fc36f4eb8087fc1b89d643bd92c5c98cefcd5 Mon Sep 17 00:00:00 2001 From: adkumar1 Date: Fri, 23 Feb 2024 22:34:13 +0530 Subject: [PATCH 3/7] statement update --- INSTALL.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 543f5d14..caa0dbee 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -11,8 +11,9 @@ How to install application using helm:
helm repo add tractusx-dev https://eclipse-tractusx.github.io/charts/dev b.) To search the specific repo in helm repositories helm search repo tractusx-dev/sdfactory - c.) To install using helm command in kubernetes cluster - helm install [ReleaseName] tractusx-dev/sdfactory -n [NameSpace] + c.) To set your own configuration and secret values, install the helm chart with your own values file in kubernetes cluster: + + helm install -f your-values.yaml [ReleaseName] tractusx-dev/sdfactory -n [NameSpace] 2.) Installation from repository: @@ -20,7 +21,7 @@ How to install application using helm:
a.) git clone https://github.com/eclipse-tractusx/sd-factory.git b.) cd sd-factory c.) Modify values file according to your requirement - d.) You need to define the secrets as well in values.yaml + d.) You need to define the secrets as well in your-values.yaml. These secrets should be defined in Hashicorp vault to keep them secure secret: jwkSetUri: -> JWK Set URL clientId: -> Custodian wallet client id @@ -35,5 +36,6 @@ How to install application using helm:
clearingHouseClientId: -> Client id for Clearing House clearingHouseClientSecret: -> Clearing house for Client secret - e.) Deploy in a kubernetes cluster - helm install [name] charts/sdfactory/ -n [NameSpace] \ No newline at end of file + e.) To set your own configuration and secret values, install the helm chart with your own values file in a kubernetes cluster + + helm install -f your-values.yaml [ReleaseName] charts/sdfactory/ -n [NameSpace] \ No newline at end of file From aab7c6d362ad8c5708afd7b4a29046f12014c75c Mon Sep 17 00:00:00 2001 From: adkumar1 Date: Fri, 23 Feb 2024 22:38:15 +0530 Subject: [PATCH 4/7] format --- INSTALL.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index caa0dbee..ebf0370f 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -3,7 +3,8 @@ Helm chart is provided inside https://github.com/eclipse-tractusx/sd-factory How to install application using helm:
- helm install [ReleaseName] [ChartName] + + helm install [ReleaseName] [ChartName] 1.) Installation from released chart:
@@ -12,7 +13,6 @@ How to install application using helm:
b.) To search the specific repo in helm repositories helm search repo tractusx-dev/sdfactory c.) To set your own configuration and secret values, install the helm chart with your own values file in kubernetes cluster: - helm install -f your-values.yaml [ReleaseName] tractusx-dev/sdfactory -n [NameSpace] @@ -37,5 +37,4 @@ How to install application using helm:
clearingHouseClientSecret: -> Clearing house for Client secret e.) To set your own configuration and secret values, install the helm chart with your own values file in a kubernetes cluster - helm install -f your-values.yaml [ReleaseName] charts/sdfactory/ -n [NameSpace] \ No newline at end of file From 29ce41323d3fd0aa955bd53a34142eda70b5362d Mon Sep 17 00:00:00 2001 From: adkumar1 Date: Mon, 26 Feb 2024 15:38:04 +0530 Subject: [PATCH 5/7] modification in steps --- INSTALL.md | 25 ++++++------------------- 1 file changed, 6 insertions(+), 19 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index ebf0370f..72cf8df2 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,6 +1,6 @@ ## Installation Steps -Helm chart is provided inside https://github.com/eclipse-tractusx/sd-factory +A helm chart is provided inside the [charts](https://github.com/eclipse-tractusx/sd-factory/tree/main/charts/sdfactory) directory How to install application using helm:
@@ -12,29 +12,16 @@ How to install application using helm:
helm repo add tractusx-dev https://eclipse-tractusx.github.io/charts/dev b.) To search the specific repo in helm repositories helm search repo tractusx-dev/sdfactory - c.) To set your own configuration and secret values, install the helm chart with your own values file in kubernetes cluster: + c.) To set your own configuration and secret values, install the helm chart with your own values file in kubernetes cluster helm install -f your-values.yaml [ReleaseName] tractusx-dev/sdfactory -n [NameSpace] + d.) These secrets should be defined in Hashicorp vault to keep them secure. + + 2.) Installation from repository: a.) git clone https://github.com/eclipse-tractusx/sd-factory.git b.) cd sd-factory - c.) Modify values file according to your requirement - d.) You need to define the secrets as well in your-values.yaml. These secrets should be defined in Hashicorp vault to keep them secure - secret: - jwkSetUri: -> JWK Set URL - clientId: -> Custodian wallet client id - clientSecret: -> Custodian wallet client secret - authServerUrl: -> Keycloak URL - realm: -> Keycloak Realm - resource: -> Keycloak Resource - custodianWalletUri: -> Custodian wallet URI - clearingHouseUri: -> Clearing House URI - clearingHouseServerUrl: -> Clearing House server URL - clearingHouseRealm: -> Realm for Clearing House - clearingHouseClientId: -> Client id for Clearing House - clearingHouseClientSecret: -> Clearing house for Client secret - - e.) To set your own configuration and secret values, install the helm chart with your own values file in a kubernetes cluster + c.) To set your own configuration and secret values, install the helm chart with your own values file in a kubernetes cluster helm install -f your-values.yaml [ReleaseName] charts/sdfactory/ -n [NameSpace] \ No newline at end of file From bce2b7d6948645996457a6d7b2db154e19b7405c Mon Sep 17 00:00:00 2001 From: adkumar1 Date: Tue, 27 Feb 2024 15:44:16 +0530 Subject: [PATCH 6/7] updated the installation steps --- INSTALL.md | 23 +++++++++++++++++++---- charts/sdfactory/README.md | 11 +++++++++-- 2 files changed, 28 insertions(+), 6 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 72cf8df2..33a0b444 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,6 +1,6 @@ ## Installation Steps -A helm chart is provided inside the [charts](https://github.com/eclipse-tractusx/sd-factory/tree/main/charts/sdfactory) directory +A helm chart is provided inside the [charts](sd-factory/charts) directory How to install application using helm:
@@ -12,9 +12,24 @@ How to install application using helm:
helm repo add tractusx-dev https://eclipse-tractusx.github.io/charts/dev b.) To search the specific repo in helm repositories helm search repo tractusx-dev/sdfactory - c.) To set your own configuration and secret values, install the helm chart with your own values file in kubernetes cluster + c.) To set your own configuration and secret values. + These secrets should be defined in Hashicorp vault to keep them secure. + secret: + jwkSetUri: -> JWK Set URL + clientId: -> Custodian wallet client id + clientSecret: -> Custodian wallet client secret + authServerUrl: -> Keycloak URL + realm: -> Keycloak Realm + resource: -> Keycloak Resource + custodianWalletUri: -> Custodian wallet URI + clearingHouseUri: -> Clearing House URI + clearingHouseServerUrl: -> Clearing House server URL + clearingHouseRealm: -> Realm for Clearing House + clearingHouseClientId: -> Client id for Clearing House + clearingHouseClientSecret: -> Clearing house for Client secret + + d.) Run below command to install the helm chart with your own values file in kubernetes cluster helm install -f your-values.yaml [ReleaseName] tractusx-dev/sdfactory -n [NameSpace] - d.) These secrets should be defined in Hashicorp vault to keep them secure. @@ -24,4 +39,4 @@ How to install application using helm:
a.) git clone https://github.com/eclipse-tractusx/sd-factory.git b.) cd sd-factory c.) To set your own configuration and secret values, install the helm chart with your own values file in a kubernetes cluster - helm install -f your-values.yaml [ReleaseName] charts/sdfactory/ -n [NameSpace] \ No newline at end of file + helm install -f your-values.yaml [ReleaseName] charts/sdfactory/ -n [NameSpace] diff --git a/charts/sdfactory/README.md b/charts/sdfactory/README.md index 6098e993..3227e460 100644 --- a/charts/sdfactory/README.md +++ b/charts/sdfactory/README.md @@ -18,7 +18,7 @@ Helm Charts for SD Factory application. Self-Description Factory component is re | autoscaling.minReplicas | int | `1` | | | autoscaling.targetCPUUtilizationPercentage | int | `80` | | | fullnameOverride | string | `""` | | -| image.pullPolicy | string | `"Always"` | Set the Image Pull Policy | +| image.pullPolicy | string | `"IfNotPresent"` | Set the Image Pull Policy | | image.repository | string | `"tractusx/sdfactory"` | Image to use for deploying an application | | image.tag | string | `""` | Image tage is defined in chart appVersion. | | imagePullSecrets | list | `[]` | | @@ -30,10 +30,14 @@ Helm Charts for SD Factory application. Self-Description Factory component is re | ingress.issuer | string | `"letsencrypt-prod"` | Kubernetes resources that represent certificate authorities that are able to generate signed certificates by honoring certificate signing requests. | | ingress.tls[0].hosts | string | `""` | | | ingress.tls[0].tlsName | string | `""` | | +| livenessProbe.initialDelaySeconds | int | `10` | | +| livenessProbe.periodSeconds | int | `10` | | | nameOverride | string | `""` | | | nodeSelector | object | `{}` | | | podAnnotations | object | `{}` | | | podSecurityContext.fsGroup | int | `2000` | | +| readinessProbe.initialDelaySeconds | int | `10` | | +| readinessProbe.periodSeconds | int | `10` | | | replicaCount | int | `1` | Number of Replicas for pods | | resources.limits.cpu | string | `"600m"` | set a maximum amount of allows CPU utilization by specifying a limit on the container. | | resources.limits.memory | string | `"700Mi"` | set a maximum amount of allows memory utilization by specifying a limit on the container. | @@ -51,7 +55,10 @@ Helm Charts for SD Factory application. Self-Description Factory component is re | sdfactory.secret.jwkSetUri | string | `""` | JWK Set URI | | sdfactory.secret.realm | string | `""` | Keycloak Realm detail | | sdfactory.secret.resource | string | `""` | Keycloak Resource detail | -| securityContext.allowPrivilegeEscalation | bool | `false` | Controls whether a process can gain more privileges | +| securityContext.allowPrivilegeEscalation | bool | `false` | | +| securityContext.capabilities.drop[0] | string | `"ALL"` | | +| securityContext.runAsGroup | int | `1000` | | +| securityContext.runAsNonRoot | bool | `true` | | | securityContext.runAsUser | int | `1000` | | | service.port | int | `80` | Port details for sevice | | service.targetPort | int | `8080` | Container Port details for sevice | From df98fafd2fd3d270020cfd722fb2c001666b7e86 Mon Sep 17 00:00:00 2001 From: adkumar1 Date: Tue, 27 Feb 2024 15:54:24 +0530 Subject: [PATCH 7/7] relative link to charts --- INSTALL.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/INSTALL.md b/INSTALL.md index 33a0b444..16df571f 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,6 +1,6 @@ ## Installation Steps -A helm chart is provided inside the [charts](sd-factory/charts) directory +A helm chart is provided inside the [charts](charts/sdfactory) directory How to install application using helm: