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.

Sign up for GitHub

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

Jump to bottom

Update README.md gateway installation #1532

Merged
merged 2 commits into from
Aug 3, 2023
Merged

Update README.md gateway installation #1532

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
756c1ac
Update README.md gateway installation
smisidjan Aug 2, 2023
07f0810
change code review
Aug 2, 2023
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
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,21 +34,15 @@ $ docker compose up --build
If you are installing the Common Gateway on a Haven environment, you can just run the provided Helm installer. Before installing the Common Gateway, you need to add it to your Helm repositories.

````helm
$ helm repo add common-gateway https://raw.githubusercontent.com/ConductionNL/gateway-ui/refinement-demo-branch/helm/
````

Or if you want to install the Gateway as a headless application (without user interfaces)

````helm
$ helm repo add common-gateway https://raw.githubusercontent.com/ConductionNL/commonground-gateway/master/api/helm/
$ helm repo add common-gateway https://raw.githubusercontent.com/ConductionNL/commonground-gateway/main/api/helm/
````


After that, you can simply install the Gateway to your cluster using the Helm installer. If you are using a kubeconfig file to authenticate yourself, you need to add that as a --kubeconfig flag. However, if you are using another authentication method, you can omit the flag. When installing an application to Helm, always choose a name that helps you identify the application and put that in place of [my-installation].


````helm
$ helm install [my-gateway] common-gateway/gateway-ui --kubeconfig=[path-to-your-kubeconfig]
$ helm install [my-gateway] common-gateway/commonground-gateway --kubeconfig=[path-to-your-kubeconfig] --namespace [namespace]
````

This will install the Gateway in a bare-bones and production setup on the latest version (you can lock versions through the version flag e.g. `--version 2.2)`. To further configure the Gateway, we need to set some environmental values. A full option list can be found [here](). Let's for now assume that you want to switch your Gateway from prod to dev-mode, enable cron-runners for asynchronous resource handling, add a domain name to make the Gateway publicly accessible, and last but not least, use LetsEncrypt to provide an SSL/HTTPS connection. In Helm, we use the `--set` flag to set values. So the total upgrade command would look like:
Expand All @@ -60,7 +54,13 @@ $ helm upgrade [my-gateway] --kubeconfig=[path-to-your-kubeconfig] --set gatewa
Or for the headless version

````helm
$ helm upgrade [my-gateway] --kubeconfig=[path-to-your-kubeconfig] --set cronrunner.enabled=true,php.tag=dev,nginx.tag=dev,ingress.enabled=true,global.domain=[my-domain.com],tls.0.hosts.0=[my-domain.com],tls.0.secretName=[my-domain]-tls,ingress.annotations.cert-manager\.io/cluster-manager=letsencrypt-prod
$ helm upgrade [my-gateway] common-gateway/commonground-gateway --kubeconfig=[path-to-your-kubeconfig] --set cronrunner.enabled=true,php.tag=dev,nginx.tag=dev,ingress.enabled=true,global.domain=[my-domain.com]
````

The helm install and upgrade commandos can also be put together:

````helm
$ helm upgrade [my-gateway] common-gateway/commonground-gateway --kubeconfig=[path-to-your-kubeconfig] --set cronrunner.enabled=true,php.tag=dev,nginx.tag=dev,ingress.enabled=true,global.domain=[my-domain.com] --namespace [namespace] --install
````

Alternatively, you can use the Kubernetes dashboard to change the Helm values file.
Expand Down
Loading