From a0e81650d78b4f09b9ad71cc874db1238eb80a41 Mon Sep 17 00:00:00 2001 From: Jens Langhammer Date: Wed, 9 Sep 2020 18:55:01 +0200 Subject: [PATCH] docs: update wording in upgrade guide --- docs/installation/kubernetes.md | 3 +++ docs/upgrading/to-0.10.md | 19 ++++++++++--------- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/docs/installation/kubernetes.md b/docs/installation/kubernetes.md index 26436f0a9..f8d38e872 100644 --- a/docs/installation/kubernetes.md +++ b/docs/installation/kubernetes.md @@ -15,6 +15,9 @@ image: nameOverride: "" +serverReplicas: 1 +workerReplicas: 1 + config: # Optionally specify fixed secret_key, otherwise generated automatically # secret_key: _k*@6h2u2@q-dku57hhgzb7tnx*ba9wodcb^s9g0j59@=y(@_o diff --git a/docs/upgrading/to-0.10.md b/docs/upgrading/to-0.10.md index fcd254498..dd848f488 100644 --- a/docs/upgrading/to-0.10.md +++ b/docs/upgrading/to-0.10.md @@ -1,6 +1,6 @@ # Upgrading to 0.10 -This upgrade brings a few database changes with it, some of which have to be done manually. The main changes are: +This update brings a lot of big features, such as: - New OAuth2/OpenID Provider @@ -24,7 +24,7 @@ This upgrade brings a few database changes with it, some of which have to be don - uwsgi has been replaced with Gunicorn and uvicorn. - Elastic APM has been replaced with Sentry Performance metrics - Flow title is now configurable separately from the name -- All logs are now json +- All logging output is now json ## Upgrading @@ -50,17 +50,18 @@ A few options have changed: - `error_reporting` was changed from a simple boolean to a dictionary: - ```yaml - error_reporting: - enabled: false - environment: customer - send_pii: false - ``` +```yaml + error_reporting: + enabled: false + environment: customer + send_pii: false +``` - The `apm` and `monitoring` blocks have been removed. - `serverReplicas` and `workerReplicas` have been added -During this update you must change `serverReplicas` to 0, and run a `helm upgrade`. Otherwise, an automatic upgrade process is attempted. +!!! error "Important" + During this update you must change `serverReplicas` to 0, and run a `helm upgrade`. Otherwise, an automatic upgrade process is attempted. To run the commands below, use the prefix `kubectl exec -it passbook-*-worker-* -- ./manage.py`.