Skip to content

Commit

Permalink
Prepare docs for 0.6.0 release. (#107)
Browse files Browse the repository at this point in the history
  • Loading branch information
tamalsaha authored Jul 24, 2017
1 parent 490adc3 commit 0ba449c
Show file tree
Hide file tree
Showing 16 changed files with 34 additions and 34 deletions.
4 changes: 2 additions & 2 deletions docs/concepts/elasticsearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ spec:
version: 2.3.1
replicas: 1
storage:
class: "standard"
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
Expand Down Expand Up @@ -70,7 +70,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.

- `spec.storage.class` 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.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
4 changes: 2 additions & 2 deletions docs/concepts/postgres.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ metadata:
spec:
version: 9.5
storage:
class: "standard"
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
Expand Down Expand Up @@ -69,7 +69,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.

- `spec.storage.class` 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.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/demo-1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ spec:
replicas: 1
doNotPause: true
storage:
class: "standard"
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/elasticsearch/demo-3.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ spec:
replicas: 1
doNotPause: true
storage:
class: "standard"
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/elasticsearch/demo-4.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ metadata:
spec:
version: 2.3.1
storage:
class: "standard"
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/monitoring/demo-2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ metadata:
spec:
version: 9.5
storage:
class: "standard"
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/postgres/demo-1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ spec:
version: 9.5
doNotPause: true
storage:
class: "standard"
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/postgres/demo-3.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ spec:
version: 9.5
doNotPause: true
storage:
class: "standard"
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/postgres/demo-4.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ spec:
version: 9.5
doNotPause: true
storage:
class: "standard"
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/rbac/demo-1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ spec:
version: 9.5
doNotPause: true
storage:
class: "standard"
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
Expand Down
6 changes: 3 additions & 3 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ KubeDB provides a CLI to work with database objects. Download pre-built binaries

```console
# Linux amd 64-bit
wget -O kubedb https://github.com/k8sdb/cli/releases/download/0.5.0/kubedb-linux-amd64 \
wget -O kubedb https://github.com/k8sdb/cli/releases/download/0.6.0/kubedb-linux-amd64 \
&& chmod +x kubedb \
&& sudo mv kubedb /usr/local/bin/

# Mac 64-bit
wget -O kubedb https://github.com/k8sdb/cli/releases/download/0.5.0/kubedb-darwin-amd64 \
wget -O kubedb https://github.com/k8sdb/cli/releases/download/0.6.0/kubedb-darwin-amd64 \
&& chmod +x kubedb \
&& sudo mv kubedb /usr/local/bin/
```
Expand Down Expand Up @@ -68,7 +68,7 @@ To upgrade KubeDB cli, just replace the old cli with the new version.
`kubedb init` command can be used to upgrade operator. Re-run the `kubedb init` command with `--upgrade flag` to upgrade operator.

```console
$ kubedb init --version='0.5.0' --upgrade
$ kubedb init --version='0.6.0' --upgrade

Successfully upgraded operator deployment.
```
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/kubedb_init.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ kubedb init [flags]
kubedb init
# Upgrade operator to use another version.
kubedb init --version=0.5.0 --upgrade
kubedb init --version=0.6.0 --upgrade
```

### Options
Expand All @@ -28,7 +28,7 @@ kubedb init [flags]
--operator-namespace string Name of namespace where operator will be deployed. (default "kube-system")
--rbac If true, uses RBAC with operator and database objects
--upgrade If present, Upgrade operator to use provided version
--version string Operator version (default "0.5.0")
--version string Operator version (default "0.6.0")
```

### Options inherited from parent commands
Expand Down
14 changes: 7 additions & 7 deletions docs/tutorials/elasticsearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ spec:
replicas: 1
doNotPause: true
storage:
class: "standard"
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
Expand Down Expand Up @@ -125,7 +125,7 @@ spec:
storage:
accessModes:
- ReadWriteOnce
class: standard
storageClassName: standard
resources:
requests:
storage: 50Mi
Expand Down Expand Up @@ -320,7 +320,7 @@ spec:
replicas: 1
doNotPause: true
storage:
class: "standard"
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
Expand Down Expand Up @@ -356,7 +356,7 @@ spec:
version: 2.3.1
doNotPause: true
storage:
class: "standard"
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
Expand Down Expand Up @@ -468,7 +468,7 @@ spec:
storage:
accessModes:
- ReadWriteOnce
class: standard
storageClassName: standard
resources:
requests:
storage: 50Mi
Expand Down Expand Up @@ -523,7 +523,7 @@ spec:
storage:
accessModes:
- ReadWriteOnce
class: standard
storageClassName: standard
resources:
requests:
storage: 50Mi
Expand Down Expand Up @@ -574,7 +574,7 @@ spec:
storage:
accessModes:
- ReadWriteOnce
class: standard
storageClassName: standard
resources:
requests:
storage: 50Mi
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ metadata:
spec:
version: 9.5
storage:
class: "standard"
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
Expand Down
14 changes: 7 additions & 7 deletions docs/tutorials/postgres.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ spec:
version: 9.5
doNotPause: true
storage:
class: "standard"
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
Expand Down Expand Up @@ -153,7 +153,7 @@ spec:
storage:
accessModes:
- ReadWriteOnce
class: standard
storageClassName: standard
resources:
requests:
storage: 50Mi
Expand Down Expand Up @@ -334,7 +334,7 @@ spec:
version: 9.5
doNotPause: true
storage:
class: "standard"
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
Expand Down Expand Up @@ -375,7 +375,7 @@ spec:
version: 9.5
doNotPause: true
storage:
class: "standard"
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
Expand Down Expand Up @@ -497,7 +497,7 @@ spec:
storage:
accessModes:
- ReadWriteOnce
class: standard
storageClassName: standard
resources:
requests:
storage: 50Mi
Expand Down Expand Up @@ -558,7 +558,7 @@ spec:
storage:
accessModes:
- ReadWriteOnce
class: standard
storageClassName: standard
resources:
requests:
storage: 50Mi
Expand Down Expand Up @@ -615,7 +615,7 @@ spec:
storage:
accessModes:
- ReadWriteOnce
class: standard
storageClassName: standard
resources:
requests:
storage: 50Mi
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials/rbac.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ spec:
version: 9.5
doNotPause: true
storage:
class: "standard"
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
Expand Down Expand Up @@ -238,7 +238,7 @@ spec:
storage:
accessModes:
- ReadWriteOnce
class: standard
storageClassName: standard
resources:
requests:
storage: 50Mi
Expand Down

0 comments on commit 0ba449c

Please sign in to comment.