From 0fff3251608cf26e6d13ef38ce7d07e0214e5519 Mon Sep 17 00:00:00 2001 From: Abhinav Garg Date: Wed, 27 Dec 2023 15:06:01 -0500 Subject: [PATCH 1/6] Adding a doc for server release process --- docs/guides/hosting/server-release-process.md | 41 +++++++++++++++++++ sidebars.js | 2 + 2 files changed, 43 insertions(+) create mode 100644 docs/guides/hosting/server-release-process.md diff --git a/docs/guides/hosting/server-release-process.md b/docs/guides/hosting/server-release-process.md new file mode 100644 index 000000000..82e9d1663 --- /dev/null +++ b/docs/guides/hosting/server-release-process.md @@ -0,0 +1,41 @@ +--- +description: Release process for Server +displayed_sidebar: default +--- + +# Server Release Process + +## Frequency and deployment types +W&B Server releases apply to the **Dedicated Cloud** and **Self-managed** deployments. There are following kinds of server releases: + +| Release type | Description | +|--------------|-------------| +| Monthly | The monthly general release includes new features, enhancements, and medium & low severity bug fixes. | +| Patch | The patch release includes critical & high severity bug fixes, and is cut only when needed. These could be anywhere from 0 to a few in a month, though we try and eliminate the need altogether by finding & fixing the relevant bugs as part of multi-level testing process (unit, integration and acceptance testing). | +| Feature | The feature release includes specific features that may have been promised to be available by a certain date and thus it needs to be separated from the monthly general release. It's similar to a patch release in that way. | + +All releases are immediately deployed to all **Dedicated Cloud** instances once the acceptance testing phase is complete. It keeps those managed instances fully updated, making the latest features and fixes available to relevant customers. Customers with **Self-managed** instances are responsible for the update process on their own schedule, where they can use the latest docker image from [wandb/local](https://hub.docker.com/r/wandb/local). Refer to [release support and end of life](#release-support-and-end-of-life). + +:::info +Some advanced features are available only with the enterprise license. So even if you get the latest docker image but don't have an enterprise license, you would not be able to take advantage of the relevant advanced capabilities. +::: + +:::note +Some of the new features may be released in private preview and thus are only available to design partners or early adopters. You may not be able to use such a feature until your W&B team enables it for your instance. +::: + +## Release notes +The release notes for all releases are available at [Wandb Server Releases on Github](https://github.com/wandb/server/releases). The notes are automatically published to customers with **Dedicated Cloud** or **Self-managed** deployments who collaborate with their W&B teams using Slack. For rest, we recommend to keep track of the latest on the above linked Github page. + +Let your W&B team know if you have a collaboration slack channel with them but you are not getting the automatic release note updates. + +## Release update and downtime +A server release doesn't generally require instance downtime, at least in case of **Dedicated Cloud** instances and for customers with **Self-managed** deployments who have implemented a proper rolling update process. But downtime may be needed in the following scenarios: + +* When a new feature or enhancement requires changes to the underlying infrastructure like compute, storage or network. We try our best to notify the **Dedicated Cloud** customers in advance of such updates, so they can be well prepared. +* When a infrastructure change is required as part of a security patch or to ensure that we're not hitting `support end-of-life` for a particular version. If such a change needs urgent attention, we may not be able to notify the **Dedicated Cloud** customers in advance. The goal here is to keep the fleet secure & fully supportable at all times. + +For both cases above, such updates are applied to the whole **Dedicated Cloud** fleet in batches, and we can not exclude a particular instance from the process. Customers with **Self-managed** instances are responsible to manage such updates on their own schedule. Refer to [release support and end of life](#release-support-and-end-of-life). + +## Release support and end of life +We officially support server releases from last six months. This should not affect the **Dedicated Cloud** instances as we update those as part of the release process. But customers with **Self-managed** instances should ensure that they're updating their deployment(s) with the latest release when possible. Staying on a version older than six months would mean that they have limited to no means of support. \ No newline at end of file diff --git a/sidebars.js b/sidebars.js index ec7d6b008..54d5904af 100644 --- a/sidebars.js +++ b/sidebars.js @@ -371,6 +371,7 @@ const sidebars = { 'guides/hosting/smtp', 'guides/hosting/slack-alerts', 'guides/hosting/scim', + 'guides/hosting/server-release-process', ], }, // 'guides/hosting/debug', @@ -759,6 +760,7 @@ const sidebars = { 'guides/hosting/smtp', 'guides/hosting/env-vars', 'guides/hosting/scim', + 'guides/hosting/server-release-process', { type: 'category', label: 'ハウツーガイド', From e9630448c7aea436507c873ca5423781a6bc16c1 Mon Sep 17 00:00:00 2001 From: Carey Phelps Date: Wed, 27 Dec 2023 16:27:54 -0800 Subject: [PATCH 2/6] Vale nits --- docs/guides/hosting/server-release-process.md | 28 +++++++++---------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/docs/guides/hosting/server-release-process.md b/docs/guides/hosting/server-release-process.md index 82e9d1663..179ef5386 100644 --- a/docs/guides/hosting/server-release-process.md +++ b/docs/guides/hosting/server-release-process.md @@ -1,41 +1,39 @@ --- -description: Release process for Server +description: Release process for W&B Server displayed_sidebar: default --- -# Server Release Process +# Server release process ## Frequency and deployment types W&B Server releases apply to the **Dedicated Cloud** and **Self-managed** deployments. There are following kinds of server releases: | Release type | Description | |--------------|-------------| -| Monthly | The monthly general release includes new features, enhancements, and medium & low severity bug fixes. | -| Patch | The patch release includes critical & high severity bug fixes, and is cut only when needed. These could be anywhere from 0 to a few in a month, though we try and eliminate the need altogether by finding & fixing the relevant bugs as part of multi-level testing process (unit, integration and acceptance testing). | -| Feature | The feature release includes specific features that may have been promised to be available by a certain date and thus it needs to be separated from the monthly general release. It's similar to a patch release in that way. | +| Monthly | Monthly releases include new features, medium and low severity bug fixes, and enhancements. | +| Patch | Patch releases include critical and high severity bug fixes. Patches are only rarely released, as needed. | +| Feature | The feature release targets a specific release date for a new product feature, which occasionally happens before the standard monthly release. | -All releases are immediately deployed to all **Dedicated Cloud** instances once the acceptance testing phase is complete. It keeps those managed instances fully updated, making the latest features and fixes available to relevant customers. Customers with **Self-managed** instances are responsible for the update process on their own schedule, where they can use the latest docker image from [wandb/local](https://hub.docker.com/r/wandb/local). Refer to [release support and end of life](#release-support-and-end-of-life). +All releases are immediately deployed to all **Dedicated Cloud** instances once the acceptance testing phase is complete. It keeps those managed instances fully updated, making the latest features and fixes available to relevant customers. Customers with **Self-managed** instances are responsible for the update process on their own schedule, where they can use[the latest Docker image](https://hub.docker.com/r/wandb/local). Refer to [release support and end of life](#release-support-and-end-of-life). :::info Some advanced features are available only with the enterprise license. So even if you get the latest docker image but don't have an enterprise license, you would not be able to take advantage of the relevant advanced capabilities. ::: :::note -Some of the new features may be released in private preview and thus are only available to design partners or early adopters. You may not be able to use such a feature until your W&B team enables it for your instance. +Some new features start in private preview, which means they are only available to design partners or early adopters. You may not have such a feature until the W&B team enables it for your instance. ::: ## Release notes -The release notes for all releases are available at [Wandb Server Releases on Github](https://github.com/wandb/server/releases). The notes are automatically published to customers with **Dedicated Cloud** or **Self-managed** deployments who collaborate with their W&B teams using Slack. For rest, we recommend to keep track of the latest on the above linked Github page. - -Let your W&B team know if you have a collaboration slack channel with them but you are not getting the automatic release note updates. +The release notes for all releases are available at [W&B Server Releases on GitHub](https://github.com/wandb/server/releases). Customers who use Slack can receive automatic release announcements in their W&B Slack channel. Ask your W&B team to enable these updates. ## Release update and downtime -A server release doesn't generally require instance downtime, at least in case of **Dedicated Cloud** instances and for customers with **Self-managed** deployments who have implemented a proper rolling update process. But downtime may be needed in the following scenarios: +A server release doesn't generally require instance downtime for **Dedicated Cloud** instances and for customers with **Self-managed** deployments who have implemented a proper rolling update process. Downtime may be needed in the following scenarios: -* When a new feature or enhancement requires changes to the underlying infrastructure like compute, storage or network. We try our best to notify the **Dedicated Cloud** customers in advance of such updates, so they can be well prepared. -* When a infrastructure change is required as part of a security patch or to ensure that we're not hitting `support end-of-life` for a particular version. If such a change needs urgent attention, we may not be able to notify the **Dedicated Cloud** customers in advance. The goal here is to keep the fleet secure & fully supportable at all times. +* When a new feature or enhancement requires changes to the underlying infrastructure like compute, storage or network, account teams work with **Dedicated Cloud** customers in advance of such updates. +* When a infrastructure change is required as part of a security patch or to avoid hitting `support end-of-life` for a particular version. For urgent changes, **Dedicated Cloud** customers may not receive notification in advance. The priority here is to keep the fleet secure and fully supported. -For both cases above, such updates are applied to the whole **Dedicated Cloud** fleet in batches, and we can not exclude a particular instance from the process. Customers with **Self-managed** instances are responsible to manage such updates on their own schedule. Refer to [release support and end of life](#release-support-and-end-of-life). +For both cases, such updates are applied to the whole **Dedicated Cloud** fleet in batches, and we can not exclude a particular instance from the process. Customers with **Self-managed** instances are responsible to manage such updates on their own schedule. Refer to [release support and end of life](#release-support-and-end-of-life). ## Release support and end of life -We officially support server releases from last six months. This should not affect the **Dedicated Cloud** instances as we update those as part of the release process. But customers with **Self-managed** instances should ensure that they're updating their deployment(s) with the latest release when possible. Staying on a version older than six months would mean that they have limited to no means of support. \ No newline at end of file +W&B supports server releases for six months. **Dedicated Cloud** instances are automatically updated. Customers with **Self-managed** instances need to run a process to update deployments with the latest released. Staying on a version older than six months will significantly limit support. \ No newline at end of file From d4f0733a01f8e6972d1ce118045a5272e7806132 Mon Sep 17 00:00:00 2001 From: Noah Luna <15202580+ngrayluna@users.noreply.github.com> Date: Wed, 27 Dec 2023 16:57:30 -0800 Subject: [PATCH 3/6] Word smithing --- docs/guides/hosting/server-release-process.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/guides/hosting/server-release-process.md b/docs/guides/hosting/server-release-process.md index 179ef5386..307e6f8d2 100644 --- a/docs/guides/hosting/server-release-process.md +++ b/docs/guides/hosting/server-release-process.md @@ -6,7 +6,7 @@ displayed_sidebar: default # Server release process ## Frequency and deployment types -W&B Server releases apply to the **Dedicated Cloud** and **Self-managed** deployments. There are following kinds of server releases: +W&B Server releases apply to the **Dedicated Cloud** and **Self-managed** deployments. There are three kinds of server releases: | Release type | Description | |--------------|-------------| @@ -28,10 +28,10 @@ Some new features start in private preview, which means they are only available The release notes for all releases are available at [W&B Server Releases on GitHub](https://github.com/wandb/server/releases). Customers who use Slack can receive automatic release announcements in their W&B Slack channel. Ask your W&B team to enable these updates. ## Release update and downtime -A server release doesn't generally require instance downtime for **Dedicated Cloud** instances and for customers with **Self-managed** deployments who have implemented a proper rolling update process. Downtime may be needed in the following scenarios: +A server release does not generally require instance downtime for **Dedicated Cloud** instances and for customers with **Self-managed** deployments who have implemented a proper rolling update process. Downtime may be needed in the following scenarios: -* When a new feature or enhancement requires changes to the underlying infrastructure like compute, storage or network, account teams work with **Dedicated Cloud** customers in advance of such updates. -* When a infrastructure change is required as part of a security patch or to avoid hitting `support end-of-life` for a particular version. For urgent changes, **Dedicated Cloud** customers may not receive notification in advance. The priority here is to keep the fleet secure and fully supported. +* A new feature or enhancement requires changes to the underlying infrastructure like compute, storage or network, account teams work with **Dedicated Cloud** customers in advance of such updates. +* A infrastructure change is required as part of a security patch or to avoid hitting `support end-of-life` for a particular version. For urgent changes, **Dedicated Cloud** customers may not receive notification in advance. The priority here is to keep the fleet secure and fully supported. For both cases, such updates are applied to the whole **Dedicated Cloud** fleet in batches, and we can not exclude a particular instance from the process. Customers with **Self-managed** instances are responsible to manage such updates on their own schedule. Refer to [release support and end of life](#release-support-and-end-of-life). From 8a8e5ea6158b56fb81406d3744244556737e4ee0 Mon Sep 17 00:00:00 2001 From: Noah Luna <15202580+ngrayluna@users.noreply.github.com> Date: Wed, 27 Dec 2023 17:08:22 -0800 Subject: [PATCH 4/6] more word smithing --- docs/guides/hosting/server-release-process.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/guides/hosting/server-release-process.md b/docs/guides/hosting/server-release-process.md index 307e6f8d2..2a610e5ca 100644 --- a/docs/guides/hosting/server-release-process.md +++ b/docs/guides/hosting/server-release-process.md @@ -28,10 +28,10 @@ Some new features start in private preview, which means they are only available The release notes for all releases are available at [W&B Server Releases on GitHub](https://github.com/wandb/server/releases). Customers who use Slack can receive automatic release announcements in their W&B Slack channel. Ask your W&B team to enable these updates. ## Release update and downtime -A server release does not generally require instance downtime for **Dedicated Cloud** instances and for customers with **Self-managed** deployments who have implemented a proper rolling update process. Downtime may be needed in the following scenarios: +A server release does not generally require instance downtime for **Dedicated Cloud** instances and for customers with **Self-managed** deployments who have implemented a proper rolling update process. Downtime might be needed in the following scenarios: -* A new feature or enhancement requires changes to the underlying infrastructure like compute, storage or network, account teams work with **Dedicated Cloud** customers in advance of such updates. -* A infrastructure change is required as part of a security patch or to avoid hitting `support end-of-life` for a particular version. For urgent changes, **Dedicated Cloud** customers may not receive notification in advance. The priority here is to keep the fleet secure and fully supported. +* A new feature or enhancement requires changes to the underlying infrastructure such as compute, storage or network. Account teams work with **Dedicated Cloud** customers in advance of such updates. +* An infrastructure change is required as part of a security patch or to avoid `support end-of-life` for a particular version. For urgent changes, **Dedicated Cloud** customers might not receive notification in advance. The priority here is to keep the fleet secure and fully supported. For both cases, such updates are applied to the whole **Dedicated Cloud** fleet in batches, and we can not exclude a particular instance from the process. Customers with **Self-managed** instances are responsible to manage such updates on their own schedule. Refer to [release support and end of life](#release-support-and-end-of-life). From b4f2f021d243c6f55a312833014096e02a56650c Mon Sep 17 00:00:00 2001 From: Noah Luna <15202580+ngrayluna@users.noreply.github.com> Date: Wed, 27 Dec 2023 17:15:41 -0800 Subject: [PATCH 5/6] more word smithing --- docs/guides/hosting/server-release-process.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/guides/hosting/server-release-process.md b/docs/guides/hosting/server-release-process.md index 2a610e5ca..2f3b19555 100644 --- a/docs/guides/hosting/server-release-process.md +++ b/docs/guides/hosting/server-release-process.md @@ -28,12 +28,14 @@ Some new features start in private preview, which means they are only available The release notes for all releases are available at [W&B Server Releases on GitHub](https://github.com/wandb/server/releases). Customers who use Slack can receive automatic release announcements in their W&B Slack channel. Ask your W&B team to enable these updates. ## Release update and downtime -A server release does not generally require instance downtime for **Dedicated Cloud** instances and for customers with **Self-managed** deployments who have implemented a proper rolling update process. Downtime might be needed in the following scenarios: +A server release does not generally require instance downtime for **Dedicated Cloud** instances and for customers with **Self-managed** deployments who have implemented a proper rolling update process. + +Downtime might occur for the following scenarios: * A new feature or enhancement requires changes to the underlying infrastructure such as compute, storage or network. Account teams work with **Dedicated Cloud** customers in advance of such updates. -* An infrastructure change is required as part of a security patch or to avoid `support end-of-life` for a particular version. For urgent changes, **Dedicated Cloud** customers might not receive notification in advance. The priority here is to keep the fleet secure and fully supported. +* An infrastructure change due to a security patch or to avoid `support end-of-life` for a particular version. For urgent changes, **Dedicated Cloud** customers might not receive notification in advance. The priority here is to keep the fleet secure and fully supported. -For both cases, such updates are applied to the whole **Dedicated Cloud** fleet in batches, and we can not exclude a particular instance from the process. Customers with **Self-managed** instances are responsible to manage such updates on their own schedule. Refer to [release support and end of life](#release-support-and-end-of-life). +For both cases, updates are applied to the whole **Dedicated Cloud** fleet in batches. W&B can not exclude a particular instance from the process. Customers with **Self-managed** instances are responsible to manage updates on their own schedule. Refer to [release support and end of life](#release-support-and-end-of-life). ## Release support and end of life -W&B supports server releases for six months. **Dedicated Cloud** instances are automatically updated. Customers with **Self-managed** instances need to run a process to update deployments with the latest released. Staying on a version older than six months will significantly limit support. \ No newline at end of file +W&B supports server releases for six months. **Dedicated Cloud** instances are automatically updated. Customers with **Self-managed** instances need to run a process to update deployments with the latest released. Staying on a version older than six months significantly limits support. \ No newline at end of file From 6b9d97a97eb92f31bdaf251bd67cbcc1e7885891 Mon Sep 17 00:00:00 2001 From: Carey Phelps Date: Wed, 27 Dec 2023 17:23:17 -0800 Subject: [PATCH 6/6] vale linting --- docs/guides/hosting/server-release-process.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/guides/hosting/server-release-process.md b/docs/guides/hosting/server-release-process.md index 2f3b19555..c543bbf93 100644 --- a/docs/guides/hosting/server-release-process.md +++ b/docs/guides/hosting/server-release-process.md @@ -28,14 +28,13 @@ Some new features start in private preview, which means they are only available The release notes for all releases are available at [W&B Server Releases on GitHub](https://github.com/wandb/server/releases). Customers who use Slack can receive automatic release announcements in their W&B Slack channel. Ask your W&B team to enable these updates. ## Release update and downtime -A server release does not generally require instance downtime for **Dedicated Cloud** instances and for customers with **Self-managed** deployments who have implemented a proper rolling update process. +A server release does not generally require instance downtime for **Dedicated Cloud** instances and for customers with **Self-managed** deployments who have implemented a proper rolling update process. Downtime might occur for the following scenarios: - * A new feature or enhancement requires changes to the underlying infrastructure such as compute, storage or network. Account teams work with **Dedicated Cloud** customers in advance of such updates. * An infrastructure change due to a security patch or to avoid `support end-of-life` for a particular version. For urgent changes, **Dedicated Cloud** customers might not receive notification in advance. The priority here is to keep the fleet secure and fully supported. -For both cases, updates are applied to the whole **Dedicated Cloud** fleet in batches. W&B can not exclude a particular instance from the process. Customers with **Self-managed** instances are responsible to manage updates on their own schedule. Refer to [release support and end of life](#release-support-and-end-of-life). +For both cases, updates roll out to all **Dedicated Cloud** instances without exception. Customers with **Self-managed** instances are responsible to manage such updates on their own schedule. Refer to [release support and end of life](#release-support-and-end-of-life). ## Release support and end of life -W&B supports server releases for six months. **Dedicated Cloud** instances are automatically updated. Customers with **Self-managed** instances need to run a process to update deployments with the latest released. Staying on a version older than six months significantly limits support. \ No newline at end of file +W&B supports server releases for six months. **Dedicated Cloud** instances are automatically updated. Customers with **Self-managed** instances need to run a process to update deployments with the latest released. Avoid staying on a version older than six months, as this significantly limits support. \ No newline at end of file