Skip to content
Snippets Groups Projects
Unverified Commit d951d4b2 authored by Varac's avatar Varac
Browse files

Remove instructions from page titles

parent b42aa280
No related branches found
No related tags found
No related merge requests found
...@@ -26,9 +26,9 @@ For more information, go to `the OpenAppStack website`_. ...@@ -26,9 +26,9 @@ For more information, go to `the OpenAppStack website`_.
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Contents:
installation_instructions installation
advanced_installation advanced_installation
testing_instructions testing
usage usage
maintenance maintenance
troubleshooting troubleshooting
......
OpenAppStack installation instructions Installation
====================================== ============
This document describes how you can install OpenAppStack on a VPS. The This document describes how you can install OpenAppStack on a VPS. The
installation process will set up a "Kubernetes cluster" which runs installation process will set up a "Kubernetes cluster" which runs
...@@ -392,7 +392,7 @@ Step 6: Validate setup ...@@ -392,7 +392,7 @@ Step 6: Validate setup
~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~
Because OpenAppStack is still under development, we would like you to Because OpenAppStack is still under development, we would like you to
follow our `testing instructions <testing_instructions.html>`__ to make sure follow our `testing instructions <testing.html>`__ to make sure
that the setup process went well. that the setup process went well.
Step 7: Let us know! Step 7: Let us know!
......
...@@ -14,7 +14,7 @@ name. ...@@ -14,7 +14,7 @@ name.
## Installation ## Installation
First we'd like you to setup an OpenAppStack cluster by yourself, following the First we'd like you to setup an OpenAppStack cluster by yourself, following the
[installation tutorial](https://docs.openappstack.net/en/latest/installation_instructions.html). [installation instructions](https://docs.openappstack.net/en/latest/installation.html).
## Command line tests ## Command line tests
......
...@@ -24,7 +24,7 @@ The yq needed here can be installed by running ``sudo snap install yq``, ...@@ -24,7 +24,7 @@ The yq needed here can be installed by running ``sudo snap install yq``,
instructions](http://mikefarah.github.io/yq/#install). instructions](http://mikefarah.github.io/yq/#install).
To back-up your secrets, run the following script: To back-up your secrets, run the following script:
.. code:: bash .. code:: bash
...@@ -45,7 +45,7 @@ To back-up your secrets, run the following script: ...@@ -45,7 +45,7 @@ To back-up your secrets, run the following script:
kubectl get secret -o yaml -n flux-system oas-nextcloud-variables > secrets-backup/oas-nextcloud-variables.yaml kubectl get secret -o yaml -n flux-system oas-nextcloud-variables > secrets-backup/oas-nextcloud-variables.yaml
This script assumes you have all applications enabled. You might get an error This script assumes you have all applications enabled. You might get an error
like: like:
.. code:: bash .. code:: bash
...@@ -57,7 +57,7 @@ lines under "data:", rename the field to ``wekan_oauth_client_secret`` and enter ...@@ -57,7 +57,7 @@ lines under "data:", rename the field to ``wekan_oauth_client_secret`` and enter
a different random password. Make sure to base64 encode it (``echo "<your random a different random password. Make sure to base64 encode it (``echo "<your random
password>" | base64``). password>" | base64``).
If you get the error several times, that means ther If you get the error several times, that means ther
This script creates a directory called ``secrets-backup`` and places the secrets This script creates a directory called ``secrets-backup`` and places the secrets
that have been generated by Helm in it as ``yaml`` files. that have been generated by Helm in it as ``yaml`` files.
...@@ -69,7 +69,7 @@ Flux will now start updating your cluster to version 0.7. This process will fail ...@@ -69,7 +69,7 @@ Flux will now start updating your cluster to version 0.7. This process will fail
because it will remove the secrets that you just backed up. Make because it will remove the secrets that you just backed up. Make
sure that the ``oas-secrets`` helmrelease has been removed by running ``flux get sure that the ``oas-secrets`` helmrelease has been removed by running ``flux get
hr -A``. You might also see that some helmreleases start failing to be installed hr -A``. You might also see that some helmreleases start failing to be installed
because important secrets do not exist anymore. because important secrets do not exist anymore.
As soon as the ``oas-secrets`` helmrelease does not exist anymore, you can run As soon as the ``oas-secrets`` helmrelease does not exist anymore, you can run
the following code: the following code:
...@@ -119,7 +119,7 @@ secrets. The secrets will get a value once the ``core`` *kustomization* is ...@@ -119,7 +119,7 @@ secrets. The secrets will get a value once the ``core`` *kustomization* is
reconciled: ``flux reconcile ks core`` should solve the problem. reconciled: ``flux reconcile ks core`` should solve the problem.
If that does not solve the problem, you should check if the secret contains a If that does not solve the problem, you should check if the secret contains a
value for all the apps: value for all the apps:
.. code:: .. code::
...@@ -158,8 +158,8 @@ A few things are important when upgrading to 0.6.0: ...@@ -158,8 +158,8 @@ A few things are important when upgrading to 0.6.0:
- We now use Flux 2 and the installation procedure has been overhauled. For this - We now use Flux 2 and the installation procedure has been overhauled. For this
reason we advice you to set up a completely new cluster. reason we advice you to set up a completely new cluster.
- Copy your configuration details from ``settings.yaml`` to a new ``.flux.env``. - Copy your configuration details from ``settings.yaml`` to a new ``.flux.env``.
See ``install/.flux.env.example`` and the :ref:`OpenAppStack installation See ``install/.flux.env.example`` and the :ref:`Installation`
instructions` for more information. instructions for more information.
Please `reach out to us`_ if you are using, or plan to use OAS in Please `reach out to us`_ if you are using, or plan to use OAS in
production. production.
...@@ -271,4 +271,3 @@ intervention. ...@@ -271,4 +271,3 @@ intervention.
.. _reach out to us: https://openappstack.net/contact.html .. _reach out to us: https://openappstack.net/contact.html
.. _Flux: https://fluxcd.io .. _Flux: https://fluxcd.io
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment