From 770c3c3f8aaad6fb2931a21b85351a4946d49d6c Mon Sep 17 00:00:00 2001 From: Murad Biashimov Date: Wed, 15 Feb 2023 10:41:52 +0100 Subject: [PATCH] release: v0.8.0 (#268) Co-authored-by: Stacey Salamon <111294980+staceysalamon-aiven@users.noreply.github.com> --- CHANGELOG.md | 16 ++++++++-- docs/docs/api-reference/index.md | 7 ++++ docs/docs/changelog.md | 16 +++++++--- docs/docs/contributing/developer-guide.md | 2 +- docs/docs/contributing/index.md | 6 ++-- docs/mkdocs.yml | 39 +++++++++++++---------- 6 files changed, 59 insertions(+), 27 deletions(-) create mode 100644 docs/docs/api-reference/index.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 848b0d776..b2843a4f5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,10 +2,20 @@ ## [MAJOR.MINOR.PATCH] - YYYY-MM-DD -- Add `serviceIntegrations` on service types. Only `read_replica` type for now. +## v0.8.0 - 2023-02-15 + +**Important:** This release brings breaking changes to the `userConfig` property. +After new charts are installed, update your existing instances manually using the `kubectl edit` command +according to the [API reference](https://aiven.github.io/aiven-operator/api-reference/). + +**Note:** It is now recommended to disable webhooks for Kubernetes version 1.25 and higher, +as native [CRD validation rules](https://kubernetes.io/blog/2022/09/23/crd-validation-rules-beta/) are used. + +- **Breaking change:** `ip_filter` field is now of `object` type +- **Breaking change:** Update user configs for following kinds: PostgreSQL, Kafka, KafkaConnect, Redis, Clickhouse, OpenSearch - Add CRD validation rules for immutable fields -- **Breaking change:** `ip_filter` field is now of `object` type. -- **Breaking change:** Update user configs for following kinds: PostgreSQL, Kafka, Redis, Clickhouse, OpenSearch, KafkaConnect. +- Add user config field validations (enum, minimum, maximum, minLength, and others) +- Add `serviceIntegrations` on service types. Only the `read_replica` type is available. - Add KafkaTopic `min_cleanable_dirty_ratio` config field support - Add Clickhouse `spec.disk_space` property - Use updated aiven-go-client with retries diff --git a/docs/docs/api-reference/index.md b/docs/docs/api-reference/index.md new file mode 100644 index 000000000..f73839abd --- /dev/null +++ b/docs/docs/api-reference/index.md @@ -0,0 +1,7 @@ +--- +title: "" +--- + +# aiven.io/v1alpha1 + +Autogenerated from [CRD](https://github.com/aiven/aiven-operator/tree/main/config/crd/bases) files. diff --git a/docs/docs/changelog.md b/docs/docs/changelog.md index 3d641d8ed..9b5f1371c 100644 --- a/docs/docs/changelog.md +++ b/docs/docs/changelog.md @@ -1,11 +1,19 @@ # Changelog -## 🚧 Under development +## v0.8.0 - 2023-02-15 -- Add `serviceIntegrations` on service types. Only `read_replica` type for now. +**Important:** This release brings breaking changes to the `userConfig` property. +After new charts are installed, update your existing instances manually using the `kubectl edit` command +according to the [API reference](https://aiven.github.io/aiven-operator/api-reference/). + +**Note:** It is now recommended to disable webhooks for Kubernetes version 1.25 and higher, +as native [CRD validation rules](https://kubernetes.io/blog/2022/09/23/crd-validation-rules-beta/) are used. + +- **Breaking change:** `ip_filter` field is now of `object` type +- **Breaking change:** Update user configs for following kinds: PostgreSQL, Kafka, KafkaConnect, Redis, Clickhouse, OpenSearch - Add CRD validation rules for immutable fields -- **Breaking change:** `ip_filter` field is now of `object` type. -- **Breaking change:** Update user configs for following kinds: PostgreSQL, Kafka, Redis, Clickhouse, OpenSearch, KafkaConnect. +- Add user config field validations (enum, minimum, maximum, minLength, and others) +- Add `serviceIntegrations` on service types. Only the `read_replica` type is available. - Add KafkaTopic `min_cleanable_dirty_ratio` config field support - Add Clickhouse `spec.disk_space` property - Use updated aiven-go-client with retries diff --git a/docs/docs/contributing/developer-guide.md b/docs/docs/contributing/developer-guide.md index 5d815f147..d27d7d58d 100644 --- a/docs/docs/contributing/developer-guide.md +++ b/docs/docs/contributing/developer-guide.md @@ -44,7 +44,7 @@ To run the documentation live preview: make serve-docs ``` -And open the `http://localhost:1313/aiven-operator/` page in your web browser. +And open the `http://localhost:8000/aiven-operator/` page in your web browser. The documentation API Reference section is generated automatically from the source code during the documentation deployment. To generate it locally, run the following command: diff --git a/docs/docs/contributing/index.md b/docs/docs/contributing/index.md index 586fd51cc..0310e4e2c 100644 --- a/docs/docs/contributing/index.md +++ b/docs/docs/contributing/index.md @@ -1,6 +1,6 @@ --- -title: "Contributing" -linkTitle: "Contributing" +title: "Guidelines" +linkTitle: "Guidelines" weight: 85 --- @@ -71,7 +71,7 @@ event. Representation of a project may be further defined and clarified by proje ### Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team -at opensource@aiven.io. All complaints will be reviewed and investigated and will result in a response that is deemed +at . All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 06079c6ab..62bddf4ba 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -16,6 +16,9 @@ markdown_extensions: - attr_list - toc: permalink: true + - pymdownx.emoji: + emoji_index: !!python/name:materialx.emoji.twemoji + emoji_generator: !!python/name:materialx.emoji.to_svg plugins: - search - offline @@ -25,6 +28,8 @@ theme: features: - navigation.top - navigation.footer + - navigation.tabs + - navigation.sections - content.code.copy - content.code.annotate - content.action.view @@ -47,30 +52,32 @@ theme: icon: material/brightness-4 name: Switch to light mode nav: - - Home: index.md - - changelog.md - - Installation: - - installation/prerequisites.md - - installation/helm.md - - installation/kubectl.md - - installation/uninstalling.md - - authentication.md + - Home: + - index.md + - changelog.md + - Setup: + - installation/prerequisites.md + - installation/helm.md + - installation/kubectl.md + - authentication.md + - troubleshooting.md + - installation/uninstalling.md + - Contributing: + - contributing/index.md + - contributing/developer-guide.md - Resources: - resources/project.md - resources/project-vpc.md - - Kafka: - - resources/kafka/index.md - - resources/kafka/schema.md - - resources/kafka/connect.md - resources/postgresql.md - resources/opensearch.md - resources/redis.md - resources/service-integrations.md - - troubleshooting.md - - Contributing: - - contributing/index.md - - contributing/developer-guide.md + - Kafka: + - resources/kafka/index.md + - resources/kafka/schema.md + - resources/kafka/connect.md - API Reference: + - api-reference/index.md - api-reference/cassandra.md - api-reference/clickhouse.md - api-reference/clickhouseuser.md