Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated Docs #216

Merged
merged 22 commits into from
May 24, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/concepts/databases/mongodb.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ spec:

### spec.storage

`spec.storage` is an optional field that specifies the StorageClass of PVCs dynamically allocated to store data for the database. This storage spec will be passed to the StatefulSet created by KubeDB operator to run database pods. You can specify any StorageClass available in your cluster with appropriate resource requests. If no storage spec is given, an `emptyDir` is used.
Since 0.8.0-beta.3, `spec.storage` is a required field that specifies the StorageClass of PVCs dynamically allocated to store data for the database. This storage spec will be passed to the StatefulSet created by KubeDB operator to run database pods. You can specify any StorageClass available in your cluster with appropriate resource requests.

- `spec.storage.storageClassName` is the name of the StorageClass used to provision PVCs. PVCs don’t necessarily have to request a class. A PVC with its storageClassName set equal to "" is always interpreted to be requesting a PV with no class, so it can only be bound to PVs with no class (no annotation or one set equal to ""). A PVC with no storageClassName is not quite the same and is treated differently by the cluster depending on whether the DefaultStorageClass admission plugin is turned on.
- `spec.storage.accessModes` uses the same conventions as Kubernetes PVCs when requesting storage with specific access modes.
Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/databases/mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ spec:

### spec.storage

`spec.storage` is an optional field that specifies the StorageClass of PVCs dynamically allocated to store data for the database. This storage spec will be passed to the StatefulSet created by KubeDB operator to run database pods. You can specify any StorageClass available in your cluster with appropriate resource requests. If no storage spec is given, an `emptyDir` is used.
Since 0.8.0-beta.3, `spec.storage` is a required field that specifies the StorageClass of PVCs dynamically allocated to store data for the database. This storage spec will be passed to the StatefulSet created by KubeDB operator to run database pods. You can specify any StorageClass available in your cluster with appropriate resource requests.

- `spec.storage.storageClassName` is the name of the StorageClass used to provision PVCs. PVCs don’t necessarily have to request a class. A PVC with its storageClassName set equal to "" is always interpreted to be requesting a PV with no class, so it can only be bound to PVs with no class (no annotation or one set equal to ""). A PVC with no storageClassName is not quite the same and is treated differently by the cluster depending on whether the DefaultStorageClass admission plugin is turned on.
- `spec.storage.accessModes` uses the same conventions as Kubernetes PVCs when requesting storage with specific access modes.
Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/databases/postgres.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ This Secret contains `postgres` superuser password as `POSTGRES_PASSWORD` key.

### spec.storage

`spec.storage` is an optional field that specifies the StorageClass of PVCs dynamically allocated to store data for the database. This storage spec will be passed to the StatefulSet created by KubeDB operator to run database pods. You can specify any StorageClass available in your cluster with appropriate resource requests. If no storage spec is given, an `emptyDir` is used.
Since 0.8.0-beta.3, `spec.storage` is a required field that specifies the StorageClass of PVCs dynamically allocated to store data for the database. This storage spec will be passed to the StatefulSet created by KubeDB operator to run database pods. You can specify any StorageClass available in your cluster with appropriate resource requests.

- `spec.storage.storageClassName` is the name of the StorageClass used to provision PVCs. PVCs don’t necessarily have to request a class. A PVC with its storageClassName set equal to "" is always interpreted to be requesting a PV with no class, so it can only be bound to PVs with no class (no annotation or one set equal to ""). A PVC with no storageClassName is not quite the same and is treated differently by the cluster depending on whether the DefaultStorageClass admission plugin is turned on.
- `spec.storage.accessModes` uses the same conventions as Kubernetes PVCs when requesting storage with specific access modes.
Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/databases/redis.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ spec:

### spec.storage

`spec.storage` is an optional field that specifies the StorageClass of PVCs dynamically allocated to store data for the database. This storage spec will be passed to the StatefulSet created by KubeDB operator to run database pods. You can specify any StorageClass available in your cluster with appropriate resource requests. If no storage spec is given, an `emptyDir` is used.
Since 0.8.0-beta.3, `spec.storage` is a required field that specifies the StorageClass of PVCs dynamically allocated to store data for the database. This storage spec will be passed to the StatefulSet created by KubeDB operator to run database pods. You can specify any StorageClass available in your cluster with appropriate resource requests.

- `spec.storage.storageClassName` is the name of the StorageClass used to provision PVCs. PVCs don’t necessarily have to request a class. A PVC with its storageClassName set equal to "" is always interpreted to be requesting a PV with no class, so it can only be bound to PVs with no class (no annotation or one set equal to ""). A PVC with no storageClassName is not quite the same and is treated differently by the cluster depending on whether the DefaultStorageClass admission plugin is turned on.
- `spec.storage.accessModes` uses the same conventions as Kubernetes PVCs when requesting storage with specific access modes.
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/elasticsearch/cli/elasticsearch-demo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ kind: Elasticsearch
metadata:
name: elasticsearch-demo
spec:
version: 5.6
version: "5.6"
storage:
storageClassName: "standard"
accessModes:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/elasticsearch/clustering/multi-node-es.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: multi-node-es
namespace: demo
spec:
version: 5.6
version: "5.6"
replicas: 3
storage:
storageClassName: "standard"
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/elasticsearch/clustering/topology-es.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: topology-es
namespace: demo
spec:
version: 5.6
version: "5.6"
topology:
master:
prefix: master
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: recovered-es
namespace: demo
spec:
version: 5.6
version: "5.6"
databaseSecret:
secretName: infant-elasticsearch-auth
storage:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: builtin-prom-es
namespace: demo
spec:
version: 5.6
version: "5.6"
storage:
storageClassName: "standard"
accessModes:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/elasticsearch/monitoring/coreos-prom-es.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: coreos-prom-es
namespace: demo
spec:
version: 5.6
version: "5.6"
storage:
storageClassName: "standard"
accessModes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: pvt-reg-elasticsearch
namespace: demo
spec:
version: 5.6
version: "5.6"
storage:
storageClassName: "standard"
accessModes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ metadata:
name: infant-elasticsearch
namespace: demo
spec:
version: 5.6
version: "5.6"
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: quick-elasticsearch
namespace: demo
spec:
version: 5.6
version: "5.6"
doNotPause: true
storage:
storageClassName: "standard"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: config-elasticsearch
namespace: demo
spec:
version: 5.6
version: "5.6"
databaseSecret:
secretName: config-elasticsearch-auth
storage:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: sg-elasticsearch
namespace: demo
spec:
version: 5.6
version: "5.6"
enableSSL: true
certificateSecret:
secretName: sg-elasticsearch-cert
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ metadata:
name: ssl-elasticsearch
namespace: demo
spec:
version: 5.6
version: "5.6"
replicas: 2
enableSSL: true
2 changes: 1 addition & 1 deletion docs/examples/elasticsearch/snapshot/scheduled-es.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: scheduled-es
namespace: demo
spec:
version: 5.6
version: "5.6"
storage:
storageClassName: "standard"
accessModes:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/memcached/cli/memcached-demo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ metadata:
kubedb: cli-demo
spec:
replicas: 3
version: 1.5.4
version: "1.5.4"
resources:
requests:
memory: 64Mi
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
namespace: demo
spec:
replicas: 3
version: 1.5.4
version: "1.5.4"
doNotPause: true
resources:
requests:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
namespace: demo
spec:
replicas: 3
version: 1.5.4
version: "1.5.4"
doNotPause: true
resources:
requests:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/memcached/private-registry/demo-2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
namespace: demo
spec:
replicas: 3
version: 1.5.4
version: "1.5.4"
doNotPause: true
resources:
requests:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/memcached/quickstart/demo-1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
namespace: demo
spec:
replicas: 3
version: 1.5.4
version: "1.5.4"
doNotPause: true
resources:
requests:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/mongodb/Initialization/demo-1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: mgo-init-script
namespace: demo
spec:
version: 3.4
version: "3.4"
doNotPause: true
storage:
storageClassName: "standard"
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/mongodb/Initialization/demo-2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: mgo-init-snapshot
namespace: demo
spec:
version: 3.4
version: "3.4"
storage:
storageClassName: "standard"
accessModes:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/mongodb/cli/mongodb-demo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ kind: MongoDB
metadata:
name: mongodb-demo
spec:
version: 3.4
version: "3.4"
storage:
storageClassName: "standard"
accessModes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: mgo-mon-prometheus
namespace: demo
spec:
version: 3.4
version: "3.4"
storage:
storageClassName: "standard"
accessModes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: mgo-mon-coreos
namespace: demo
spec:
version: 3.4
version: "3.4"
storage:
storageClassName: "standard"
accessModes:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/mongodb/private-registry/demo-2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: mgo-pvt-reg
namespace: demo
spec:
version: 3.4
version: "3.4"
doNotPause: true
storage:
storageClassName: "standard"
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/mongodb/quickstart/demo-1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: mgo-quickstart
namespace: demo
spec:
version: 3.4
version: "3.4"
doNotPause: true
storage:
storageClassName: "standard"
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/mongodb/snapshot/demo-1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: mgo-infant
namespace: demo
spec:
version: 3.4
version: "3.4"
doNotPause: true
storage:
storageClassName: "standard"
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/mongodb/snapshot/demo-3.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: mgo-recovered
namespace: demo
spec:
version: 3.4
version: "3.4"
storage:
storageClassName: "standard"
accessModes:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/mongodb/snapshot/demo-4.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: mgo-scheduled
namespace: demo
spec:
version: 3.4
version: "3.4"
storage:
storageClassName: "standard"
accessModes:
Expand Down
1 change: 0 additions & 1 deletion docs/examples/mysql/demo-0.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ metadata:
spec:
finalizers:
- kubernetes

2 changes: 1 addition & 1 deletion docs/examples/postgres/clustering/ha-postgres.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: ha-postgres
namespace: demo
spec:
version: 9.6
version: "9.6"
replicas: 3
storage:
storageClassName: "standard"
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/postgres/clustering/hot-postgres.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: hot-postgres
namespace: demo
spec:
version: 9.6
version: "9.6"
replicas: 3
standbyMode: hot
storage:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: recovered-postgres
namespace: demo
spec:
version: 9.6
version: "9.6"
databaseSecret:
secretName: script-postgres-auth
storage:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/postgres/initialization/replay-postgres.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: replay-postgres
namespace: demo
spec:
version: 9.6
version: "9.6"
replicas: 2
databaseSecret:
secretName: wal-postgres-auth
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/postgres/initialization/script-postgres.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: script-postgres
namespace: demo
spec:
version: 9.6
version: "9.6"
storage:
storageClassName: "standard"
accessModes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: builtin-prom-postgres
namespace: demo
spec:
version: 9.6
version: "9.6"
storage:
storageClassName: "standard"
accessModes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: coreos-prom-postgres
namespace: demo
spec:
version: 9.6
version: "9.6"
storage:
storageClassName: "standard"
accessModes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: pvt-reg-postgres
namespace: demo
spec:
version: 9.6
version: "9.6"
storage:
storageClassName: "standard"
accessModes:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/postgres/quickstart/infant-postgres.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ metadata:
name: infant-postgres
namespace: demo
spec:
version: 9.6
version: "9.6"
2 changes: 1 addition & 1 deletion docs/examples/postgres/quickstart/quick-postgres.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: quick-postgres
namespace: demo
spec:
version: 9.6
version: "9.6"
doNotPause: true
storage:
storageClassName: "standard"
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/postgres/snapshot/scheduled-pg.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: scheduled-pg
namespace: demo
spec:
version: 9.6
version: "9.6"
replicas: 3
storage:
storageClassName: "standard"
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/postgres/snapshot/wal-postgres.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: wal-postgres
namespace: demo
spec:
version: 9.6
version: "9.6"
replicas: 2
storage:
storageClassName: "standard"
Expand Down
Loading