diff --git a/.github/workflows/lint-and-test-helm-charts.yaml b/.github/workflows/lint-and-test-helm-charts.yaml new file mode 100644 index 00000000..981a9359 --- /dev/null +++ b/.github/workflows/lint-and-test-helm-charts.yaml @@ -0,0 +1,29 @@ +name: Lint and Test Charts + +on: pull_request + +jobs: + lint-test: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + + - name: Fetch history + run: git fetch --prune --unshallow + + - name: lint helm charts + id: lint_helm + uses: helm/chart-testing-action@v1.0.0 + with: + command: lint + + - name: Create kind cluster + uses: helm/kind-action@v1.0.0 + # Only build a kind cluster if there are chart changes to test. + if: steps.lint_helm.outputs.changed == 'true' + + - name: install and test helm charts + uses: helm/chart-testing-action@v1.0.0 + with: + command: install diff --git a/.github/workflows/release-helm-charts.yaml b/.github/workflows/release-helm-charts.yaml new file mode 100644 index 00000000..a0755bb7 --- /dev/null +++ b/.github/workflows/release-helm-charts.yaml @@ -0,0 +1,26 @@ +name: Release Helm Charts + +on: + push: + branches: + - master + +jobs: + release: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + with: + fetch-depth: 0 + + - name: Configure Git + run: | + git config user.name "$GITHUB_ACTOR" + git config user.email "$GITHUB_ACTOR@users.noreply.github.com" + - name: Run chart-releaser + uses: helm/chart-releaser-action@v1.0.0 + env: + CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}" + with: + charts_dir: deployment/helm \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 491210e6..9299b136 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,6 +23,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Change above affects also `"response_from": "kafka"` proxy functionality. RIG will forward to clients only Kafka body, no headers. This means, when using binary mode, clients receive only the data part, no CloudEvents context attributes. - Changed `response_from` handler to expect a message in binary format, **NOT** a cloud event (`kafka` and `http_async`). [#321](https://github.com/Accenture/reactive-interaction-gateway/pull/321) - Updated Helm v2 template, kubectl yaml file and instructions in the `deployment` folder [#288](https://github.com/Accenture/reactive-interaction-gateway/issues/288) +- Publish Helm Chart to Github pages. With this change, we can simply install the chart using + + ```shell + helm repo add accenture https://accenture.github.io/reactive-interaction-gateway + helm install rig accenture/reactive-interaction-gateway + ``` + + More information, follow the [deployment Readme](./deployment/README.md). [#319](https://github.com/Accenture/reactive-interaction-gateway/issues/319) ### Fixed diff --git a/ct.yaml b/ct.yaml new file mode 100644 index 00000000..0da21f83 --- /dev/null +++ b/ct.yaml @@ -0,0 +1,5 @@ +# See https://github.com/helm/chart-testing#configuration +remote: origin +chart-dirs: + - deployment/helm +debug: true \ No newline at end of file diff --git a/deployment/README.md b/deployment/README.md index d4484eac..711f1620 100644 --- a/deployment/README.md +++ b/deployment/README.md @@ -1,36 +1,28 @@ # Running RIG on Kubernetes -## Kubectl +The easiest way to deploy RIG is using Helm: -```bash -kubectl apply -f kubectl/rig.yaml +```shell +helm repo add accenture https://accenture.github.io/reactive-interaction-gateway +# Helm v3 +helm install rig accenture/reactive-interaction-gateway +# Helm v2 +helm install --name=rig accenture/reactive-interaction-gateway-helm-v2 ``` -## Helm +Check out the [Helm v2 README](helm/reactive-interaction-gateway-helm-v2/README.md) or [Helm v3 README](./helm/reactive-interaction-gateway/README.md) and [Operator's Guide](https://accenture.github.io/reactive-interaction-gateway/docs/rig-ops-guide.html) for more information on configuring RIG. -The Helm Charts are stored in [./helm2](./helm2) and [./helm3](./helm3) directory, which are essentially the same but only use a different `apiVersion` in the `Chart.yaml`. +## Deploy with kubectl -### Version 2 +> This deployment is not recommended as lots of configurations is hard coded ```bash -cd helm2 -# dry run to verify that everything is ok -helm install --name=rig reactive-interaction-gateway --dry-run -# install -helm install --name=rig reactive-interaction-gateway +kubectl apply -f kubectl/rig.yaml ``` -### Version 3 - -```bash -cd helm3 -# dry run to verify that everything is ok -helm install rig reactive-interaction-gateway --dry-run -# install -helm install rig reactive-interaction-gateway -``` +## Some Additional information -## Communication +### Communication Both `kubectl` and `helm` deploy bunch of Kubernetes resources: @@ -41,26 +33,25 @@ Both `kubectl` and `helm` deploy bunch of Kubernetes resources: To allow external communication (outside of your cluster) do: ```bash -# both helm versions -helm upgrade --set service.type=LoadBalancer rig reactive-interaction-gateway +helm upgrade --set service.type=LoadBalancer rig accenture/reactive-interaction-gateway # for kubectl update kubectl/rig.yaml to use a service of type LoadBalancer instead of ClusterIP ``` -## Scaling +### Scaling Scale the deployment and create multiple pods ```bash -helm upgrade --set service.type=LoadBalancer --set replicaCount= rig reactive-interaction-gateway +helm upgrade --set replicaCount= rig accenture/reactive-interaction-gateway # or kubectl scale deployment/ --replicas ``` You can also inspect the logs of the pods with `kubectl logs ` to see how they automatically re-balance Kafka consumers (if you are using Kafka) and adapt Proxy APIs from other nodes. -## Configuration +### Configuration -### Node host +#### Node host Every node in cluster needs to be discoverable by other nodes. For that Elixir/Erlang uses so called `long name` or `short name`. We are using `long name` which is formed in the following way `app_name@node_host`. `app_name` is in our case set to `rig` and `node_host` is taken from environment variable `NODE_HOST`. This can be either IP or container alias or whatever that is routable in network by other nodes. @@ -73,13 +64,13 @@ We are using the pod IP with: fieldPath: status.podIP ``` -### Node cookie +#### Node cookie Nodes in Erlang cluster use cookies as a form of authorization/authentication between them. Only nodes with the same cookie can communicate together. Ideally, it is some generated hash, that's why we recommend adapting `NODE_COOKIE` environment variable in the `values.yaml`. -### Additional configuration +#### Additional configuration -You can configure bunch of environment variables, please check the [Operator's Guide](https://accenture.github.io/reactive-interaction-gateway/docs/rig-ops-guide.html). +You can configure bunch of environment variables, please check the [Helm v2 README](helm/reactive-interaction-gateway-helm-v2/README.md) or [Helm v3 README](./helm/reactive-interaction-gateway/README.md) and [Operator's Guide](https://accenture.github.io/reactive-interaction-gateway/docs/rig-ops-guide.html). ## Cleanup diff --git a/deployment/helm2/reactive-interaction-gateway/.helmignore b/deployment/helm/reactive-interaction-gateway-helm-v2/.helmignore similarity index 100% rename from deployment/helm2/reactive-interaction-gateway/.helmignore rename to deployment/helm/reactive-interaction-gateway-helm-v2/.helmignore diff --git a/deployment/helm/reactive-interaction-gateway-helm-v2/Chart.yaml b/deployment/helm/reactive-interaction-gateway-helm-v2/Chart.yaml new file mode 100644 index 00000000..aca22255 --- /dev/null +++ b/deployment/helm/reactive-interaction-gateway-helm-v2/Chart.yaml @@ -0,0 +1,21 @@ +apiVersion: v1 +name: reactive-interaction-gateway-helm-v2 +description: A Helm v2 chart for Kubernetes +home: https://github.com/Accenture/reactive-interaction-gateway +icon: https://github.com/Accenture/reactive-interaction-gateway/blob/master/logo/Reactive-Interaction-Gateway-logo-cropped.png + +# This is the chart version. This version number should be incremented each time you make changes +# to the chart and its templates, including the app version. +version: 1.0.1 + +# This is the version number of the application being deployed. This version number should be +# incremented each time you make changes to the application. +appVersion: 3.0.0-alpha.1 + +maintainers: + - name: kevinbader + url: https://github.com/kevinbader + - name: mmacai + url: https://github.com/mmacai + - name: Knappek + url: https://github.com/Knappek diff --git a/deployment/helm/reactive-interaction-gateway-helm-v2/README.md b/deployment/helm/reactive-interaction-gateway-helm-v2/README.md new file mode 100644 index 00000000..31407218 --- /dev/null +++ b/deployment/helm/reactive-interaction-gateway-helm-v2/README.md @@ -0,0 +1,35 @@ +# reactive-interaction-gateway-helm-v2 + +![Version: 1.0.1](https://img.shields.io/badge/Version-1.0.1-informational?style=flat-square) ![AppVersion: 3.0.0-alpha.1](https://img.shields.io/badge/AppVersion-3.0.0-alpha.1-informational?style=flat-square) + +A Helm v2 chart for Kubernetes + +**Homepage:** + +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| kevinbader | | https://github.com/kevinbader | +| mmacai | | https://github.com/mmacai | +| Knappek | | https://github.com/Knappek | + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| deployment.env.API_HTTPS_PORT | int | `4011` | See docs/rig-ops-guide.md | +| deployment.env.API_HTTP_PORT | int | `4010` | See docs/rig-ops-guide.md | +| deployment.env.DISCOVERY_TYPE | string | `"dns"` | See docs/rig-ops-guide.md | +| deployment.env.INBOUND_HTTPS_PORT | int | `4001` | See docs/rig-ops-guide.md | +| deployment.env.INBOUND_PORT | int | `4000` | See docs/rig-ops-guide.md | +| deployment.env.LOG_LEVEL | string | `"warn"` | See docs/rig-ops-guide.md | +| deployment.env.NODE_COOKIE | string | `"magiccookie"` | See docs/rig-ops-guide.md | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"accenture/reactive-interaction-gateway"` | | +| nodeSelector | object | `{}` | | +| replicaCount | int | `1` | | +| resources | object | `{}` | | +| service.type | string | `"ClusterIP"` | | +| tolerations | list | `[]` | | diff --git a/deployment/helm2/reactive-interaction-gateway/templates/NOTES.txt b/deployment/helm/reactive-interaction-gateway-helm-v2/templates/NOTES.txt similarity index 100% rename from deployment/helm2/reactive-interaction-gateway/templates/NOTES.txt rename to deployment/helm/reactive-interaction-gateway-helm-v2/templates/NOTES.txt diff --git a/deployment/helm2/reactive-interaction-gateway/templates/_helpers.tpl b/deployment/helm/reactive-interaction-gateway-helm-v2/templates/_helpers.tpl similarity index 100% rename from deployment/helm2/reactive-interaction-gateway/templates/_helpers.tpl rename to deployment/helm/reactive-interaction-gateway-helm-v2/templates/_helpers.tpl diff --git a/deployment/helm3/reactive-interaction-gateway/templates/deployment.yaml b/deployment/helm/reactive-interaction-gateway-helm-v2/templates/deployment.yaml similarity index 95% rename from deployment/helm3/reactive-interaction-gateway/templates/deployment.yaml rename to deployment/helm/reactive-interaction-gateway-helm-v2/templates/deployment.yaml index c12aa24e..600b3b78 100644 --- a/deployment/helm3/reactive-interaction-gateway/templates/deployment.yaml +++ b/deployment/helm/reactive-interaction-gateway-helm-v2/templates/deployment.yaml @@ -14,6 +14,10 @@ spec: labels: {{- include "reactive-interaction-gateway.selectorLabels" . | nindent 8 }} spec: + securityContext: + runAsUser: 1000 + runAsGroup: 1000 + runAsNonRoot: true containers: - name: {{ .Chart.Name }} image: "{{ .Values.image.repository }}:{{ .Chart.AppVersion }}" diff --git a/deployment/helm2/reactive-interaction-gateway/templates/service-headless.yaml b/deployment/helm/reactive-interaction-gateway-helm-v2/templates/service-headless.yaml similarity index 100% rename from deployment/helm2/reactive-interaction-gateway/templates/service-headless.yaml rename to deployment/helm/reactive-interaction-gateway-helm-v2/templates/service-headless.yaml diff --git a/deployment/helm2/reactive-interaction-gateway/templates/service.yaml b/deployment/helm/reactive-interaction-gateway-helm-v2/templates/service.yaml similarity index 100% rename from deployment/helm2/reactive-interaction-gateway/templates/service.yaml rename to deployment/helm/reactive-interaction-gateway-helm-v2/templates/service.yaml diff --git a/deployment/helm2/reactive-interaction-gateway/values.yaml b/deployment/helm/reactive-interaction-gateway-helm-v2/values.yaml similarity index 88% rename from deployment/helm2/reactive-interaction-gateway/values.yaml rename to deployment/helm/reactive-interaction-gateway-helm-v2/values.yaml index ed4e97c5..a4fcacf7 100644 --- a/deployment/helm2/reactive-interaction-gateway/values.yaml +++ b/deployment/helm/reactive-interaction-gateway-helm-v2/values.yaml @@ -16,11 +16,14 @@ service: deployment: env: - ## Proxy ports + # Proxy ports + # deployment.env.INBOUND_PORT -- See docs/rig-ops-guide.md INBOUND_PORT: 4000 + # deployment.env.INBOUND_HTTPS_PORT -- See docs/rig-ops-guide.md INBOUND_HTTPS_PORT: 4001 - ## Internal HTTP API ports + # deployment.env.API_HTTP_PORT -- See docs/rig-ops-guide.md API_HTTP_PORT: 4010 + # deployment.env.API_HTTPS_PORT -- See docs/rig-ops-guide.md API_HTTPS_PORT: 4011 ## Hostname for HTTP endpoints @@ -35,10 +38,11 @@ deployment: # CORS: * ## Discovery + # deployment.env.DISCOVERY_TYPE -- See docs/rig-ops-guide.md DISCOVERY_TYPE: dns ## DNS_NAME is set dynamically ## NODE_HOST is set dynamically to PodIP in "templates/deployment.yaml" - ## Change magiccookie to some individual hash + # deployment.env.NODE_COOKIE -- See docs/rig-ops-guide.md NODE_COOKIE: magiccookie @@ -101,7 +105,8 @@ deployment: # JWT_SESSION_FIELD: /userId ## Logging - # REQUEST_LOG: console,kafka + ## REQUEST_LOG: console,kafka + # deployment.env.LOG_LEVEL -- See docs/rig-ops-guide.md LOG_LEVEL: warn ## SSE, WS diff --git a/deployment/helm3/reactive-interaction-gateway/.helmignore b/deployment/helm/reactive-interaction-gateway/.helmignore similarity index 100% rename from deployment/helm3/reactive-interaction-gateway/.helmignore rename to deployment/helm/reactive-interaction-gateway/.helmignore diff --git a/deployment/helm2/reactive-interaction-gateway/Chart.yaml b/deployment/helm/reactive-interaction-gateway/Chart.yaml similarity index 51% rename from deployment/helm2/reactive-interaction-gateway/Chart.yaml rename to deployment/helm/reactive-interaction-gateway/Chart.yaml index 891440c6..61f7f0df 100644 --- a/deployment/helm2/reactive-interaction-gateway/Chart.yaml +++ b/deployment/helm/reactive-interaction-gateway/Chart.yaml @@ -1,11 +1,21 @@ -apiVersion: v1 +apiVersion: v2 name: reactive-interaction-gateway description: A Helm chart for Kubernetes +home: https://github.com/Accenture/reactive-interaction-gateway +icon: https://github.com/Accenture/reactive-interaction-gateway/blob/master/logo/Reactive-Interaction-Gateway-logo-cropped.png # This is the chart version. This version number should be incremented each time you make changes # to the chart and its templates, including the app version. -version: 1.0.0 +version: 1.0.1 # This is the version number of the application being deployed. This version number should be # incremented each time you make changes to the application. appVersion: 3.0.0-alpha.1 + +maintainers: + - name: kevinbader + url: https://github.com/kevinbader + - name: mmacai + url: https://github.com/mmacai + - name: Knappek + url: https://github.com/Knappek diff --git a/deployment/helm/reactive-interaction-gateway/README.md b/deployment/helm/reactive-interaction-gateway/README.md new file mode 100644 index 00000000..794427ff --- /dev/null +++ b/deployment/helm/reactive-interaction-gateway/README.md @@ -0,0 +1,35 @@ +# reactive-interaction-gateway + +![Version: 1.0.1](https://img.shields.io/badge/Version-1.0.1-informational?style=flat-square) ![AppVersion: 2.4.0](https://img.shields.io/badge/AppVersion-2.4.0-informational?style=flat-square) + +A Helm chart for Kubernetes + +**Homepage:** + +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| kevinbader | | https://github.com/kevinbader | +| mmacai | | https://github.com/mmacai | +| Knappek | | https://github.com/Knappek | + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| deployment.env.API_HTTPS_PORT | int | `4011` | See docs/rig-ops-guide.md | +| deployment.env.API_HTTP_PORT | int | `4010` | See docs/rig-ops-guide.md | +| deployment.env.DISCOVERY_TYPE | string | `"dns"` | See docs/rig-ops-guide.md | +| deployment.env.INBOUND_HTTPS_PORT | int | `4001` | See docs/rig-ops-guide.md | +| deployment.env.INBOUND_PORT | int | `4000` | See docs/rig-ops-guide.md | +| deployment.env.LOG_LEVEL | string | `"warn"` | See docs/rig-ops-guide.md | +| deployment.env.NODE_COOKIE | string | `"magiccookie"` | See docs/rig-ops-guide.md | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"accenture/reactive-interaction-gateway"` | | +| nodeSelector | object | `{}` | | +| replicaCount | int | `1` | | +| resources | object | `{}` | | +| service.type | string | `"ClusterIP"` | | +| tolerations | list | `[]` | | diff --git a/deployment/helm3/reactive-interaction-gateway/templates/NOTES.txt b/deployment/helm/reactive-interaction-gateway/templates/NOTES.txt similarity index 100% rename from deployment/helm3/reactive-interaction-gateway/templates/NOTES.txt rename to deployment/helm/reactive-interaction-gateway/templates/NOTES.txt diff --git a/deployment/helm3/reactive-interaction-gateway/templates/_helpers.tpl b/deployment/helm/reactive-interaction-gateway/templates/_helpers.tpl similarity index 100% rename from deployment/helm3/reactive-interaction-gateway/templates/_helpers.tpl rename to deployment/helm/reactive-interaction-gateway/templates/_helpers.tpl diff --git a/deployment/helm2/reactive-interaction-gateway/templates/deployment.yaml b/deployment/helm/reactive-interaction-gateway/templates/deployment.yaml similarity index 95% rename from deployment/helm2/reactive-interaction-gateway/templates/deployment.yaml rename to deployment/helm/reactive-interaction-gateway/templates/deployment.yaml index c12aa24e..600b3b78 100644 --- a/deployment/helm2/reactive-interaction-gateway/templates/deployment.yaml +++ b/deployment/helm/reactive-interaction-gateway/templates/deployment.yaml @@ -14,6 +14,10 @@ spec: labels: {{- include "reactive-interaction-gateway.selectorLabels" . | nindent 8 }} spec: + securityContext: + runAsUser: 1000 + runAsGroup: 1000 + runAsNonRoot: true containers: - name: {{ .Chart.Name }} image: "{{ .Values.image.repository }}:{{ .Chart.AppVersion }}" diff --git a/deployment/helm3/reactive-interaction-gateway/templates/service-headless.yaml b/deployment/helm/reactive-interaction-gateway/templates/service-headless.yaml similarity index 100% rename from deployment/helm3/reactive-interaction-gateway/templates/service-headless.yaml rename to deployment/helm/reactive-interaction-gateway/templates/service-headless.yaml diff --git a/deployment/helm3/reactive-interaction-gateway/templates/service.yaml b/deployment/helm/reactive-interaction-gateway/templates/service.yaml similarity index 100% rename from deployment/helm3/reactive-interaction-gateway/templates/service.yaml rename to deployment/helm/reactive-interaction-gateway/templates/service.yaml diff --git a/deployment/helm3/reactive-interaction-gateway/values.yaml b/deployment/helm/reactive-interaction-gateway/values.yaml similarity index 88% rename from deployment/helm3/reactive-interaction-gateway/values.yaml rename to deployment/helm/reactive-interaction-gateway/values.yaml index ed4e97c5..a4fcacf7 100644 --- a/deployment/helm3/reactive-interaction-gateway/values.yaml +++ b/deployment/helm/reactive-interaction-gateway/values.yaml @@ -16,11 +16,14 @@ service: deployment: env: - ## Proxy ports + # Proxy ports + # deployment.env.INBOUND_PORT -- See docs/rig-ops-guide.md INBOUND_PORT: 4000 + # deployment.env.INBOUND_HTTPS_PORT -- See docs/rig-ops-guide.md INBOUND_HTTPS_PORT: 4001 - ## Internal HTTP API ports + # deployment.env.API_HTTP_PORT -- See docs/rig-ops-guide.md API_HTTP_PORT: 4010 + # deployment.env.API_HTTPS_PORT -- See docs/rig-ops-guide.md API_HTTPS_PORT: 4011 ## Hostname for HTTP endpoints @@ -35,10 +38,11 @@ deployment: # CORS: * ## Discovery + # deployment.env.DISCOVERY_TYPE -- See docs/rig-ops-guide.md DISCOVERY_TYPE: dns ## DNS_NAME is set dynamically ## NODE_HOST is set dynamically to PodIP in "templates/deployment.yaml" - ## Change magiccookie to some individual hash + # deployment.env.NODE_COOKIE -- See docs/rig-ops-guide.md NODE_COOKIE: magiccookie @@ -101,7 +105,8 @@ deployment: # JWT_SESSION_FIELD: /userId ## Logging - # REQUEST_LOG: console,kafka + ## REQUEST_LOG: console,kafka + # deployment.env.LOG_LEVEL -- See docs/rig-ops-guide.md LOG_LEVEL: warn ## SSE, WS diff --git a/deployment/helm3/reactive-interaction-gateway/Chart.yaml b/deployment/helm3/reactive-interaction-gateway/Chart.yaml deleted file mode 100644 index 4e4d5563..00000000 --- a/deployment/helm3/reactive-interaction-gateway/Chart.yaml +++ /dev/null @@ -1,21 +0,0 @@ -apiVersion: v2 -name: reactive-interaction-gateway -description: A Helm chart for Kubernetes - -# A chart can be either an 'application' or a 'library' chart. -# -# Application charts are a collection of templates that can be packaged into versioned archives -# to be deployed. -# -# Library charts provide useful utilities or functions for the chart developer. They're included as -# a dependency of application charts to inject those utilities and functions into the rendering -# pipeline. Library charts do not define any templates and therefore cannot be deployed. -type: application - -# This is the chart version. This version number should be incremented each time you make changes -# to the chart and its templates, including the app version. -version: 1.0.0 - -# This is the version number of the application being deployed. This version number should be -# incremented each time you make changes to the application. -appVersion: 3.0.0-alpha.1 diff --git a/deployment/kubectl/rig.yaml b/deployment/kubectl/rig.yaml index a33cc6a9..f4cb4e29 100644 --- a/deployment/kubectl/rig.yaml +++ b/deployment/kubectl/rig.yaml @@ -64,6 +64,10 @@ spec: labels: app: reactive-interaction-gateway spec: + securityContext: + runAsUser: 1000 + runAsGroup: 1000 + runAsNonRoot: true nodeSelector: {} affinity: {} tolerations: [] diff --git a/docs/rig-dev-guide.md b/docs/rig-dev-guide.md index 8b927e21..b9a190ce 100644 --- a/docs/rig-dev-guide.md +++ b/docs/rig-dev-guide.md @@ -43,7 +43,8 @@ To have the project use a newer Elixir version, make sure to change the followin ## Releasing a new version - Increment `rig` version in the [version](../version) file -- Increment `appVersion` in the [Helm 2 Chart.yaml](../deployment/helm2/reactive-interaction-gateway/Chart.yaml) and [Helm 3 Chart.yaml](../deployment/helm3/reactive-interaction-gateway/Chart.yaml) files +- Increment `appVersion` in the [Helm v2 Chart.yaml](../deployment/helm2/reactive-interaction-gateway/Chart.yaml) and [Helm v3 Chart.yaml](../deployment/helm3/reactive-interaction-gateway/Chart.yaml) files +- Update Helm chart README files: install [helm-docs](https://github.com/norwoodj/helm-docs) and run `helm-docs` in the root directory - Increment image tag in the [Kubernetes rig.yaml](../deployment/kubectl/rig.yaml) file - In [CHANGELOG.md](../CHANGELOG.md), rename `[Unreleased]` and add a corresponding link to the bottom of the file - Create a signed Git tag either using `git -s` or by creating a release using the Github UI diff --git a/docs/scaling.md b/docs/scaling.md index 2da707fc..328f4afa 100644 --- a/docs/scaling.md +++ b/docs/scaling.md @@ -20,8 +20,9 @@ Even though it's possible to run RIG anywhere, we recommend to use Kubernetes. kubectl scale deployment/reactive-interaction-gateway --replicas 3 # Start right away with 3 nodes using Helm template -- (assuming you are in the deployment directory) -# v2 -helm install --set replicaCount=3 --name=rig helm2/reactive-interaction-gateway -# v3 -helm install --set replicaCount=3 rig helm3/reactive-interaction-gateway +helm repo add accenture https://accenture.github.io/reactive-interaction-gateway +# Helm v3 +helm install --set replicaCount=3 rig accenture/reactive-interaction-gateway +# Helm v2 +helm install --set replicaCount=3 --name=rig accenture/reactive-interaction-gateway ```