From cbf1b4c21dce562158248e883cfaba1c3d224898 Mon Sep 17 00:00:00 2001 From: Felix Hennig Date: Thu, 19 Oct 2023 13:00:08 +0200 Subject: [PATCH 1/7] ~ --- ...ting_started.adoc => getting-started.adoc} | 1 + ...{release_guide.adoc => release-guide.adoc} | 0 ...{release_notes.adoc => release-notes.adoc} | 1 + supplemental-ui/partials/navbar.hbs | 25 +++++++++++++++---- 4 files changed, 22 insertions(+), 5 deletions(-) rename modules/ROOT/pages/{getting_started.adoc => getting-started.adoc} (99%) rename modules/ROOT/pages/{release_guide.adoc => release-guide.adoc} (100%) rename modules/ROOT/pages/{release_notes.adoc => release-notes.adoc} (99%) diff --git a/modules/ROOT/pages/getting_started.adoc b/modules/ROOT/pages/getting-started.adoc similarity index 99% rename from modules/ROOT/pages/getting_started.adoc rename to modules/ROOT/pages/getting-started.adoc index e5e7614a4..a4b7b8419 100644 --- a/modules/ROOT/pages/getting_started.adoc +++ b/modules/ROOT/pages/getting-started.adoc @@ -1,4 +1,5 @@ = Getting Started +:page-aliases: getting_started.adoc One of the best ways of getting started with a new platform is to try it out. Any big data platform has a lot of moving parts and getting some hands on keyboard time with it helps reinforce learning. diff --git a/modules/ROOT/pages/release_guide.adoc b/modules/ROOT/pages/release-guide.adoc similarity index 100% rename from modules/ROOT/pages/release_guide.adoc rename to modules/ROOT/pages/release-guide.adoc diff --git a/modules/ROOT/pages/release_notes.adoc b/modules/ROOT/pages/release-notes.adoc similarity index 99% rename from modules/ROOT/pages/release_notes.adoc rename to modules/ROOT/pages/release-notes.adoc index a1d7d9ea1..924d3bbe1 100644 --- a/modules/ROOT/pages/release_notes.adoc +++ b/modules/ROOT/pages/release-notes.adoc @@ -1,4 +1,5 @@ = Release notes for the Stackable Data Platform +:page-aliases: release_notes.adoc The Stackable platform consists of multiple operators that work together. Periodically a platform release is made, including all components of the platform at a specific version. diff --git a/supplemental-ui/partials/navbar.hbs b/supplemental-ui/partials/navbar.hbs index b36bd890b..63b96c4eb 100644 --- a/supplemental-ui/partials/navbar.hbs +++ b/supplemental-ui/partials/navbar.hbs @@ -1,12 +1,11 @@ Home Getting Started -Concepts -Demos
- Management + Platform
- Cockpit - stackablectl + Concepts + Demos + Tutorials
@@ -30,4 +29,20 @@ Listener
+
+ Management +
+ Cockpit + stackablectl +
+
+
+ Product Information +
+ Overview + Release Notes + Policies + Licenses +
+
Contribute From 3635aec1192238e0c0ef561cbc39a476e8be7f8f Mon Sep 17 00:00:00 2001 From: Felix Hennig Date: Thu, 19 Oct 2023 13:27:31 +0200 Subject: [PATCH 2/7] ~ --- modules/ROOT/nav.adoc | 2 +- modules/ROOT/nav2.adoc | 3 +- modules/ROOT/pages/policies.adoc | 43 +++++++++++++++-------------- supplemental-ui/partials/navbar.hbs | 2 +- 4 files changed, 26 insertions(+), 24 deletions(-) diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index df450eed6..b90ea08c9 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -1,3 +1,3 @@ * xref:quickstart.adoc[] * xref:kubernetes.adoc[] -* xref:getting_started.adoc[] +* xref:getting-started.adoc[] diff --git a/modules/ROOT/nav2.adoc b/modules/ROOT/nav2.adoc index cadc27deb..dfa7907de 100644 --- a/modules/ROOT/nav2.adoc +++ b/modules/ROOT/nav2.adoc @@ -1,5 +1,6 @@ // This second nav file is for another menu entry at the end of the navigation menu // see: https://docs.antora.org/antora/3.0/navigation/organize-files/#multiple-files-per-module -* xref:release_notes.adoc[Release Notes] +* xref:release-notes.adoc[Release notes] * xref:product-information.adoc[] +* xref:policies.adoc[] * xref:licenses.adoc[Licenses] \ No newline at end of file diff --git a/modules/ROOT/pages/policies.adoc b/modules/ROOT/pages/policies.adoc index 52c1478f3..14b304a47 100644 --- a/modules/ROOT/pages/policies.adoc +++ b/modules/ROOT/pages/policies.adoc @@ -1,12 +1,11 @@ -= Lifecycle Policies += Lifecycle policies -This page details our current lifecycle policies around various parts of our product - the Stackable Data Platform (SDP). +This page details our lifecycle policies around various parts of our product - the Stackable Data Platform (SDP). -We define multiple lifecycle policies for different parts of our platform, but all these policies follow some common goals: +We define multiple lifecycle policies for different parts of our platform, but all policies follow some common goals: * It should always be possible to upgrade to a new version of SDP without also changing any of your Kubernetes resources as long as you are not currently using anything that has already been marked as deprecated ** This means you can upgrade the control plane independently of the user-facing products - * All deprecations follow a predictable lifecycle that allows planning of upgrades ahead of time The guarantees we give are on multiple levels as detailed below: @@ -20,21 +19,20 @@ All these policies may evolve as we learn what works best for our customers and These policies are from *July 2023*. - -== Stackable Data Platform Lifecycle Policy +== Stackable Data Platform lifecycle policy NOTE: This policy concerns releases of our platform as a whole and how long and to which extent we support each version. We do releases of our Stackable Data Platform. These releases get a name based on the year and month they have been released in (e.g. `23.4`, `23.7`, also called https://calver.org/[CalVer]). This name does not follow Semantic Versioning (https://semver.org/[SemVer]). We may release patches for a release, which then follow the PATCH naming semantics of SemVer (e.g. `23.4.1`) or the _Micro_ name from CalVer. See below for our policy on patches for the SDP. -We do support an SDP release for a specific time after its release. +We support an SDP release for a specific time after its release. An SDP release contains our operators and other code developed at Stackable as well as the product docker images. TIP: Our policy is inspired by the https://kubernetes.io/releases/patch-releases/[Kubernetes] and the https://access.redhat.com/support/policy/updates/openshift#ocp4[OpenShift] policies. -=== Full Support Phase +=== Full support phase This phase begins once a new non-patch SDP version is released and ends after a 6-month period OR 3 months after the general availability of the superseding non-patch release, whichever is later. @@ -47,26 +45,26 @@ image:full_support_scenario_2.png[Full Support Scenario 2] We _will_ release new patch releases of a SDP release (e.g. `23.4.1`) for any issues we deem Critical or High (see definition below) once fixes become available. We _may_ release new patch releases for other reasons. -=== Maintenance Phase +=== Maintenance phase This phase commences after the _Full Support_ phase for the respective SDP version and ends 12 months after general availability of the SDP release. We _may_ release new patch releases of a SDP release (e.g. `23.4.1`) for any issues we deem Critical or High (see definition below) once fixes become available. +We may release patches for other reasons. image:maintenance_phase.png[Maintenance Phase] -=== General - -We may release patches for other reasons. +== Upgrade policy Customers are expected to upgrade their SDP environment to the most current supported patch/micro (`23.4.z`) version. -Make sure to follow our release notes to learn of valid upgrade paths, some intermediate updates might be necessary. +Skipping SDP releases while upgrading is not currently supported. +The only upgrade path we support is from one version to the next. -== CRD Versioning Lifecycle Policy +== CRD Versioning lifecycle policy IMPORTANT: As of June 2023 all our CRDs are versioned as `alpha1`. We will start introducing other versions later in 2023. -``CustomResourceDefinition``s at Stackable are versioned. +CustomResourceDefinitions at Stackable are versioned. Our policies around CRD versioning are inspired by the https://kubernetes.io/docs/reference/using-api/deprecation-policy/[Kubernetes Deprecation Policy]. @@ -90,7 +88,7 @@ Similar to the Exception noted by the Kubernetes project itself, we will also ev NOTE: According to these rules it is legal to _add_ fields to a CRD without increasing the version as long as there is a default for this field. -== Product Lifecycle Policy +== Product lifecycle policy SDP ships with a lot of different downstream products (e.g. Apache HBase, Apache Superset). @@ -114,9 +112,10 @@ image:product_release_cycle.png[Product Lifecycle Policy] === Deprecation Every product version that gets removed will be deprecated for at least 1 SDP release before removal. -This guarantees that users can update the operators (e.g. from 23.1 to 23.4) without the need to simultaneously update the product version as well. The flow is to first update the control plane (the operators) and afterward the product versions if desired (e.g. when the currently used version is now deprecated). +This guarantees that users can update the operators (e.g. from 23.1 to 23.4) without the need to simultaneously update the product version as well. +The flow is to first update the control plane (the operators) and afterward the product versions if desired (e.g. when the currently used version is now deprecated). -=== Definition of "support" +=== Definition of support We will ship new versions of the LTS release line in our currently supported SDP releases (see above) for any issues we deem Critical or High in severity when they become available. @@ -127,7 +126,7 @@ It is our explicit goal to limit the amount of times we have to ship a version o We may ship new versions for existing SDP releases for other issues as well. -== OpenShift & Kubernetes Support Policy +== OpenShift & Kubernetes support policy For every SDP release we will publish a list of supported Kubernetes versions. @@ -135,9 +134,11 @@ We are aiming to support the last three Kubernetes versions but will make case-b We will also take into account currently supported OpenShift versions as published by RedHat. It is our goal to support all versions that are in Full or Maintenance support. As the releases may be overlapping we might not always support the latest Kubernetes or OpenShift versions when we release a SDP version. -== Support Policy (Security & Bugs) +== Support policy (security & bugs) -Stackable will analyze published security vulnerabilities (e.g. CVEs but other sources may apply as well) for all the products we support as well components developed by us and their dependencies. We take various sources into account when assigning a criticality. Among those sources is the NVD database, but we place higher value on the self-assessments by the projects themselves, and we will additionally evaluate vulnerabilities in the context of how they are used in the Stackable Data Platform. +Stackable will analyze published security vulnerabilities (e.g. CVEs but other sources may apply as well) for all the products we support as well components developed by us and their dependencies. +We take various sources into account when assigning a criticality. +Among those sources is the NVD database, but we place higher value on the self-assessments by the projects themselves, and we will additionally evaluate vulnerabilities in the context of how they are used in the Stackable Data Platform. We will then assign a criticality to each vulnerability according to similar rating categories that https://access.redhat.com/security/updates/classification[RedHat has established]: diff --git a/supplemental-ui/partials/navbar.hbs b/supplemental-ui/partials/navbar.hbs index 63b96c4eb..a4e4aa4ee 100644 --- a/supplemental-ui/partials/navbar.hbs +++ b/supplemental-ui/partials/navbar.hbs @@ -40,7 +40,7 @@ Product Information
Overview - Release Notes + Release Notes Policies Licenses
From 51f0abdcab8b7fc49c15e2730d5f441df1c9b734 Mon Sep 17 00:00:00 2001 From: Felix Hennig Date: Thu, 19 Oct 2023 13:53:01 +0200 Subject: [PATCH 3/7] fix links --- supplemental-ui/partials/navbar.hbs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/supplemental-ui/partials/navbar.hbs b/supplemental-ui/partials/navbar.hbs index a4e4aa4ee..5e2ddb1d7 100644 --- a/supplemental-ui/partials/navbar.hbs +++ b/supplemental-ui/partials/navbar.hbs @@ -39,10 +39,10 @@
Product Information
- Overview + Overview Release Notes Policies - Licenses + Licenses
Contribute From 6e4d853dc2258d3c9d38b4b6029be069b9a9518f Mon Sep 17 00:00:00 2001 From: Felix Hennig Date: Thu, 19 Oct 2023 16:21:41 +0200 Subject: [PATCH 4/7] Update modules/ROOT/pages/policies.adoc Co-authored-by: Techassi --- modules/ROOT/pages/policies.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/policies.adoc b/modules/ROOT/pages/policies.adoc index 14b304a47..14cd4882c 100644 --- a/modules/ROOT/pages/policies.adoc +++ b/modules/ROOT/pages/policies.adoc @@ -57,7 +57,7 @@ image:maintenance_phase.png[Maintenance Phase] == Upgrade policy Customers are expected to upgrade their SDP environment to the most current supported patch/micro (`23.4.z`) version. -Skipping SDP releases while upgrading is not currently supported. +Skipping SDP releases while upgrading is currently not supported. The only upgrade path we support is from one version to the next. == CRD Versioning lifecycle policy From 372d814c531678b97191eb0710e1216346f3e925 Mon Sep 17 00:00:00 2001 From: Felix Hennig Date: Thu, 19 Oct 2023 16:27:29 +0200 Subject: [PATCH 5/7] reorganized menu --- supplemental-ui/partials/navbar.hbs | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/supplemental-ui/partials/navbar.hbs b/supplemental-ui/partials/navbar.hbs index 5e2ddb1d7..d57dd8b11 100644 --- a/supplemental-ui/partials/navbar.hbs +++ b/supplemental-ui/partials/navbar.hbs @@ -3,9 +3,10 @@
Platform
- Concepts - Demos - Tutorials + Concepts + Demos + Tutorials + Release Notes
@@ -37,10 +38,9 @@
- Product Information + Policies and Licenses
- Overview - Release Notes + Product Information Policies Licenses
From e692405f697db763b4f1ab3db784e626a9af1033 Mon Sep 17 00:00:00 2001 From: Felix Hennig Date: Fri, 20 Oct 2023 10:25:12 +0200 Subject: [PATCH 6/7] review --- modules/ROOT/pages/policies.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/policies.adoc b/modules/ROOT/pages/policies.adoc index 14cd4882c..c7725be8d 100644 --- a/modules/ROOT/pages/policies.adoc +++ b/modules/ROOT/pages/policies.adoc @@ -26,7 +26,7 @@ NOTE: This policy concerns releases of our platform as a whole and how long and We do releases of our Stackable Data Platform. These releases get a name based on the year and month they have been released in (e.g. `23.4`, `23.7`, also called https://calver.org/[CalVer]). This name does not follow Semantic Versioning (https://semver.org/[SemVer]). We may release patches for a release, which then follow the PATCH naming semantics of SemVer (e.g. `23.4.1`) or the _Micro_ name from CalVer. See below for our policy on patches for the SDP. -We support an SDP release for a specific time after its release. +We support an SDP release for a specific amount of time after its initial release. An SDP release contains our operators and other code developed at Stackable as well as the product docker images. From 2939a3fea2766e238956e811ce3bf0e2309ad10f Mon Sep 17 00:00:00 2001 From: Felix Hennig Date: Fri, 20 Oct 2023 10:26:15 +0200 Subject: [PATCH 7/7] Added TODO --- supplemental-ui/partials/navbar.hbs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/supplemental-ui/partials/navbar.hbs b/supplemental-ui/partials/navbar.hbs index d57dd8b11..9dd45c73a 100644 --- a/supplemental-ui/partials/navbar.hbs +++ b/supplemental-ui/partials/navbar.hbs @@ -40,8 +40,10 @@
Policies and Licenses
+ Product Information Policies + Licenses