diff --git a/docs/installation/install_oas.rst b/docs/installation/install_oas.rst index 4230d2701388a03bc0e096d82c1d6d8830ab0ec4..1559cfab0a471ddb9cd5a58876c639d497a93061 100644 --- a/docs/installation/install_oas.rst +++ b/docs/installation/install_oas.rst @@ -65,6 +65,9 @@ values. The rest are optional. - ``admin_email``: a valid email address for the system administrator of your cluster. +Make sure not to put any quotes around your values, because that can make the +resulting yaml files invalid. + Outgoing email -------------- diff --git a/docs/installation/overview.rst b/docs/installation/overview.rst index 55aab1fe85d43eb6919783a58a4cd6bfd0373480..25b93e3fb046af9e940803cb72d8eb67daceab4b 100644 --- a/docs/installation/overview.rst +++ b/docs/installation/overview.rst @@ -42,7 +42,7 @@ Clone the OpenAppStack git repository ------------------------------------- On your **provisioning machine**, clone the OpenAppStack git repository -and checkout the latest release branch (currently ``v0.6``): +and checkout the latest release branch (currently ``v0.7``): :: diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst index 94b3f47b2a156b4ce36cff650d34a0e03c7d848b..955404d1039a4f139ea1bbb389ce885ffde54dd2 100644 --- a/docs/troubleshooting.rst +++ b/docs/troubleshooting.rst @@ -138,10 +138,10 @@ You can also only run a Taiko test for a specific application, i.e.: python -m openappstack CLUSTERNAME test --taiko-tags nextcloud Advanced usage --------------- +~~~~~~~~~~~~~~ Testinfra tests -~~~~~~~~~~~~~~~ +''''''''''''''' Specify host manually: @@ -191,12 +191,10 @@ then: gitlab-runner exec docker --env CI_REGISTRY_IMAGE="$CI_REGISTRY_IMAGE" --env SSH_PRIVATE_KEY="$SSH_PRIVATE_KEY" --env COSMOS_API_TOKEN="$COSMOS_API_TOKEN" bootstrap Taiko tests -~~~~~~~~~~~ +''''''''''' -Using Taiko without the OpenAppStack CLI -'''''''''''''''''''''''''''''''''''''''' - -Go to the ``test/taiko`` directory and run: +If you want to use Taiko without invoking the openappstack CLI, go to the +``test/taiko`` directory and run: For nextcloud & onlyoffice tests: @@ -396,6 +394,34 @@ by telling Flux to *reconcile* them: Will make sure that the Nextcloud ``helmrelease`` gets brought into a state that our OpenAppStack wants it to be in. + +Common installation failures +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +var substitution failed +''''''''''''''''''''''' + +When you execute ``flux get kustomization`` and you see this error: + +.. code:: + + var substitution failed for 'kube-prometheus-stack': YAMLToJSON: yaml: line 32: found character that cannot start any token + +That can mean that one of your values contains a double quote (``"``) or that +you quoted a value in ``.flux.env`` during the :ref:`flux_config`. Make sure +that ``.flux.env`` does not contain any values that are quoted. + +If you need to change ``.flux.env``, run the following commands: + +.. code:: bash + + $ kubectl apply -k $CLUSTER_DIR + +Afterwards, you can speed up the process that fixes your ``kustomization``, by +running ``flux reconcile kustomization kube-prometheus-stack`` (replace +``kube-prometheus-stack`` with the kustomization is mentioned in the error +message). + Purge OAS and install from scratch ---------------------------------- diff --git a/install/.flux.env.example b/install/.flux.env.example index a52a4079a7155af41a5237ff374c69e6e70ae709..d67c951cc8acccdcd3b53e2656ada58f5916f780 100755 --- a/install/.flux.env.example +++ b/install/.flux.env.example @@ -1,3 +1,7 @@ +# This file contains variables that will be used in Kubernetes manifests. +# Replace the values to make sense for your setup. The values should not be +# quoted (correct: a=b, incorrect: a="b"). + # IP address of the cluster ip_address=1.2.3.4 # FQDN of the cluster