Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Doc - Updates kube doc (#5051)

This commit is contained in:
sleto-it 2018-04-06 14:26:33 +02:00 committed by GitHub
parent a2f8077cd4
commit bdeb6175a9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 34 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Documentation/Books/Manual/Deployment/Kubernetes/DeploymentResource.md
View File

@ -1,5 +1,5 @@
<!-- don't edit here, its from https://@github.com/arangodb/kube-arangodb.git / docs/Manual/ --> <!-- don't edit here, its from https://@github.com/arangodb/kube-arangodb.git / docs/Manual/ -->
# ArangoLocalStorage Custom Resource # ArangoDeployment Custom Resource
The ArangoDB Deployment Operator creates and maintains ArangoDB deployments The ArangoDB Deployment Operator creates and maintains ArangoDB deployments
in a Kubernetes cluster, given a deployment specification. in a Kubernetes cluster, given a deployment specification.

9
Documentation/Books/Manual/Deployment/Kubernetes/Metrics.md
View File

@ -1,4 +1,11 @@
<!-- don't edit here, its from https://@github.com/arangodb/kube-arangodb.git / docs/Manual/ --> <!-- don't edit here, its from https://@github.com/arangodb/kube-arangodb.git / docs/Manual/ -->
# Metrics # Metrics
TBD The ArangoDB Kubernetes Operator (`kube-arangodb`) exposes metrics of
its operations in a format that is compatible with [Prometheus](https://prometheus.io).
The metrics are exposed through HTTPS on port `8528` under path `/metrics`.
Look at [examples/metrics](https://github.com/arangodb/kube-arangodb/tree/master/examples/metrics)
for examples of `Services` and `ServiceMonitors` you can use to integrate
with Prometheus through the [Prometheus-Operator by CoreOS](https://github.com/coreos/prometheus-operator).

8
Documentation/Books/Manual/Deployment/Kubernetes/Storage.md
View File

@ -7,7 +7,7 @@ the storage to Pods that need them.
## Storage configuration ## 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` used by groups of servers using the `spec.<group>.storageClassName`
setting. setting.
@ -23,7 +23,11 @@ server.
For optimal performance, ArangoDB should be configured with locally attached For optimal performance, ArangoDB should be configured with locally attached
SSD storage. 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). need persistent storage (single, agents & dbservers).
E.g. for a `Cluster` with 3 agents and 5 dbservers, you must create 8 volumes. E.g. for a `Cluster` with 3 agents and 5 dbservers, you must create 8 volumes.

19
Documentation/Books/Manual/Deployment/Kubernetes/Usage.md
View File

@ -4,25 +4,30 @@
## Installation ## Installation
The ArangoDB Kubernetes Operator needs to be installed in your Kubernetes 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 ```bash
kubectl apply -f manifests/crd.yaml kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/<version>/manifests/crd.yaml
kubectl apply -f manifests/arango-deployment.yaml kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/<version>/manifests/arango-deployment.yaml
``` ```
To use `ArangoLocalStorage`, also run: To use `ArangoLocalStorage`, also run:
```bash ```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 ## Cluster creation
Once the operator is running, you can create your ArangoDB cluster Once the operator is running, you can create your ArangoDB cluster
by creating a custom resource and deploying it. 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 ```bash
kubectl apply -f examples/simple-cluster.yaml kubectl apply -f examples/simple-cluster.yaml
@ -45,7 +50,7 @@ To remove the entire ArangoDB Kubernetes Operator, remove all
clusters first and then remove the operator by running: clusters first and then remove the operator by running:
```bash ```bash
kubectl delete -f manifests/arango-deployment.yaml kubectl delete deployment arango-deployment-operator
# If `ArangoLocalStorage` is installed # If `ArangoLocalStorage` is installed
kubectl delete -f manifests/arango-storage.yaml kubectl delete deployment -n kube-system arango-storage-operator
``` ```

7
Documentation/Books/Manual/Tutorials/Kubernetes/README.md
View File

@ -40,6 +40,8 @@ Then run (replace `<version>` with the version of the operator that you want to
```bash ```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/crd.yaml
kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/<version>/manifests/arango-deployment.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: The first command installs two `CustomResourceDefinitions` in your Kubernetes cluster:
@ -50,6 +52,11 @@ The first command installs two `CustomResourceDefinitions` in your Kubernetes cl
The second command installs a `Deployment` that runs the operator that controls The second command installs a `Deployment` that runs the operator that controls
`ArangoDeployment` resources. `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 ## Deploying your first ArangoDB database
The first database we are going to deploy is a single server database. The first database we are going to deploy is a single server database.