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

Follow file name conventions of main docs, move to Tutorials

This commit is contained in:
Simran Brucherseifer 2018-04-04 16:48:43 +02:00
parent 250ad2169d
commit 0b1d45f0bc
14 changed files with 27 additions and 25 deletions

View file

@ -4,9 +4,7 @@
State: In heavy development. DO NOT USE FOR ANY PRODUCTION LIKE PURPOSE! THINGS WILL CHANGE.
- [Getting Started](./docs/Manual/GettingStarted/Kubernetes/README.md)
- [User manual](./docs/Manual/Deployment/Kubernetes/README.md)
- [Design documents](./docs/design/README.md)
[Documentation](./docs/README.md)
## Installation of latest release

View file

@ -102,7 +102,7 @@ This setting specifies the type of storage engine used for all servers
in the cluster.
Possible values are:
- `MMFiles` To use the MMfiles storage engine.
- `MMFiles` To use the MMFiles storage engine.
- `RocksDB` (default) To use the RocksDB storage engine.
This setting cannot be changed after the cluster has been created.

View file

@ -1,12 +1,6 @@
# ArangoDB operator user manual
# ArangoDB Kubernetes Operator
- [Using the operator](./usage.md)
- [Deployment Resource](./deployment_resource.md)
- [ArangoDB configuration & secrets](./config_and_secrets.md)
- [Metrics](./metrics.md)
- [Scaling](./scaling.md)
- [Services & Load balancer](./services_and_loadbalancer.md)
- [Storage](./storage.md)
- [Storage Resource](./storage_resource.md)
- [TLS](./tls.md)
- [Upgrading](./upgrading.md)
The ArangoDB Kubernetes Operator (`kube-arangodb`) is a set of two operators
that you deploy in your Kubernetes cluster to manage deployments of the
ArangoDB database and provide `PersistenVolumes` on local storage of your
nodes for optimal storage performance.

View file

@ -1,4 +1,4 @@
# Start ArangoDB on Kubernetes in 5min
# Start ArangoDB on Kubernetes in 5 minutes
Starting an ArangoDB database (either single server or full blown cluster)
on Kubernetes involves a lot of resources.
@ -18,7 +18,7 @@ in a Kubernetes cluster.
`kube-arangodb` is a set of two operators that you deploy in your Kubernetes
cluster to (1) manage deployments of the ArangoDB database and (2)
provide `PersistenVolumes` on local storage of your nodes for optimal
storage performace.
storage performance.
Note that the operator that provides `PersistentVolumes` is not needed to
run ArangoDB deployments. You can also use `PersistentVolumes` provided
@ -29,7 +29,7 @@ In this guide we'll focus on the `ArangoDeployment` operator.
## Installing `kube-arangodb`
To install `kube-arangodb` in your Kubernetes cluster, make sure
you have acces to this cluster and the rights to deploy resources
you have access to this cluster and the rights to deploy resources
at cluster level.
For now, any recent Kubernetes cluster will do (e.g. `minikube`).
@ -73,7 +73,7 @@ kubectl apply -f single-server.yaml
The `ArangoDeployment` operator in `kube-arangodb` will now inspect the
resource you just deployed and start the process to run a single server database.
To inspect the currentl status of your deployment, run:
To inspect the current status of your deployment, run:
```bash
kubectl describe ArangoDeployment single-server
@ -102,7 +102,7 @@ your database s available.
The single server database you deployed in the previous chapter is now
available, but only from within the Kubernetes cluster.
To make the database available outside your Kubernetes cluster (e.g. for browser acces)
To make the database available outside your Kubernetes cluster (e.g. for browser access)
you must deploy an additional `Service`.
There are several possible types of `Service` to choose from.
@ -201,9 +201,9 @@ spec:
nodePort: 31529
```
Note that we've choosen a different node port (31529) for this `Service`
Note that we've chosen a different node port (31529) for this `Service`
to avoid conflicts with the port used in `single-server-service`.
## Where to go from here
- [Reference manual](../../Deployment/Kubernetes/README.md)
- [ArangoDB Kubernetes Operator](../../Deployment/Kubernetes/README.md)

View file

@ -1,5 +1,15 @@
# ArangoDB operator docs
# ArangoDB Kubernetes Operator
- [Getting Started](./Manual/GettingStarted/Kubernetes/README.md)
- [User manual](./Manual/Programs/Kubernetes/README.md)
- [Getting Started](./Manual/Tutorials/Kubernetes/README.md)
- [User manual](./Manual/Deployment/Kubernetes/README.md)
- [Using the Operator](./Manual/Deployment/Kubernetes/Usage.md)
- [Deployment Resource](./Manual/Deployment/Kubernetes/DeploymentResource.md)
- [ArangoDB configuration & secrets](./Manual/Deployment/Kubernetes/ConfigAndSecrets.md)
- [Metrics](./Manual/Deployment/Kubernetes/Metrics.md)
- [Scaling](./Manual/Deployment/Kubernetes/Scaling.md)
- [Services & Load balancer](./Manual/Deployment/Kubernetes/ServicesAndLoadBalancer.md)
- [Storage](./Manual/Deployment/Kubernetes/Storage.md)
- [Storage Resource](./Manual/Deployment/Kubernetes/StorageResource.md)
- [TLS](./Manual/Deployment/Kubernetes/Tls.md)
- [Upgrading](./Manual/Deployment/Kubernetes/Upgrading.md)
- [Design documents](./design/README.md)