[CHORE] Update the helm readme.doc #1631
Conversation
helm-charts/README.md
Outdated
| @@ -2,54 +2,149 @@ | |||
|
|
|||
| The following instructions will guide you through the process of setting up the Anchor Platform on a local Kubernetes cluster using Minikube. | |||
|
|
|||
| ## Optionally clone the Anchor Platform repository | |||
There was a problem hiding this comment.
nit: This isn't optional if someone wants to install the charts. Do you think we should remove this? We don't need to provide instructions to check out a repo.
There was a problem hiding this comment.
The README assumes we are in the helm-chart folder. I added the git clone and cd.
Removed Optionally
|
|
||
| # Install postgres | ||
| ## Install postgres and postgres-ref |
There was a problem hiding this comment.
I should have specified that Kafka and Postgres will most likely only need to be installed once. We would usually make changes to the sep-service and reference-server charts and redeploy them.
There was a problem hiding this comment.
Added description.
helm-charts/README.md
Outdated
|
|
||
| # Install the secret store | ||
| ## Install and check the secret store `fake-secret-store` | ||
| To install the fake secret store, run the following command: |
There was a problem hiding this comment.
nit: I think we can remove this since its the same as the heading
helm-charts/README.md
Outdated
| postgresql-0 1/1 Running 0 77m | ||
| postgresql-ref-0 1/1 Running 0 77m | ||
| reference-server-svc-reference-server-775cfd7d49-wrg9s 1/1 Running 0 44m | ||
| sep24-reference-ui-svc-sep24-reference-ui-5dcc6b8f5b-cffzf 0/1 ContainerCreating 0 4s |
There was a problem hiding this comment.
nit: I know the UI chart is not working at the moment, but can we edit the status to say "Running"?
| ``` | ||
|
|
||
| ## Install the ingress controller | ||
| The following command installs nginx-ingress-controller in the `ingress-nginx` namespace. |
There was a problem hiding this comment.
This would be a one time step, like installing Kafka and Postgres
Description
Context
Testing
./gradlew testDocumentation
N/A
Known limitations
N/A