Clean up and add a content warning

This commit is contained in:
Robert Schäfer 2019-05-15 16:14:48 +02:00
parent 1b3ee63565
commit 0ef2c26f03
9 changed files with 17 additions and 14 deletions

View File

@ -31,7 +31,6 @@
* [Volume Snapshots](deployment/volumes/volume-snapshots/README.md)
* [Reclaim Policy](deployment/volumes/reclaim-policy/README.md)
* [Velero](deployment/volumes/velero/README.md)
* [Neo4J DB Backup](deployment/backup.md)
* [Legacy Migration](deployment/legacy-migration/README.md)
* [Feature Specification](cypress/features.md)
* [Code of conduct](CODE_OF_CONDUCT.md)

View File

@ -4,8 +4,6 @@
metadata:
name: nitro-backend
namespace: human-connection
labels:
app: human-connection
spec:
replicas: 1
minReadySeconds: 15
@ -24,7 +22,6 @@
labels:
human-connection.org/commit: COMMIT
human-connection.org/selector: deployment-human-connection-backend
app: human-connection
name: "nitro-backend"
spec:
containers:

View File

@ -19,7 +19,6 @@
backup.velero.io/backup-volumes: neo4j-data
labels:
human-connection.org/selector: deployment-human-connection-neo4j
app: human-connection
name: nitro-neo4j
spec:
containers:

View File

@ -8,7 +8,6 @@
containers:
- name: nitro-maintenance-worker
image: humanconnection/maintenance-worker:latest
command: ["idle"]
envFrom:
- configMapRef:
name: maintenance-worker

View File

@ -4,8 +4,6 @@
metadata:
name: neo4j-data-claim
namespace: human-connection
labels:
app: human-connection
spec:
accessModes:
- ReadWriteOnce

View File

@ -23,7 +23,10 @@ So, all we have to do is edit the kubernetes deployment of our Neo4J database
and set a custom `command` every time we have to carry out tasks like backup,
restore, seed etc.
{% hint style="info" %} TODO: implement maintenance mode {% endhint %}
{% hint style="info" %}
TODO: implement maintenance mode
{% endhint %}
First bring the application into maintenance mode to ensure there are no
database connections left and nobody can access the application.

View File

@ -4,8 +4,6 @@
metadata:
name: uploads-claim
namespace: human-connection
labels:
app: human-connection
spec:
accessModes:
- ReadWriteOnce

View File

@ -1,5 +1,14 @@
# Velero
{% hint style="danger" %}
I tried Velero and it did not work reliably all the time. Sometimes the
kubernetes cluster crashes during recovery or data is not fully recovered.
Feel free to test it out and update this documentation once you feel that it's
working reliably. It is very likely that Digital Ocean had some bugs when I
tried out the steps below.
{% endhint %}
We use [velero](https://github.com/heptio/velero) for on premise backups, we
tested on version `v0.11.0`, you can find their
documentation [here](https://heptio.github.io/velero/v0.11.0/).
@ -39,7 +48,6 @@ When you create your deployments for Human Connection the required annotations
should already be in place. So when you create a backup of namespace
`human-connection`:
```sh
$ velero backup create hc-backup --include-namespaces=human-connection
```

View File

@ -4,6 +4,8 @@ It is possible to backup persistent volumes through volume snapshots. This is
especially handy if you don't want to stop the database to create an [offline
backup](../neo4j-offline-backup/README.md) thus having a downtime.
Kubernetes announced this feature in a [blog post](https://kubernetes.io/blog/2018/10/09/introducing-volume-snapshot-alpha-for-kubernetes/). Please make yourself familiar with it before you continue.
## Create a Volume Snapshot
There is an example in this folder how you can e.g. create a volume snapshot for
@ -21,7 +23,7 @@ If you are on Digital Ocean the volume snapshot should show up in the Web UI:
## Provision a Volume based on a Snapshot
Edit your persistent volume claim configuration and add a `dataSource` pointing
to your volume snapshot. [This blog post](https://kubernetes.io/blog/2018/10/09/introducing-volume-snapshot-alpha-for-kubernetes/) has an example in section "Provision a new volume from a snapshot with
to your volume snapshot. [The blog post](https://kubernetes.io/blog/2018/10/09/introducing-volume-snapshot-alpha-for-kubernetes/) has an example in section "Provision a new volume from a snapshot with
Kubernetes".
There is also an example in this folder how the configuration could look like.
@ -36,7 +38,7 @@ kubectl apply -f neo4j-data.yaml
## Data Consistency Warning
Note that volume snapshots do not guarantee data consistency. Quote from the
blog post above:
[blog post](https://kubernetes.io/blog/2018/10/09/introducing-volume-snapshot-alpha-for-kubernetes/):
> Please note that the alpha release of Kubernetes Snapshot does not provide
> any consistency guarantees. You have to prepare your application (pause