From 7c016159ea7925841022f88fcc011846a3ea1a99 Mon Sep 17 00:00:00 2001 From: Josh Martin Date: Mon, 28 Aug 2023 16:54:52 -0500 Subject: [PATCH 1/4] Added a quick blurb to let folks know where they can check pending maintenance updates. --- docs/platform/concepts/maintenance-window.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/platform/concepts/maintenance-window.rst b/docs/platform/concepts/maintenance-window.rst index 1df3699345..4d3b59acb1 100644 --- a/docs/platform/concepts/maintenance-window.rst +++ b/docs/platform/concepts/maintenance-window.rst @@ -24,4 +24,12 @@ In case of **Apache Kafka®** and **OpenSearch®** the service DNS address resol Maintenance updates ~~~~~~~~~~~~~~~~~~~ -Security updates, platform updates that affect reliability or stability of the service nodes, and quarterly patch updates are always mandatory. Other updates are initially optional. Advance notice is given for all updates. After optional updates have been available for six months, they become mandatory and are applied on the next week's maintenance window at the earliest. This means you have at least 7 days advance notice with exception of critical security updates. These critical updates are applied in the maintenance window of the current week. During service upgrades, maintenance updates are automatically applied and do not require any action from you. \ No newline at end of file +Security updates, platform updates that affect reliability or stability of the service nodes, and quarterly patch updates are always mandatory. Other updates are initially optional. Advance notice is given for all updates. After optional updates have been available for six months, they become mandatory and are applied on the next week's maintenance window at the earliest. This means you have at least 7 days advance notice with exception of critical security updates. These critical updates are applied in the maintenance window of the current week. During service upgrades, maintenance updates are automatically applied and do not require any action from you. + +Pending Maintnenace updates can be viewed in three places. + +1. Service overview page in `the Aiven Console `_. + +2. ``avn service get`` command in `the Aiven CLI `_. + +3. ``service`` endpoint in `the Aiven REST API `_. \ No newline at end of file From b03586c46c165450dd076b4f090d1704bd2af5e7 Mon Sep 17 00:00:00 2001 From: josh-martin-aiven <118401521+josh-martin-aiven@users.noreply.github.com> Date: Mon, 28 Aug 2023 17:40:51 -0500 Subject: [PATCH 2/4] Update maintenance-window.rst Fixed maintenance typo. --- docs/platform/concepts/maintenance-window.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/platform/concepts/maintenance-window.rst b/docs/platform/concepts/maintenance-window.rst index 4d3b59acb1..56fd18987d 100644 --- a/docs/platform/concepts/maintenance-window.rst +++ b/docs/platform/concepts/maintenance-window.rst @@ -26,10 +26,10 @@ Maintenance updates Security updates, platform updates that affect reliability or stability of the service nodes, and quarterly patch updates are always mandatory. Other updates are initially optional. Advance notice is given for all updates. After optional updates have been available for six months, they become mandatory and are applied on the next week's maintenance window at the earliest. This means you have at least 7 days advance notice with exception of critical security updates. These critical updates are applied in the maintenance window of the current week. During service upgrades, maintenance updates are automatically applied and do not require any action from you. -Pending Maintnenace updates can be viewed in three places. +Pending maintenance updates can be viewed in three places. 1. Service overview page in `the Aiven Console `_. 2. ``avn service get`` command in `the Aiven CLI `_. -3. ``service`` endpoint in `the Aiven REST API `_. \ No newline at end of file +3. ``service`` endpoint in `the Aiven REST API `_. From e0008834056f8582f0f1e094edb118d950650418 Mon Sep 17 00:00:00 2001 From: josh-martin-aiven <118401521+josh-martin-aiven@users.noreply.github.com> Date: Thu, 31 Aug 2023 11:04:01 -0500 Subject: [PATCH 3/4] Update maintenance-window.rst Reworded addition to use active voice. put emphasis on overview. changed numbered list to bullet list. --- docs/platform/concepts/maintenance-window.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/platform/concepts/maintenance-window.rst b/docs/platform/concepts/maintenance-window.rst index 56fd18987d..08615fbee9 100644 --- a/docs/platform/concepts/maintenance-window.rst +++ b/docs/platform/concepts/maintenance-window.rst @@ -26,10 +26,10 @@ Maintenance updates Security updates, platform updates that affect reliability or stability of the service nodes, and quarterly patch updates are always mandatory. Other updates are initially optional. Advance notice is given for all updates. After optional updates have been available for six months, they become mandatory and are applied on the next week's maintenance window at the earliest. This means you have at least 7 days advance notice with exception of critical security updates. These critical updates are applied in the maintenance window of the current week. During service upgrades, maintenance updates are automatically applied and do not require any action from you. -Pending maintenance updates can be viewed in three places. +You can view pending maintenance updates in three places. -1. Service overview page in `the Aiven Console `_. +- Service **overview** page in `the Aiven Console `_ -2. ``avn service get`` command in `the Aiven CLI `_. +- ``avn service get`` command in `the Aiven CLI `_ -3. ``service`` endpoint in `the Aiven REST API `_. +- ``service`` endpoint in `the Aiven REST API `_ From bf359bf41be7b65de48cdc96c8c3bade43edbdb5 Mon Sep 17 00:00:00 2001 From: josh-martin-aiven <118401521+josh-martin-aiven@users.noreply.github.com> Date: Tue, 5 Sep 2023 08:32:39 -0500 Subject: [PATCH 4/4] Update maintenance-window.rst Updated wording of initial sentence on bottom section. Used possessive form for for service's overview page. Removed the word "the" in hyperlinks. --- docs/platform/concepts/maintenance-window.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/platform/concepts/maintenance-window.rst b/docs/platform/concepts/maintenance-window.rst index 08615fbee9..2666230be4 100644 --- a/docs/platform/concepts/maintenance-window.rst +++ b/docs/platform/concepts/maintenance-window.rst @@ -26,10 +26,10 @@ Maintenance updates Security updates, platform updates that affect reliability or stability of the service nodes, and quarterly patch updates are always mandatory. Other updates are initially optional. Advance notice is given for all updates. After optional updates have been available for six months, they become mandatory and are applied on the next week's maintenance window at the earliest. This means you have at least 7 days advance notice with exception of critical security updates. These critical updates are applied in the maintenance window of the current week. During service upgrades, maintenance updates are automatically applied and do not require any action from you. -You can view pending maintenance updates in three places. +You can view maintenance updates pending for your service using the following: -- Service **overview** page in `the Aiven Console `_ +- Service's **overview** page in `Aiven Console `_ -- ``avn service get`` command in `the Aiven CLI `_ +- ``avn service get`` command in `Aiven CLI `_ -- ``service`` endpoint in `the Aiven REST API `_ +- ``service`` endpoint in `Aiven REST API `_