Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update installation steps #104

Merged
merged 9 commits into from
Feb 27, 2024
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
34 changes: 17 additions & 17 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,27 @@
## Installation Steps

Helm charts are provided inside https://github.com/eclipse-tractusx/sd-factory

1.) Using helm commands: <br />
Helm chart is provided inside https://github.com/eclipse-tractusx/sd-factory
adkumar1 marked this conversation as resolved.
Show resolved Hide resolved

How to install application using helm: <br />
helm install ReleaseName ChartName

helm install [ReleaseName] [ChartName]

1.) Installation from released chart: <br />

a.) Add helm repository in tractusx:
helm repo add sd-factory 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 sd-factory/sdfactory
c.) To install using helm command:
helm install sdf sd-factory/sdfactory
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]


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
adkumar1 marked this conversation as resolved.
Show resolved Hide resolved
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
adkumar1 marked this conversation as resolved.
Show resolved Hide resolved
secret:
jwkSetUri: -> JWK Set URL
clientId: -> Custodian wallet client id
Expand All @@ -34,7 +36,5 @@ How to install application using helm: <br />
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

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]
Loading