Skip to content
Snippets Groups Projects
Verified Commit 100540ac authored by Arie Peterson's avatar Arie Peterson
Browse files

Make the Velero setup docs a separate installation step

parent 16487d79
No related branches found
No related tags found
No related merge requests found
......@@ -20,7 +20,7 @@ backup:
# Disabled by default. To enable, change to `true` and configure the
# settings below. You'll also need to provide access credentials as
# secrets; see the documentation:
# http://docs.openappstack.net/en/latest/installation_instructions.html#backups
# https://docs.openappstack.net/en/latest/installation_instructions.html#step-2-optional-cluster-backups-using-velero
enabled: false
# URL of S3 service. Please use the principal domain name here, without the
# bucket name.
......
......@@ -117,19 +117,24 @@ directory of the git repository. In this tutorial, we're using
Install OpenAppStack
--------------------
Setting up OpenAppStack happens in three steps:
Setting up OpenAppStack happens in four steps:
1. **Set up cluster**
Create configuration files, and optionally create VPS
Create configuration files, and optionally create VPS.
2. **Install OpenAppStack**
2. **Optional: enable backups using Velero**
Optionally add settings and credentials to enable backups of your
cluster to external S3 storage.
3. **Install OpenAppStack**
Install Kubernetes and all the other software that comes with
OpenAppStack. See `Usage <#usage>`__ for more information on which
applications are installed.
3. **Validate setup**
4. **Validate setup**
This runs a test in the browser to validate that the installation was
successful.
......@@ -293,27 +298,28 @@ the limitations of this:
connecting to Nextcloud.
- You need to be able to resolve the domain names locally.
Step 2: Installation
~~~~~~~~~~~~~~~~~~~~
Step 2: Optional: cluster backups using Velero
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. Tip::
At this point you can enable `Velero <https://velero.io>`__, a program that
runs on your cluster and uploads backups of your cluster and user data to an
S3 storage service of your choice.
At this point you can enable `Velero <https://velero.io>`__, a program that
runs on your cluster and uploads backups of your cluster and user data to an
S3 storage service of your choice.
To do so:
- edit the file ``clusters/my-cluster/group_vars/all/settings.yml``,
reviewing all settings under the ``backup`` field and entering the data
specific to your backup storage location;
- create the directory ``clusters/my-cluster/secrets``;
- create the file ``clusters/my-cluster/secrets/s3_access_key``, with as
only contents your S3 access key;
- create the file ``clusters/my-cluster/secrets/s3_secret_key``, with as
only contents your S3 secret key.
Then continue with the installation procedure as described below.
To do so:
- edit the file ``clusters/my-cluster/group_vars/all/settings.yml``,
reviewing all settings under the ``backup`` field and entering the data
specific to your backup storage location;
- create the directory ``clusters/my-cluster/secrets``;
- create the file ``clusters/my-cluster/secrets/s3_access_key``, with as
only contents your S3 access key;
- create the file ``clusters/my-cluster/secrets/s3_secret_key``, with as
only contents your S3 secret key.
Then continue with the installation procedure as described below.
Step 3: Installation
~~~~~~~~~~~~~~~~~~~~
You're almost ready to start the OpenAppStack installation script.
First, make sure your DNS configuration is propagated. To do so, make
......@@ -355,7 +361,7 @@ to settle, and then continue to the Usage section.
have the ``clusters/my-cluster`` directory and it contains the same
``secrets`` directory before you run the installation command.
Step 3: Validate setup
Step 4: Validate setup
~~~~~~~~~~~~~~~~~~~~~~
Because OpenAppStack is still under development, we would like you to
......
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