Skip to content

Commit bb2daf8

Browse files
committed
Doc file rename
1 parent 4c1e178 commit bb2daf8

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

docs/Manual/Programs/kube-arangodb/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# ArangoDB operator user manual
22

33
- [Using the operator](./usage.md)
4-
- [Custom resource](./custom_resource.md)
4+
- [Deployment Resource](./deployment_resource.md)
55
- [ArangoDB configuration & secrets](./config_and_secrets.md)
66
- [Metrics](./metrics.md)
77
- [Scaling](./scaling.md)

docs/Manual/Programs/kube-arangodb/custom_resource.md renamed to docs/Manual/Programs/kube-arangodb/deployment_resource.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# Custom Resource
1+
# ArangoLocalStorage Custom Resource
22

3-
The ArangoDB operator creates and maintains ArangoDB deployments
4-
in a Kubernetes cluster, given a cluster specification.
5-
This cluster specification is a CustomResource following
6-
a CustomResourceDefinition created by the operator.
3+
The ArangoDB Deployment operator creates and maintains ArangoDB deployments
4+
in a Kubernetes cluster, given a deployment specification.
5+
This deployment specification is a `CustomResource` following
6+
a `CustomResourceDefinition` created by the operator.
77

8-
Example minimal cluster definition:
8+
Example minimal deployment definition of an ArangoDB database cluster:
99

1010
```yaml
1111
apiVersion: "database.arangodb.com/v1alpha"
@@ -16,7 +16,7 @@ spec:
1616
mode: cluster
1717
```
1818
19-
Example more elaborate cluster definition:
19+
Example more elaborate deployment definition:
2020
2121
```yaml
2222
apiVersion: "database.arangodb.com/v1alpha"
@@ -41,7 +41,7 @@ spec:
4141
storageClassName: ssd
4242
coordinators:
4343
count: 3
44-
image: "arangodb/arangodb:3.3.3"
44+
image: "arangodb/arangodb:3.3.4"
4545
```
4646
4747
## Specification reference

docs/Manual/Programs/kube-arangodb/storage_resource.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
The ArangoDB Storage operator creates and maintains ArangoDB
44
storage resources in a Kubernetes cluster, given a storage specification.
5-
This storage specification is a CustomResource following
6-
a CustomResourceDefinition created by the operator.
5+
This storage specification is a `CustomResource` following
6+
a `CustomResourceDefinition` created by the operator.
77

88
Example minimal storage definition:
99

0 commit comments

Comments
 (0)