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

Prepare docs for 0.8.0 release #236

Merged
merged 1 commit into from
Jun 12, 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
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# Change Log

## [Unreleased](https://github.com/kubedb/cli/tree/HEAD)

[Full Changelog](https://github.com/kubedb/cli/compare/0.8.0-rc.0...HEAD)

**Merged pull requests:**

- Prepare release script for 0.8.0 release [\#235](https://github.com/kubedb/cli/pull/235) ([tamalsaha](https://github.com/tamalsaha))
- Add togglable tabs for Installation: Script & Helm [\#234](https://github.com/kubedb/cli/pull/234) ([sajibcse68](https://github.com/sajibcse68))
- Removed left over documents of deprecated flag '--force' [\#233](https://github.com/kubedb/cli/pull/233) ([the-redback](https://github.com/the-redback))
- Fix chart: Use resource 100m CPU to run operator pod [\#232](https://github.com/kubedb/cli/pull/232) ([the-redback](https://github.com/the-redback))
- Use resource 100m to run operator pod [\#231](https://github.com/kubedb/cli/pull/231) ([the-redback](https://github.com/the-redback))
- Improve installer [\#230](https://github.com/kubedb/cli/pull/230) ([tamalsaha](https://github.com/tamalsaha))
- Add changelog [\#229](https://github.com/kubedb/cli/pull/229) ([tamalsaha](https://github.com/tamalsaha))

## [0.8.0-rc.0](https://github.com/kubedb/cli/tree/0.8.0-rc.0) (2018-05-28)
[Full Changelog](https://github.com/kubedb/cli/compare/0.8.0-beta.2...0.8.0-rc.0)

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Please pick a version of KubeDB that matches your Kubernetes installation.

| KubeDB Version | Docs | Kubernetes Version |
|------------------------------------------------------------------------------------|-------------------------------------------------------------|--------------------|
| [0.8.0-rc.0](https://github.com/kubedb/cli/releases/tag/0.8.0-rc.0) (uses CRD) | [User Guide](https://kubedb.com/docs/0.8.0-rc.0/) | 1.9.x + |
| [0.8.0](https://github.com/kubedb/cli/releases/tag/0.8.0) (uses CRD) | [User Guide](https://kubedb.com/docs/0.8.0/) | 1.9.x + |
| [0.6.0](https://github.com/kubedb/cli/releases/tag/0.6.0) (uses TPR) | [User Guide](https://github.com/kubedb/cli/tree/0.6.0/docs) | 1.5.x - 1.7.x |

## Installation
Expand Down
4 changes: 2 additions & 2 deletions chart/kubedb/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
apiVersion: v1
description: 'KubeDB by AppsCode - Production ready databases on Kubernetes'
name: kubedb
version: 0.8.0-rc.0
appVersion: 0.8.0-rc.0
version: 0.8.0
appVersion: 0.8.0
home: https://github.com/kubedb/cli
icon: https://cdn.appscode.com/images/icon/kubedb.png
sources:
Expand Down
2 changes: 1 addition & 1 deletion chart/kubedb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The following table lists the configurable parameters of the KubeDB chart and th
| `replicaCount` | Number of kubedb operator replicas to create (only 1 is supported) | `1` |
| `kubedb.registry` | Docker registry used to pull Kubedb operator image | `kubedb` |
| `kubedb.repository` | Kubedb operator container image | `operator` |
| `kubedb.tag` | Kubedb operator container image tag | `0.8.0-rc.0` |
| `kubedb.tag` | Kubedb operator container image tag | `0.8.0` |
| `imagePullSecrets` | Specify image pull secrets | `nil` (does not add image pull secrets to deployed pods) |
| `imagePullPolicy` | Image pull policy | `IfNotPresent` |
| `criticalAddon` | If true, installs KubeDB operator as critical addon | `false` |
Expand Down
2 changes: 1 addition & 1 deletion chart/kubedb/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ replicaCount: 1
kubedb:
registry: kubedb
repository: operator
tag: 0.8.0-rc.0
tag: 0.8.0
## Optionally specify an array of imagePullSecrets.
## Secrets must be manually created in the namespace.
## ref: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod
Expand Down
8 changes: 4 additions & 4 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
title: Contributing | KubeDB
description: Contributing
menu:
docs_0.8.0-rc.0:
docs_0.8.0:
identifier: contributing-cli
name: Contributing
parent: welcome
weight: 10
menu_name: docs_0.8.0-rc.0
menu_name: docs_0.8.0
section_menu_id: welcome
url: /docs/0.8.0-rc.0/welcome/contributing/
url: /docs/0.8.0/welcome/contributing/
aliases:
- /docs/0.8.0-rc.0/CONTRIBUTING/
- /docs/0.8.0/CONTRIBUTING/
---

# Contribution Guidelines
Expand Down
10 changes: 5 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
title: Weclome | KubeDB
description: Welcome to KubeDB
menu:
docs_0.8.0-rc.0:
docs_0.8.0:
identifier: readme-cli
name: Readme
parent: welcome
weight: -1
menu_name: docs_0.8.0-rc.0
menu_name: docs_0.8.0
section_menu_id: welcome
url: /docs/0.8.0-rc.0/welcome/
url: /docs/0.8.0/welcome/
aliases:
- /docs/0.8.0-rc.0/
- /docs/0.8.0-rc.0/README/
- /docs/0.8.0/
- /docs/0.8.0/README/
---

# Welcome
Expand Down
4 changes: 2 additions & 2 deletions docs/_index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: KubeDB
menu:
docs_0.8.0-rc.0:
docs_0.8.0:
identifier: welcome
name: Welcome
weight: 10
menu_name: docs_0.8.0-rc.0
menu_name: docs_0.8.0
---
8 changes: 4 additions & 4 deletions docs/concepts/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
title: Concepts | KubeDB
menu:
docs_0.8.0-rc.0:
docs_0.8.0:
identifier: concepts-readme
name: Readme
parent: concepts
weight: -1
menu_name: docs_0.8.0-rc.0
menu_name: docs_0.8.0
section_menu_id: concepts
url: /docs/0.8.0-rc.0/concepts/
url: /docs/0.8.0/concepts/
aliases:
- /docs/0.8.0-rc.0/concepts/README/
- /docs/0.8.0/concepts/README/
---

# Concepts
Expand Down
4 changes: 2 additions & 2 deletions docs/concepts/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Concepts
description: Concepts
menu:
docs_0.8.0-rc.0:
docs_0.8.0:
identifier: concepts
name: Concepts
weight: 20
menu_name: docs_0.8.0-rc.0
menu_name: docs_0.8.0
---
4 changes: 2 additions & 2 deletions docs/concepts/databases/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: Supported Databases | KubeDB
description: Supported Databases
menu:
docs_0.8.0-rc.0:
docs_0.8.0:
identifier: databases
parent: concepts
name: Supported Databases
weight: 15
menu_name: docs_0.8.0-rc.0
menu_name: docs_0.8.0
---
4 changes: 2 additions & 2 deletions docs/concepts/databases/elasticsearch.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Elasticsearch
menu:
docs_0.8.0-rc.0:
docs_0.8.0:
identifier: elasticsearch-db
name: Elasticsearch
parent: databases
weight: 10
menu_name: docs_0.8.0-rc.0
menu_name: docs_0.8.0
section_menu_id: concepts
---

Expand Down
4 changes: 2 additions & 2 deletions docs/concepts/databases/memcached.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Memcached
menu:
docs_0.8.0-rc.0:
docs_0.8.0:
identifier: memcached-db
name: Memcached
parent: databases
weight: 15
menu_name: docs_0.8.0-rc.0
menu_name: docs_0.8.0
section_menu_id: concepts
---

Expand Down
6 changes: 3 additions & 3 deletions docs/concepts/databases/mongodb.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: MongoDB
menu:
docs_0.8.0-rc.0:
docs_0.8.0:
identifier: mongodb-db
name: MongoDB
parent: databases
weight: 20
menu_name: docs_0.8.0-rc.0
menu_name: docs_0.8.0
section_menu_id: concepts
---

Expand Down Expand Up @@ -82,7 +82,7 @@ spec:

### spec.storage

Since 0.8.0-rc.0, `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.
Since 0.8.0, `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
6 changes: 3 additions & 3 deletions docs/concepts/databases/mysql.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: MySQL
menu:
docs_0.8.0-rc.0:
docs_0.8.0:
identifier: mysql-db
name: MySQL
parent: databases
weight: 25
menu_name: docs_0.8.0-rc.0
menu_name: docs_0.8.0
section_menu_id: concepts
---

Expand Down Expand Up @@ -82,7 +82,7 @@ spec:

### spec.storage

Since 0.8.0-rc.0, `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.
Since 0.8.0, `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
6 changes: 3 additions & 3 deletions docs/concepts/databases/postgres.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Postgres
menu:
docs_0.8.0-rc.0:
docs_0.8.0:
identifier: postgres-db
name: Postgres
parent: databases
weight: 30
menu_name: docs_0.8.0-rc.0
menu_name: docs_0.8.0
section_menu_id: concepts
---

Expand Down Expand Up @@ -112,7 +112,7 @@ This Secret contains `postgres` superuser password as `POSTGRES_PASSWORD` key.

### spec.storage

Since 0.8.0-rc.0, `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.
Since 0.8.0, `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
6 changes: 3 additions & 3 deletions docs/concepts/databases/redis.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Redis
menu:
docs_0.8.0-rc.0:
docs_0.8.0:
identifier: redis-db
name: Redis
parent: databases
weight: 35
menu_name: docs_0.8.0-rc.0
menu_name: docs_0.8.0
section_menu_id: concepts
---

Expand Down Expand Up @@ -62,7 +62,7 @@ spec:

### spec.storage

Since 0.8.0-rc.0, `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.
Since 0.8.0, `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
4 changes: 2 additions & 2 deletions docs/concepts/snapshot.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Snapshot
menu:
docs_0.8.0-rc.0:
docs_0.8.0:
identifier: snapshot-concepts
name: Snapshot
parent: concepts
weight: 35
menu_name: docs_0.8.0-rc.0
menu_name: docs_0.8.0
section_menu_id: concepts
---

Expand Down
4 changes: 2 additions & 2 deletions docs/concepts/what-is-kubedb/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: What is KubeDB
description: What is KubeDB
menu:
docs_0.8.0-rc.0:
docs_0.8.0:
identifier: what-is-kubedb
parent: concepts
name: What is KubeDB
weight: 10
menu_name: docs_0.8.0-rc.0
menu_name: docs_0.8.0
---
4 changes: 2 additions & 2 deletions docs/concepts/what-is-kubedb/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
title: KubeDB Overview
description: KubeDB Overview
menu:
docs_0.8.0-rc.0:
docs_0.8.0:
identifier: overview-concepts
name: Overview
parent: what-is-kubedb
weight: 10
menu_name: docs_0.8.0-rc.0
menu_name: docs_0.8.0
section_menu_id: concepts
---

Expand Down
8 changes: 4 additions & 4 deletions docs/guides/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
title: Guides | KubeDB
menu:
docs_0.8.0-rc.0:
docs_0.8.0:
identifier: guides-readme
name: Readme
parent: guides
weight: -1
menu_name: docs_0.8.0-rc.0
menu_name: docs_0.8.0
section_menu_id: guides
url: /docs/0.8.0-rc.0/guides/
url: /docs/0.8.0/guides/
aliases:
- /docs/0.8.0-rc.0/guides/README/
- /docs/0.8.0/guides/README/
---

# Guides
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/_index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Guides | KubeDB
menu:
docs_0.8.0-rc.0:
docs_0.8.0:
identifier: guides
name: Guides
weight: 40
pre: dropdown
menu_name: docs_0.8.0-rc.0
menu_name: docs_0.8.0
---
10 changes: 5 additions & 5 deletions docs/guides/elasticsearch/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
title: Elasticsearch
menu:
docs_0.8.0-rc.0:
docs_0.8.0:
identifier: es-readme-elasticsearch
name: Elasticsearch
parent: es-elasticsearch-guides
weight: 10
menu_name: docs_0.8.0-rc.0
menu_name: docs_0.8.0
section_menu_id: guides
url: /docs/0.8.0-rc.0/guides/elasticsearch/
url: /docs/0.8.0/guides/elasticsearch/
aliases:
- /docs/0.8.0-rc.0/guides/elasticsearch/README/
- /docs/0.8.0/guides/elasticsearch/README/
---

> New to KubeDB? Please start [here](/docs/concepts/README.md).
Expand Down Expand Up @@ -47,7 +47,7 @@ aliases:
|----------------|:------------:|:------------:|
| 0.1.0 - 0.7.0 | ✓ | ✗ |
| 0.8.0-beta.2 | ✗ | ✓ |
| 0.8.0-rc.0 | ✗ | ✓ |
| 0.8.0 | ✗ | ✓ |

## External tools dependency

Expand Down
Loading