Skip to content

Commit 3f215ac

Browse files
authoredJun 15, 2023
Update readme with charts deployment (#67)
1 parent 149cdfc commit 3f215ac

File tree

1 file changed

+27
-4
lines changed

1 file changed

+27
-4
lines changed
 

‎charts/README.md

+27-4
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ Helm chart for Cluster Registry Client.
55
## Prerequisites for installing the chart
66

77
**Notes**
8-
> Secret management must be handled by the user. Secrets must be created (either by kubectl or by a secret management tool) beforehand in order for the chart deployment to be successful.
8+
> Secret management must be handled by the user. Secrets must be created (either with kubectl or with a secret management tool) beforehand in order for the chart deployment to be successful.
99
> This step is mandatory for the application to run succesfully.
1010
1111
Required secret name is `cluster-registry-aws` and required keys are: `AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, SQS_AWS_REGION, SQS_ENDPOINT, SQS_QUEUE_NAME`
1212

13-
Example of a secret name and corresponding required keys (can also be found in [deployment.yaml](cluster-registry-client/templates/deployment.yaml) file):
13+
Example of a secret name and corresponding required keys (used in [deployment.yaml](cluster-registry-client/templates/deployment.yaml) file):
1414
```yaml
1515
apiVersion: v1
1616
data:
@@ -29,7 +29,30 @@ type: Opaque
2929
## Chart configuration
3030
To see a full list if configurable parameters, check the table generated in the [README.md](cluster-registry-client/README.md) file.
3131
32-
### Deploying the chart locally
32+
## Deploying the chart
33+
34+
### Adding the cluster-registry helm repository
35+
```bash
36+
helm repo add <release> https://opensource.adobe.com/cluster-registry
37+
helm repo update
38+
```
39+
40+
### Installing the chart
41+
```bash
42+
helm install <release> cluster-registry/cluster-registry-client --namespace <namespace>
43+
```
44+
45+
### Adding the cluster-registry-client chart as a dependency
46+
47+
```bash
48+
- name: cluster-registry-client
49+
version: <version>
50+
repository: "https://opensource.adobe.com/cluster-registry"
51+
52+
helm dependency update cluster-registry-client
53+
```
54+
55+
#### Checking the chart version
3356
```bash
34-
helm install cluster-registry-client . --values values.yaml --namespace <namespace>
57+
helm search repo cluster-registry-client
3558
```

0 commit comments

Comments
 (0)
Please sign in to comment.