diff --git a/helmfiles/README.md b/helmfiles/README.md index ae1dc67d0eab22fc65e51a6549780fcb11907518..4388b502753fe20bd9e6ce51a0a4fa84be6bfadb 100644 --- a/helmfiles/README.md +++ b/helmfiles/README.md @@ -1,8 +1,8 @@ ## Introduction -This repo describes the applications that are deployed to a new OpenAppStack -instance. The `helmfile.d` directory contains information about which helm -charts need to be deployed. The `values` directory contains values.yml overrides +This directory describes the applications that are deployed to a new OpenAppStack +instance. The `helmfile.d` subdirectory contains information about which helm +charts need to be deployed. The `values` subdirectory contains values.yml overrides for these charts. Use [helmfile](https://github.com/roboll/helmfile) to install these applications @@ -10,9 +10,9 @@ to a cluster. ## Usage -The data in this repo is typically used by the Ansible playbooks in the -[bootstrap](https://code.greenhost.net/openappstack/bootstrap) project. Check -the tasks tagged `helmfile` to get more information. +The data in this directory is typically used by the Ansible playbooks located +in the `ansible/` top level directory. Check the tasks tagged `helmfile` to +get more information. If you have a cluster already, and do not want to use our bootstrap script to install these applications, follow these steps: @@ -28,15 +28,14 @@ that helmfile requires `helm diff` to be installed. Install it by running Do these three steps to prepare the installation process: -1. This repo requires some repositories to be checked out in specific directories: +1. Get the local-storage chart locally ```bash - # Get the local-storage chart locally - $ git clone https://code.greenhost.net/openappstack/local-storage ../local-storage + $ git clone https://open.greenhost.net/openappstack/local-storage ../local-storage ``` -1. The repo assumes you have a configuration file called `local.yaml` in the - following directory relative to this repo: +1. You need to have a configuration file called `local.yaml` in the + following directory relative to this directory: `../../../config/values/local.yaml`. Use our template at https://code.greenhost.net/openappstack/bootstrap/blob/master/ansible/roles/configure_helmfile/templates/local.yaml.j2 and fill in the variables. @@ -48,10 +47,10 @@ Do these three steps to prepare the installation process: - `$GRAFANA_ADMIN_PASSWORD` for the admin password of grafana 1. OAS allows you to override the nginx configuration by setting variables in - a file at `/oas/config/values/apps/nginx.yaml`. You can leave this file - empty, but it *has* to exist. + a file at `/oas/config/values/apps/nginx.yaml` on the cluster. You can + leave this file empty, but it *has* to exist. -1. The repo installs certmanager, which uses some custom resource definitions. +1. Certmanager will get installed, which uses some custom resource definitions. You need to add these resource definitions like so: ``` @@ -74,8 +73,8 @@ Where: `helmfile.d` directory - `apply` syncs your kubernetes cluster state to the one desired by the files. -**NOTE:** If you have installed this repo before, check if you still have old -`pvc`'s for mariadb lying around. They can mess up the installation process, +**NOTE:** If you have applied these helmfiles before, check if you still have +old `pvc`'s for mariadb lying around. They can mess up the installation process, especially if you use different passwords than before. For example: