mirrors/kube-arangodb
1
0
Fork 0
mirror of https://github.com/arangodb/kube-arangodb.git synced 2024-12-14 11:57:37 +00:00
Code Activity

Various docs improvements & fixes

Browse source
This commit is contained in:
Ewout Prangsma 2018-04-06 12:26:14 +02:00
parent 882be827f4
commit 59068bf8b1
No known key found for this signature in database
GPG key ID: 4DBAD380D93D0698
3 changed files with 25 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/Manual/Deployment/Kubernetes/Storage.md
View file

@ -6,7 +6,7 @@ the storage to Pods that need them.
## Storage configuration
In the cluster resource, one can specify the type of storage
In the `ArangoDeployment` resource, one can specify the type of storage
used by groups of servers using the `spec.<group>.storageClassName`
setting.
@ -22,7 +22,11 @@ server.
For optimal performance, ArangoDB should be configured with locally attached
SSD storage.
To accomplish this, one must create `PersistentVolumes` for all servers that
The easiest way to accomplish this is to deploy an
[`ArangoLocalStorage` resource](./StorageResource.md).
The ArangoDB Storage Operator will use it to provide `PersistentVolumes` for you.
The alternative is to create `PersistentVolumes` manually, for all servers that
need persistent storage (single, agents & dbservers).
E.g. for a `Cluster` with 3 agents and 5 dbservers, you must create 8 volumes.

19
docs/Manual/Deployment/Kubernetes/Usage.md
View file

@ -3,25 +3,30 @@
## Installation
The ArangoDB Kubernetes Operator needs to be installed in your Kubernetes
cluster first. To do so, clone this repository and run:
cluster first.
To do so, run (replace `<version>` with the version of the operator that you want to install):
```bash
kubectl apply -f manifests/crd.yaml
kubectl apply -f manifests/arango-deployment.yaml
kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/<version>/manifests/crd.yaml
kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/<version>/manifests/arango-deployment.yaml
```
To use `ArangoLocalStorage`, also run:
```bash
kubectl apply -f manifests/arango-storage.yaml
kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/<version>/manifests/arango-storage.yaml
```
You can find the latest release of the ArangoDB Kubernetes Operator
[in the kube-arangodb repository](https://github.com/arangodb/kube-arangodb/releases/latest).
## Cluster creation
Once the operator is running, you can create your ArangoDB cluster
by creating a custom resource and deploying it.
For example:
For example (all examples can be found [in the kube-arangodb repository](https://github.com/arangodb/kube-arangodb/tree/master/examples)):
```bash
kubectl apply -f examples/simple-cluster.yaml
@ -44,7 +49,7 @@ To remove the entire ArangoDB Kubernetes Operator, remove all
clusters first and then remove the operator by running:
```bash
kubectl delete -f manifests/arango-deployment.yaml
kubectl delete deployment arango-deployment-operator
# If `ArangoLocalStorage` is installed
kubectl delete -f manifests/arango-storage.yaml
kubectl delete deployment -n kube-system arango-storage-operator
```

7
docs/Manual/Tutorials/Kubernetes/README.md
View file

@ -39,6 +39,8 @@ Then run (replace `<version>` with the version of the operator that you want to
```bash
kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/<version>/manifests/crd.yaml
kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/<version>/manifests/arango-deployment.yaml
# Optional
kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/<version>/manifests/arango-storage.yaml
```
The first command installs two `CustomResourceDefinitions` in your Kubernetes cluster:
@ -49,6 +51,11 @@ The first command installs two `CustomResourceDefinitions` in your Kubernetes cl
The second command installs a `Deployment` that runs the operator that controls
`ArangoDeployment` resources.
The optional third command installs a `Deployment` that runs the operator that
provides `PersistentVolumes` on local disks of the cluster nodes.
Use this when running on bare-metal or if there is no provisioner for fast
storage in your Kubernetes cluster.
## Deploying your first ArangoDB database
The first database we are going to deploy is a single server database.