diff --git a/CHANGELOG.md b/CHANGELOG.md index 517a56a5..67dc1bbf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) - Updated ARC42 document notice section - Updated security context - Header update in .tractusx file +- Updated installation steps in Install.md ## [2.1.9] - 2024-01-30 diff --git a/INSTALL.md b/INSTALL.md index 7c448abd..16df571f 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,25 +1,19 @@ ## Installation Steps -Helm charts are provided inside https://github.com/eclipse-tractusx/sd-factory - -1.) Using helm commands:
+A helm chart is provided inside the [charts](charts/sdfactory) directory 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 - b.) To search the specific repo in helm repositories - helm search repo sd-factory/sdfactory - c.) To install using helm command: - helm install sdf sd-factory/sdfactory + helm install [ReleaseName] [ChartName] -2.) Local installation: - - 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 +1.) Installation from released chart:
+ + 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 tractusx-dev/sdfactory + 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 @@ -34,7 +28,15 @@ 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 + 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] + + + + +2.) Installation from repository: + 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] 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 |