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.9.0-rc.0 release #337

Merged
merged 3 commits into from
Oct 15, 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
30 changes: 30 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,35 @@
# Change Log

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

[Full Changelog](https://github.com/kubedb/cli/compare/0.9.0-beta.1...HEAD)

**Merged pull requests:**

- Cleanup postgres and elasticsearch docs [\#336](https://github.com/kubedb/cli/pull/336) ([tamalsaha](https://github.com/tamalsaha))
- Update chart and installer for webhook xray [\#335](https://github.com/kubedb/cli/pull/335) ([tamalsaha](https://github.com/tamalsaha))
- Update kubernetes client libraries to 1.12.0 [\#334](https://github.com/kubedb/cli/pull/334) ([tamalsaha](https://github.com/tamalsaha))
- Update dependencies to kubernetes 1.12.0 [\#333](https://github.com/kubedb/cli/pull/333) ([tamalsaha](https://github.com/tamalsaha))
- Fix addition expression on installer script [\#332](https://github.com/kubedb/cli/pull/332) ([the-redback](https://github.com/the-redback))
- Updated Snapshot concept for 0.9.0 [\#331](https://github.com/kubedb/cli/pull/331) ([the-redback](https://github.com/the-redback))
- Updated Memcached docs for 0.9.0 [\#330](https://github.com/kubedb/cli/pull/330) ([the-redback](https://github.com/the-redback))
- Add appdatalog to forced dep list [\#329](https://github.com/kubedb/cli/pull/329) ([tamalsaha](https://github.com/tamalsaha))
- Add Support for Elasticsearch 6.4 [\#328](https://github.com/kubedb/cli/pull/328) ([hossainemruz](https://github.com/hossainemruz))
- Add RBAC permission for appcatalog [\#327](https://github.com/kubedb/cli/pull/327) ([tamalsaha](https://github.com/tamalsaha))
- Add validation webhook for Namespace deletion [\#326](https://github.com/kubedb/cli/pull/326) ([tamalsaha](https://github.com/tamalsaha))
- Support LogLevel in chart [\#325](https://github.com/kubedb/cli/pull/325) ([tamalsaha](https://github.com/tamalsaha))
- Added missing chart of mysql:8-v1 catalog [\#324](https://github.com/kubedb/cli/pull/324) ([the-redback](https://github.com/the-redback))
- Update dep list [\#323](https://github.com/kubedb/cli/pull/323) ([tamalsaha](https://github.com/tamalsaha))
- Fix small typo in docs/README.md [\#322](https://github.com/kubedb/cli/pull/322) ([CemalUnal](https://github.com/CemalUnal))
- Updated Redis doc for 0.9.0 [\#321](https://github.com/kubedb/cli/pull/321) ([the-redback](https://github.com/the-redback))
- Format user roles [\#320](https://github.com/kubedb/cli/pull/320) ([tamalsaha](https://github.com/tamalsaha))
- Always use json syntax for verbs in installers [\#319](https://github.com/kubedb/cli/pull/319) ([tamalsaha](https://github.com/tamalsaha))
- Start next dev cycle [\#317](https://github.com/kubedb/cli/pull/317) ([tamalsaha](https://github.com/tamalsaha))
- Updated MySQL doc for 0.9.0 [\#310](https://github.com/kubedb/cli/pull/310) ([the-redback](https://github.com/the-redback))
- MongoDB docs updated for 0.9.0 [\#304](https://github.com/kubedb/cli/pull/304) ([the-redback](https://github.com/the-redback))
- Update docs for release 0.9.0 \(Elasticsearch\) [\#303](https://github.com/kubedb/cli/pull/303) ([hossainemruz](https://github.com/hossainemruz))
- Update docs for release 0.9.0 \(Postgres\) [\#280](https://github.com/kubedb/cli/pull/280) ([hossainemruz](https://github.com/hossainemruz))

## [0.9.0-beta.1](https://github.com/kubedb/cli/tree/0.9.0-beta.1) (2018-09-30)
[Full Changelog](https://github.com/kubedb/cli/compare/0.9.0-beta.0...0.9.0-beta.1)

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

| KubeDB Version | Docs | Kubernetes Version |
|------------------------------------------------------------------------------------|---------------------------------------------------------------------|--------------------|
| [0.9.0-beta.1](https://github.com/kubedb/cli/releases/tag/0.9.0-beta.1) (uses CRD) | [User Guide](https://github.com/kubedb/cli/tree/0.9.0-beta.1/docs) | 1.9.x + (for qa) |
| [0.9.0-rc.0](https://github.com/kubedb/cli/releases/tag/0.9.0-rc.0) (uses CRD) | [User Guide](https://github.com/kubedb/cli/tree/0.9.0-rc.0/docs) | 1.9.x + (for qa) |
| [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 |

Expand Down
4 changes: 2 additions & 2 deletions chart/kubedb-catalog/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
apiVersion: v1
description: 'KubeDB Catalog by AppsCode - Catalog for database versions'
name: kubedb-catalog
version: 0.9.0-beta.1
appVersion: 0.9.0-beta.1
version: 0.9.0-rc.0
appVersion: 0.9.0-rc.0
home: https://github.com/kubedb/cli
icon: https://cdn.appscode.com/images/icon/kubedb.png
sources:
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.9.0-beta.1
appVersion: 0.9.0-beta.1
version: 0.9.0-rc.0
appVersion: 0.9.0-rc.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.9.0-beta.1` |
| `kubedb.tag` | Kubedb operator container image tag | `0.9.0-rc.0` |
| `cleaner.registry` | Docker registry used to pull Webhook cleaner image | `appscode` |
| `cleaner.repository` | Webhook cleaner container image | `kubectl` |
| `cleaner.tag` | Webhook cleaner container image tag | `v1.11` |
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.9.0-beta.1
tag: 0.9.0-rc.0
cleaner:
registry: appscode
repository: kubectl
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.9.0-beta.0:
docs_0.9.0-rc.0:
identifier: contributing-cli
name: Contributing
parent: welcome
weight: 10
menu_name: docs_0.9.0-beta.0
menu_name: docs_0.9.0-rc.0
section_menu_id: welcome
url: /docs/0.8.0/welcome/contributing/
url: /docs/0.9.0-rc.0/welcome/contributing/
aliases:
- /docs/0.8.0/CONTRIBUTING/
- /docs/0.9.0-rc.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: Welcome | KubeDB
description: Welcome to KubeDB
menu:
docs_0.9.0-beta.0:
docs_0.9.0-rc.0:
identifier: readme-cli
name: Readme
parent: welcome
weight: -1
menu_name: docs_0.9.0-beta.0
menu_name: docs_0.9.0-rc.0
section_menu_id: welcome
url: /docs/0.8.0/welcome/
url: /docs/0.9.0-rc.0/welcome/
aliases:
- /docs/0.8.0/
- /docs/0.8.0/README/
- /docs/0.9.0-rc.0/
- /docs/0.9.0-rc.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.9.0-beta.0:
docs_0.9.0-rc.0:
identifier: welcome
name: Welcome
weight: 10
menu_name: docs_0.9.0-beta.0
menu_name: docs_0.9.0-rc.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.9.0-beta.0:
docs_0.9.0-rc.0:
identifier: concepts-readme
name: Readme
parent: concepts
weight: -1
menu_name: docs_0.9.0-beta.0
menu_name: docs_0.9.0-rc.0
section_menu_id: concepts
url: /docs/0.8.0/concepts/
url: /docs/0.9.0-rc.0/concepts/
aliases:
- /docs/0.8.0/concepts/README/
- /docs/0.9.0-rc.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.9.0-beta.0:
docs_0.9.0-rc.0:
identifier: concepts
name: Concepts
weight: 20
menu_name: docs_0.9.0-beta.0
menu_name: docs_0.9.0-rc.0
---
4 changes: 2 additions & 2 deletions docs/concepts/catalog/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: KubeDB Catalog | KubeDB
description: Database Version CRD
menu:
docs_0.9.0-beta.0:
docs_0.9.0-rc.0:
identifier: catalog
parent: concepts
name: Catalog
weight: 20
menu_name: docs_0.9.0-beta.0
menu_name: docs_0.9.0-rc.0
---
6 changes: 3 additions & 3 deletions docs/concepts/catalog/elasticsearch.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: ElasticsearchVersion
menu:
docs_0.9.0-beta.0:
docs_0.9.0-rc.0:
identifier: elasticsearh-version
name: ElasticsearchVersion
parent: catalog
weight: 10
menu_name: docs_0.9.0-beta.0
menu_name: docs_0.9.0-rc.0
section_menu_id: concepts
---

Expand Down Expand Up @@ -57,7 +57,7 @@ We modify original Elasticsearch docker image to support additional features lik

### spec.deprecated

`spec.deprecated` is an optional field that specifies whether the docker images specified here is supported by the current KubeDB operator. For example, we have modified `kubedb/elasticsearch:6.2.4` docker image to support custom configuration and re-tagged as `kubedb/elasticsearch:6.2.4-v1`. Now, KubeDB `0.9.0` supports providing custom configuration which required `kubedb/elasticsearch:6.2.4-v1` docker image. So, we have marked `kubedb/elasticsearch:6.2.4` as deprecated in KubeDB `0.9.0`.
`spec.deprecated` is an optional field that specifies whether the docker images specified here is supported by the current KubeDB operator. For example, we have modified `kubedb/elasticsearch:6.2.4` docker image to support custom configuration and re-tagged as `kubedb/elasticsearch:6.2.4-v1`. Now, KubeDB `0.9.0-rc.0` supports providing custom configuration which required `kubedb/elasticsearch:6.2.4-v1` docker image. So, we have marked `kubedb/elasticsearch:6.2.4` as deprecated in KubeDB `0.9.0-rc.0`.

The default value of this field is `false`. If `spec.depcrecated` is set `true`, KubeDB operator will not create the database and other respective resources for this version.

Expand Down
8 changes: 4 additions & 4 deletions docs/concepts/catalog/memcached.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: MemcachedVersion
menu:
docs_0.9.0-beta.1:
docs_0.9.0-rc.0:
identifier: memcached-version
name: MemcachedVersion
parent: catalog
weight: 30
menu_name: docs_0.9.0-beta.1
menu_name: docs_0.9.0-rc.0
section_menu_id: concepts
---

Expand Down Expand Up @@ -47,15 +47,15 @@ We follow this convention for naming MemcachedVersion crd:

- Name format: `{Original Memcached image version}-{modification tag}`

We modify original Memcached docker image to support additional features. An image with higher modification tag will have more feature than the images with lower modification tag. Hence, it is recommended to use MemcachedVersion crd with highest modification tag to enjoy latest features.
We modify original Memcached docker image to support additional features. An image with higher modification tag will have more feature than the images with lower modification tag. Hence, it is recommended to use MemcachedVersion crd with highest modification tag to take advantage of the latest features.

### spec.version

`spec.version` is a required field that specifies the original version of Memcached database that has been used to build the docker image specified in `spec.db.image` field.

### spec.deprecated

`spec.deprecated` is an optional field that specifies whether the docker images specified here is supported by the current KubeDB operator. For example, we have modified `kubedb/memcached:1.5.4` docker image to support custom configuration and re-tagged as `kubedb/memcached:1.5.4-v1`. Now, KubeDB `0.9.0` supports providing custom configuration which required `kubedb/memcached:1.5.4-v1` docker image. So, we have marked `kubedb/memcached:1.5.4` as deprecated for KubeDB `0.9.0`.
`spec.deprecated` is an optional field that specifies whether the docker images specified here is supported by the current KubeDB operator. For example, we have modified `kubedb/memcached:1.5.4` docker image to support custom configuration and re-tagged as `kubedb/memcached:1.5.4-v1`. Now, KubeDB `0.9.0-rc.0` supports providing custom configuration which required `kubedb/memcached:1.5.4-v1` docker image. So, we have marked `kubedb/memcached:1.5.4` as deprecated for KubeDB `0.9.0-rc.0`.

The default value of this field is `false`. If `spec.depcrecated` is set `true`, KubeDB operator will not create the database and other respective resources for this version.

Expand Down
8 changes: 4 additions & 4 deletions docs/concepts/catalog/mongodb.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: MongoDBVersion
menu:
docs_0.8.0:
docs_0.9.0-rc.0:
identifier: mongodb-version
name: MongoDBVersion
parent: catalog
weight: 30
menu_name: docs_0.8.0
menu_name: docs_0.9.0-rc.0
section_menu_id: concepts
---

Expand Down Expand Up @@ -50,15 +50,15 @@ We follow this convention for naming MongoDBVersion crd:

- Name format: `{Original PosgreSQL image verion}-{modification tag}`

We modify original MongoDB docker image to support MongoDB clustering and re-tag the image with v1,v2 etc. modification tag. An image with higher modification tag will have more feature than the images with lower modification tag. Hence, it is recommended to use MongoDBVersion crd with highest modification tag to enjoy the latest features.
We modify original MongoDB docker image to support MongoDB clustering and re-tag the image with v1, v2 etc. modification tag. An image with higher modification tag will have more feature than the images with lower modification tag. Hence, it is recommended to use MongoDBVersion crd with highest modification tag to enjoy the latest features.

### spec.version

`spec.version` is a required field that specifies the original version of MongoDB database that has been used to build the docker image specified in `spec.db.image` field.

### spec.deprecated

`spec.deprecated` is an optional field that specifies whether the docker images specified here is supported by the current KubeDB operator. For example, we have modified `kubedb/mongo:3.6` docker image to support MongoDB clustering and re-tagged as `kubedb/mongo:3.6-v1`. So, we have marked `kubedb/mongo:3.6` as deprecated for KubeDB `0.9.0`.
`spec.deprecated` is an optional field that specifies whether the docker images specified here is supported by the current KubeDB operator. For example, we have modified `kubedb/mongo:3.6` docker image to support MongoDB clustering and re-tagged as `kubedb/mongo:3.6-v1`. So, we have marked `kubedb/mongo:3.6` as deprecated for KubeDB `0.9.0-rc.0`.

The default value of this field is `false`. If `spec.depcrecated` is set to `true`, KubeDB operator will skip processing this CRD object and will add a event to the CRD object specifying that the DB version is deprecated.

Expand Down
8 changes: 4 additions & 4 deletions docs/concepts/catalog/mysql.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: MySQLVersion
menu:
docs_0.9.0-beta.1:
docs_0.9.0-rc.0:
identifier: mysql-version
name: MySQLVersion
parent: catalog
weight: 30
menu_name: docs_0.9.0-beta.1
menu_name: docs_0.9.0-rc.0
section_menu_id: concepts
---

Expand Down Expand Up @@ -49,15 +49,15 @@ We follow this convention for naming MySQLVersion crd:

- Name format: `{Original MySQL image version}-{modification tag}`

We modify original MySQL docker image to support additional features. An image with higher modification tag will have more feature than the images with lower modification tag. Hence, it is recommended to use MySQLVersion crd with highest modification tag to enjoy latest features.
We modify original MySQL docker image to support additional features. An image with higher modification tag will have more feature than the images with lower modification tag. Hence, it is recommended to use MySQLVersion crd with highest modification tag to take advantage of the latest features.

### spec.version

`spec.version` is a required field that specifies the original version of MySQL database that has been used to build the docker image specified in `spec.db.image` field.

### spec.deprecated

`spec.deprecated` is an optional field that specifies whether the docker images specified here is supported by the current KubeDB operator. For example, we have modified `kubedb/mysql:8.0` docker image to support custom configuration and re-tagged as `kubedb/mysql:8.0-v1`. Now, KubeDB `0.9.0` supports providing custom configuration which required `kubedb/mysql:8.0-v1` docker image. So, we have marked `kubedb/mysql:8.0` as deprecated for KubeDB `0.9.0`.
`spec.deprecated` is an optional field that specifies whether the docker images specified here is supported by the current KubeDB operator. For example, we have modified `kubedb/mysql:8.0` docker image to support custom configuration and re-tagged as `kubedb/mysql:8.0-v1`. Now, KubeDB `0.9.0-rc.0` supports providing custom configuration which required `kubedb/mysql:8.0-v1` docker image. So, we have marked `kubedb/mysql:8.0` as deprecated for KubeDB `0.9.0-rc.0`.

The default value of this field is `false`. If `spec.depcrecated` is set `true`, KubeDB operator will not create the database and other respective resources for this version.

Expand Down
6 changes: 3 additions & 3 deletions docs/concepts/catalog/postgres.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: PostgresVersion
menu:
docs_0.9.0-beta.0:
docs_0.9.0-rc.0:
identifier: postgres-version
name: PostgresVersion
parent: catalog
weight: 30
menu_name: docs_0.9.0-beta.0
menu_name: docs_0.9.0-rc.0
section_menu_id: concepts
---

Expand Down Expand Up @@ -57,7 +57,7 @@ We modify original PostgreSQL docker image to support additional features like W

### spec.deprecated

`spec.deprecated` is an optional field that specifies whether the docker images specified here is supported by the current KubeDB operator. For example, we have modified `kubedb/postgres:10.2` docker image to support custom configuration and re-tagged as `kubedb/postgres:10.2-v1`. Now, KubeDB `0.9.0` supports providing custom configuration which required `kubedb/postgres:10.2-v1` docker image. So, we have marked `kubedb/postgres:10.2` as deprecated in KubeDB `0.9.0`.
`spec.deprecated` is an optional field that specifies whether the docker images specified here is supported by the current KubeDB operator. For example, we have modified `kubedb/postgres:10.2` docker image to support custom configuration and re-tagged as `kubedb/postgres:10.2-v1`. Now, KubeDB `0.9.0-rc.0` supports providing custom configuration which required `kubedb/postgres:10.2-v1` docker image. So, we have marked `kubedb/postgres:10.2` as deprecated in KubeDB `0.9.0-rc.0`.

The default value of this field is `false`. If `spec.depcrecated` is set `true`, KubeDB operator will not create the database and other respective resources for this version.

Expand Down
6 changes: 3 additions & 3 deletions docs/concepts/catalog/redis.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: RedisVersion
menu:
docs_0.8.0:
docs_0.9.0-rc.0:
identifier: redis-version
name: RedisVersion
parent: catalog
weight: 30
menu_name: docs_0.8.0
menu_name: docs_0.9.0-rc.0
section_menu_id: concepts
---

Expand Down Expand Up @@ -47,7 +47,7 @@ We follow this convention for naming RedisVersion crd:

- Name format: `{Original PosgreSQL image verion}-{modification tag}`

We modify original Redis docker image to support Redis clustering and re-tag the image with v1,v2 etc. modification tag. An image with higher modification tag will have more feature than the images with lower modification tag. Hence, it is recommended to use RedisVersion crd with highest modification tag to enjoy the latest features.
We modify original Redis docker image to support Redis clustering and re-tag the image with v1, v2 etc. modification tag. An image with higher modification tag will have more feature than the images with lower modification tag. Hence, it is recommended to use RedisVersion crd with highest modification tag to enjoy the latest features.

### spec.version

Expand Down
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.9.0-beta.0:
docs_0.9.0-rc.0:
identifier: databases
parent: concepts
name: Supported Databases
weight: 15
menu_name: docs_0.9.0-beta.0
menu_name: docs_0.9.0-rc.0
---
Loading