Skip to content

Commit cc0f81a

Browse files
author
Pablo Panero
committed
deployment: improve explanations on helm usage
1 parent 1cb5bd5 commit cc0f81a

File tree

3 files changed

+20
-8
lines changed

3 files changed

+20
-8
lines changed

docs/deployment/configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Configuration
22

3-
This section explains the current configuration options that are available for the different components deployed by these Helm charts.
3+
This section explains the current configuration options that are available for the different components deployed by this Helm chart.
44

55
## Global
66

@@ -36,7 +36,7 @@ haproxy:
3636

3737
## Nginx
3838

39-
These charts allow you to configure the amount of connections per nginx node (replica) and the amount of nodes:
39+
This chart allows you to configure the amount of connections per nginx node (replica) and the amount of nodes:
4040

4141
```
4242
nginx:

docs/deployment/index.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ A Helm chart is a definition of the architecture of the system, meaning how all
1515

1616
In addition, Helm allows you to **install, version, upgrade and rollback** your InvenioRDM installation in an easy way. You can find more information about Helm [here](https://helm.sh/docs/intro/quickstart/).
1717

18-
### Charts description
18+
### Chart description
1919

20-
The current charts propose the following architecture:
20+
The current chart proposes the following architecture:
2121

2222
- HAProxy as entry point. It provides load balancing and queuing of requests.
2323
- Nginx as reverse proxy. It serves as reverse proxy, to help HAproxy and uWSGI "talk" the same language (protocol).
@@ -30,7 +30,16 @@ For more in-depth documentation see the [services description](services.md) and
3030
## Pre-Requirements
3131

3232
- [Helm](https://helm.sh/docs/intro/install/) version 3.x
33-
- Adding the [helm-invenio](https://github.com/inveniosoftware/helm-invenio) repository
33+
- Adding the [helm-invenio](https://github.com/inveniosoftware/helm-invenio) repository.
34+
35+
To install Helm, follow the official documentation linked above. Once you have it installed you can [add
36+
the repository](https://helm.sh/docs/helm/helm_repo_add/). The syntax is as follows:
37+
38+
``` console
39+
helm repo add [NAME] [URL] [flags]
40+
```
41+
42+
Let's add the `helm-invenio` (NAME) repository and check that it has been added correctly:
3443

3544
``` console
3645
$ helm repo add helm-invenio https://inveniosoftware.github.io/helm-invenio/
@@ -54,7 +63,7 @@ In this case, you will need to reference the `./invenio` folder rather than the
5463
## Supported Platforms
5564

5665
!!! warning "Only compatible with OpenShift"
57-
Please note that currently these Helm charts are only compatible with OpenShift.
66+
Please note that currently this Helm chart is only compatible with OpenShift.
5867

5968
- [OpenShift](openshift.md)
6069
- [Kubernetes](kubernetes.md)

docs/deployment/openshift.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -155,8 +155,11 @@ $ oc process -f cronjob.yml --param JOB_NAME=index-run \
155155

156156
### Upgrade your instance
157157

158-
If you have performed some changes to your instance (e.g. configuration) or you want to upgrade the version of the charts, you can do so with
159-
the `upgrade` command of `helm`. Note that you still need to disable the openapi validation which is yet not supported in version 3.1.2 (However, it is merged into the master branch and should come out soon):
158+
If you have performed some changes to your instance (e.g. configuration) or you want to upgrade the version of the chart, you can do so with
159+
the `upgrade` command of `helm`.
160+
161+
!!! warning "Not supported yet"
162+
Note that you still need to disable the openapi validation which is yet not supported in version 3.1.2 (However, it is merged into the master branch and should come out soon). For now we will have to `helm uninstall` and then install again.
160163

161164
``` console
162165
$ helm upgrade -f values.yaml --disable-openapi-validation

0 commit comments

Comments
 (0)