diff --git a/ee-installer/book.toml b/ee-installer/book.toml index bfea8b9..35a5f6d 100644 --- a/ee-installer/book.toml +++ b/ee-installer/book.toml @@ -1,5 +1,5 @@ [book] -title="Element Enterprise Installer Documentation - 0.6.0" +title="Element Enterprise Installer Documentation - 0.6.1" authors = ["Element"] language = "en" multilingual = false diff --git a/ee-installer/src/SUMMARY.md b/ee-installer/src/SUMMARY.md index 1970428..a7fdac1 100644 --- a/ee-installer/src/SUMMARY.md +++ b/ee-installer/src/SUMMARY.md @@ -10,4 +10,4 @@ - [Setting Up the Integration Manager](./dimension.md) - [Setting up GitLab, GitHub, and JIRA Integrations](./hookshot.md) -[Last Updated: March 30, 2022 at 8:30pm London Time](./SUMMARY.md) +[Last Updated: April 4, 2022 at 8:30pm London Time](./SUMMARY.md) diff --git a/ee-installer/src/install-prod.md b/ee-installer/src/install-prod.md index d6a1b9c..6f73f73 100644 --- a/ee-installer/src/install-prod.md +++ b/ee-installer/src/install-prod.md @@ -45,7 +45,9 @@ will be referenced in this document as the installer directory. ## k8s Environments -To configure your k8s environment, you need to : +Element Enterprise Installer allows you to either deploy directly into a kubernetes environment or to render a set of manifests for a future deployment in a kubernetes environment. + +To configure your kubernetes environment for a direct deployment, you need to : - Configure a kubectl context able to connect to your kubernetes instance - Copy `k8s.yml.sample` to `k8s.yml`. Edit `k8s.yml` with the following @@ -66,6 +68,14 @@ If you want to use [cert-manager](https://cert-manager.io/docs/configuration/acme/) for your tls certificates, it needs to be already installed in the targeted k8s cluster. +If you do not want to deploy directly to kubernetes, but wish to render manifests instead, set all of the above mentioned variables except for `k8s_auth_context` and define a value for the parameter `out_dir`, which specifies where to write the kubernetes manifests. Further, when you go to run the installer, you need to invoke it as such: + +```bash +sudo install.sh --target render +``` + +Using the above syntax, you will have a set of manifests written out to `out_dir` that you can then deploy into your kubernetes environment. + ## Postgresql Database The installation requires that you have a postgresql