diff --git a/asciidoc/edge-book/versions.adoc b/asciidoc/edge-book/versions.adoc index c878372b..3e18b846 100644 --- a/asciidoc/edge-book/versions.adoc +++ b/asciidoc/edge-book/versions.adoc @@ -1,5 +1,7 @@ +// NOTE - Generated by versions.adoc.j2, do not modify versions.adoc directly! + // ============================================================================ -:revdate: 2025-09-17 +:revdate: 2026-01-08 :page-revdate: {revdate} // Automatic Version Substitutions // @@ -10,11 +12,11 @@ // ============================================================================ // == General Edge == -:version-edge: 3.4 -:version-edge-registry: 3.4 +:version-edge: 3.5 +:version-edge-registry: 3.5 // == Multi-Linux Manager == -:version-mlm: 5.0.5 +:version-mlm: 5.0.6 // == Edge Image Builder == :version-eib: 1.3.0 @@ -24,20 +26,20 @@ // This is used in download URLs and filenames from upstream, so it must have // the leading "v". If needed, a separate version-kubevirt should be created // with simply the version number itself. -:version-kubevirt-release: v1.5.2 +:version-kubevirt-release: v0.6.0 // == Component Versions == -:version-rancher-prime: 2.12.1 -:version-cert-manager: 1.18.2 +:version-rancher-prime: 2.13.1 +:version-cert-manager: 1.19.2 :version-elemental-operator: 1.7.3 -:version-longhorn: 1.9.1 -:version-neuvector: 5.4.5 +:version-longhorn: 1.9.2 +:version-neuvector: 5.4.8 :version-kubevirt: 1.5.2 :version-endpoint-copier-operator: 0.3.0 -:version-suc: 0.16.0 -:version-nm-configurator: 0.3.4 -:version-fleet: 0.13.1 -:version-cdi: 1.62.0 +:version-suc: 0.17.0 +:version-nm-configurator: 0.3.5 +:version-fleet: 0.14.1 +:version-cdi: 0.6.0 :version-nvidia-device-plugin: 0.14.5 :version-kiwi-builder: 10.2.12.0 @@ -45,16 +47,16 @@ :version-nessie: 1.0.0 // == Non-Release Manifest Charts == -:version-suc-chart: 107.0.0 -:version-upgrade-controller-chart: 304.0.1+up0.1.1 +:version-suc-chart: 108.0.0 +:version-upgrade-controller-chart: 305.0.1+up0.1.1 :version-nvidia-device-plugin-chart: v0.14.5 // == Release Tags == :release-tag-eib: release-1.3 -:release-tag-edge-charts: release-3.4 -:release-tag-telco-cloud: release-3.4 -:release-tag-fleet-examples: release-3.4.0 -:release-tag-rancher: v2.12.1 +:release-tag-edge-charts: release-3.5 +:release-tag-telco-cloud: release-3.5 +:release-tag-fleet-examples: release-3.5.0 +:release-tag-rancher: v2.13.1 // ============================================================================ @@ -64,33 +66,33 @@ // and should not be renamed without thinking through the implications. // ============================================================================ -:version-kubernetes-k3s: v1.33.3+k3s1 -:version-kubernetes-rke2: v1.33.3+rke2r1 +:version-kubernetes-k3s: v1.34.2+k3s1 +:version-kubernetes-rke2: v1.34.2+rke2r1 :version-operatingsystem: 6.2 -:version-akri-chart: 304.0.0+up0.12.20 -:version-akri-dashboard-extension-chart: 304.0.2+up1.3.1 -:version-cdi-chart: 304.0.1+up0.6.0 -:version-elemental-operator-chart: 107.1.0+up1.7.3 -:version-elemental-operator-crds-chart: 107.1.0+up1.7.3 -:version-endpoint-copier-operator-chart: 304.0.1+up0.3.0 -:version-fleet-chart: 107.0.1+up0.13.1 -:version-kubevirt-chart: 304.0.1+up0.6.0 -:version-kubevirt-dashboard-extension-chart: 304.0.2+up1.3.2 -:version-longhorn-chart: 107.0.0+up1.9.1 -:version-longhorn-crd-chart: 107.0.0+up1.9.1 -:version-longhorn-docs: 1.9.1 -:version-metal3-chart: 304.0.16+up0.12.6 -:version-metallb-chart: 304.0.0+up0.14.9 -:version-neuvector-chart: 107.0.0+up2.8.7 -:version-neuvector-crd-chart: 107.0.0+up2.8.7 -:version-neuvector-dashboard-extension-chart: 2.1.3 -:version-rancher-chart: 2.12.1 +:version-akri-chart: 305.0.0+up0.12.20 +:version-akri-dashboard-extension-chart: 305.0.4+up1.3.2 +:version-cdi-chart: 305.0.1+up0.6.0 +:version-elemental-operator-chart: 1.7.3 +:version-elemental-operator-crds-chart: 1.7.3 +:version-endpoint-copier-operator-chart: 305.0.1+up0.3.0 +:version-fleet-chart: 108.0.1+up0.14.1 +:version-kubevirt-chart: 305.0.1+up0.6.0 +:version-kubevirt-dashboard-extension-chart: 305.0.4+up1.3.3 +:version-longhorn-chart: 108.1.0+up1.9.2 +:version-longhorn-crd-chart: 108.1.0+up1.9.2 +:version-longhorn-docs: 1.9.2 +:version-metal3-chart: 305.0.21+up0.13.0 +:version-metallb-chart: 305.0.1+up0.15.2 +:version-neuvector-chart: 108.0.1+up2.8.10 +:version-neuvector-crd-chart: 108.0.1+up2.8.10 +:version-neuvector-dashboard-extension-chart: 2.1.5 +:version-rancher-chart: 2.13.1 :version-rancher-turtles-chart: 304.0.6+up0.24.0 -:version-sriov-crd-chart: 304.0.2+up1.5.0 -:version-sriov-network-operator-chart: 304.0.2+up1.5.0 -:version-sriov-upstream: 1.5.0 +:version-sriov-crd-chart: %%CHART_MAJOR%%.0.4+up1.6.0 +:version-sriov-network-operator-chart: %%CHART_MAJOR%%.0.4+up1.6.0 +:version-sriov-upstream: 1.6.0 // capi-provider-metal3 // edu, Oct 9, 2025 :: Used to link the CRDs on the docs site like diff --git a/asciidoc/edge-book/versions.adoc.j2 b/asciidoc/edge-book/versions.adoc.j2 new file mode 100644 index 00000000..777d71b7 --- /dev/null +++ b/asciidoc/edge-book/versions.adoc.j2 @@ -0,0 +1,154 @@ +// NOTE - Generated by versions.adoc.j2, do not modify versions.adoc directly! +{% set release_manifest_edge_version = spec.releaseVersion %} +{%- set release_manifest_edge_version_short = spec.releaseVersion.split(".")[:2] | join(".") %} +{%- set release_manifest_rke2_version = spec.components.kubernetes.rke2.version %} +{%- set release_manifest_k3s_version = spec.components.kubernetes.k3s.version %} +{%- set release_manifest_slmicro_version = spec.components.operatingSystem.version %} +{%- set release_manifest_rancher_version = spec.components.workloads.helm | selectattr("releaseName", "equalto", "rancher") | map(attribute="version") | list | first %} +{%- set release_manifest_longhorn_version = spec.components.workloads.helm | selectattr("releaseName", "equalto", "longhorn") | map(attribute="version") | list | first %} +{%- set release_manifest_longhorn_crd_version = spec.components.workloads.helm | selectattr("releaseName", "equalto", "longhorn") | map(attribute="dependencyCharts") | first | map(attribute="version") | list | first %} +{%- set release_manifest_neuvector_version = spec.components.workloads.helm | selectattr("releaseName", "equalto", "neuvector") | map(attribute="version") | list | first %} +{%- set release_manifest_neuvector_crd_version = spec.components.workloads.helm | selectattr("releaseName", "equalto", "neuvector") | map(attribute="dependencyCharts") | first | map(attribute="version") | list | first %} +{%- set release_manifest_neuvector_dashboard_version = spec.components.workloads.helm | selectattr("releaseName", "equalto", "neuvector") | map(attribute="addonCharts") | first | map(attribute="version") | list | first | replace("%%CHART_MAJOR%%", release_manifest_chart_major) %} +{%- set release_manifest_chart_major = release_manifest_edge_version_short | replace(".", "0") %} +{%- set release_manifest_metallb_version = spec.components.workloads.helm | selectattr("releaseName", "equalto", "metallb") | map(attribute="version") | list | first | replace("%%CHART_MAJOR%%", release_manifest_chart_major) %} +{%- set release_manifest_eco_version = spec.components.workloads.helm | selectattr("releaseName", "equalto", "endpoint-copier-operator") | map(attribute="version") | list | first | replace("%%CHART_MAJOR%%", release_manifest_chart_major) %} +{%- set release_manifest_cdi_version = spec.components.workloads.helm | selectattr("releaseName", "equalto", "cdi") | map(attribute="version") | list | first | replace("%%CHART_MAJOR%%", release_manifest_chart_major) %} +{%- set release_manifest_akri_version = spec.components.workloads.helm | selectattr("releaseName", "equalto", "akri") | map(attribute="version") | list | first | replace("%%CHART_MAJOR%%", release_manifest_chart_major) %} +{%- set release_manifest_akri_dashboard_version = spec.components.workloads.helm | selectattr("releaseName", "equalto", "akri") | map(attribute="addonCharts") | first | map(attribute="version") | list | first | replace("%%CHART_MAJOR%%", release_manifest_chart_major) %} +{%- set release_manifest_metal3_version = spec.components.workloads.helm | selectattr("releaseName", "equalto", "metal3") | map(attribute="version") | list | first | replace("%%CHART_MAJOR%%", release_manifest_chart_major) %} +{%- set release_manifest_kubevirt_version = spec.components.workloads.helm | selectattr("releaseName", "equalto", "kubevirt") | map(attribute="version") | list | first | replace("%%CHART_MAJOR%%", release_manifest_chart_major) %} +{%- set release_manifest_kubevirt_dashboard_version = spec.components.workloads.helm | selectattr("releaseName", "equalto", "kubevirt") | map(attribute="addonCharts") | first | map(attribute="version") | list | first | replace("%%CHART_MAJOR%%", release_manifest_chart_major) %} +{%- set release_manifest_elemental_version = spec.components.workloads.helm | selectattr("releaseName", "equalto", "elemental-operator") | map(attribute="version") | list | first %} +{%- set release_manifest_elemental_crd_version = spec.components.workloads.helm | selectattr("releaseName", "equalto", "elemental-operator") | map(attribute="dependencyCharts") | first | map(attribute="version") | list | first %} +{%- set release_manifest_elemental_dashboard_version = spec.components.workloads.helm | selectattr("releaseName", "equalto", "elemental-operator") | map(attribute="addonCharts") | first | map(attribute="version") | list | first | replace("%%CHART_MAJOR%%", release_manifest_chart_major) %} +{%- set release_manifest_sriov_version = spec.components.workloads.helm | selectattr("releaseName", "equalto", "sriov-network-operator") | map(attribute="version") | list | first %} +{%- set release_manifest_sriov_crd_version = spec.components.workloads.helm | selectattr("releaseName", "equalto", "sriov-network-operator") | map(attribute="dependencyCharts") | first | map(attribute="version") | list | first %} +// ============================================================================ +:revdate: %%REVDATE%% +:page-revdate: {revdate} +// Automatic Version Substitutions +// +// The values in here are used throughout the documentation. Updating them here +// will propagate throughout the rest of the documentation. See the section at +// the bottom for details on versioning instances that cannot be handled in this +// fashion. +// ============================================================================ + +// == General Edge == +:version-edge: {{ release_manifest_edge_version_short }} +:version-edge-registry: {{ release_manifest_edge_version_short }} + +// == Multi-Linux Manager == +:version-mlm: 5.0.6 + +// == Edge Image Builder == +:version-eib: 1.3.0 +:version-eib-api-latest: 1.3 + +// KubeVirt +// This is used in download URLs and filenames from upstream, so it must have +// the leading "v". If needed, a separate version-kubevirt should be created +// with simply the version number itself. +:version-kubevirt-release: v{{ release_manifest_kubevirt_version .split("+up") | last }} + +// == Component Versions == +:version-rancher-prime: {{ release_manifest_rancher_version }} +:version-cert-manager: 1.19.2 +:version-elemental-operator: {{ release_manifest_elemental_version }} +:version-longhorn: {{ release_manifest_longhorn_version.split("+up") | last }} +:version-neuvector: 5.4.8 +:version-kubevirt: 1.5.2 +:version-endpoint-copier-operator: {{ release_manifest_eco_version.split("+up") | last }} +:version-suc: 0.17.0 +:version-nm-configurator: 0.3.5 +:version-fleet: 0.14.1 +:version-cdi: {{ release_manifest_cdi_version.split("+up") | last }} +:version-nvidia-device-plugin: 0.14.5 +:version-kiwi-builder: 10.2.12.0 + +// == Nessie == +:version-nessie: 1.0.0 + +// == Non-Release Manifest Charts == +:version-suc-chart: 108.0.0 +:version-upgrade-controller-chart: 305.0.1+up0.1.1 +:version-nvidia-device-plugin-chart: v0.14.5 + +// == Release Tags == +:release-tag-eib: release-1.3 +:release-tag-edge-charts: release-{{ release_manifest_edge_version_short }} +:release-tag-telco-cloud: release-{{ release_manifest_edge_version_short }} +:release-tag-fleet-examples: release-{{ release_manifest_edge_version }} +:release-tag-rancher: v{{ release_manifest_rancher_version }} + + +// ============================================================================ +// Release Manifest Versions +// +// The following are derived from the `releaseName` field of the release manifest +// and should not be renamed without thinking through the implications. +// ============================================================================ + +:version-kubernetes-k3s: {{ release_manifest_k3s_version }} +:version-kubernetes-rke2: {{ release_manifest_rke2_version }} + +:version-operatingsystem: {{ release_manifest_slmicro_version }} + +:version-akri-chart: {{ release_manifest_akri_version }} +:version-akri-dashboard-extension-chart: {{ release_manifest_akri_dashboard_version }} +:version-cdi-chart: {{ release_manifest_cdi_version }} +:version-elemental-operator-chart: {{ release_manifest_elemental_version }} +:version-elemental-operator-crds-chart: {{ release_manifest_elemental_crd_version }} +:version-endpoint-copier-operator-chart: {{ release_manifest_eco_version }} +:version-fleet-chart: 108.0.1+up0.14.1 +:version-kubevirt-chart: {{ release_manifest_kubevirt_version }} +:version-kubevirt-dashboard-extension-chart: {{ release_manifest_kubevirt_dashboard_version }} +:version-longhorn-chart: {{ release_manifest_longhorn_version }} +:version-longhorn-crd-chart: {{ release_manifest_longhorn_crd_version }} +:version-longhorn-docs: {{ release_manifest_longhorn_version.split("+up") | last }} +:version-metal3-chart: {{ release_manifest_metal3_version }} +:version-metallb-chart: {{ release_manifest_metallb_version }} +:version-neuvector-chart: {{ release_manifest_neuvector_version }} +:version-neuvector-crd-chart: {{ release_manifest_neuvector_crd_version }} +:version-neuvector-dashboard-extension-chart: {{ release_manifest_neuvector_dashboard_version }} +:version-rancher-chart: {{ release_manifest_rancher_version }} +:version-rancher-turtles-chart: 304.0.6+up0.24.0 +:version-sriov-crd-chart: {{ release_manifest_sriov_crd_version }} +:version-sriov-network-operator-chart: {{ release_manifest_sriov_version }} +:version-sriov-upstream: {{ release_manifest_sriov_version.split("+up") | last }} + +// capi-provider-metal3 +// edu, Oct 9, 2025 :: Used to link the CRDs on the docs site like +// https://doc.crds.dev/github.com/metal3-io/cluster-api-provider-metal3/infrastructure.cluster.x-k8s.io/Metal3MachineTemplate/v1beta1@v1.11.0#spec-template-spec-hostSelector-matchLabels +:version-capi-provider-metal3: v1beta1@v1.10.2 + +// ============================================================================ +// Derived Version Entries +// +// The following are derived from previously defined versions, ensure they +// are not using elements defined below them +// +// ============================================================================ + +// == SUSE Linux Micro == +:micro-base-image-raw: SL-Micro.x86_64-{version-operatingsystem}-Base-GM.raw +:micro-base-rt-image-raw: SL-Micro.x86_64-{version-operatingsystem}-Base-RT-GM.raw +:micro-base-rt-image-iso: SL-Micro.x86_64-{version-operatingsystem}-Base-RT-SelfInstall-GM.install.iso +:micro-base-image-iso: SL-Micro.x86_64-{version-operatingsystem}-Base-SelfInstall-GM.install.iso +:micro-default-image-iso: SL-Micro.x86_64-{version-operatingsystem}-Default-SelfInstall-GM.install.iso + + +// ============================================================================ +// Manual Version Entries +// +// The following files mention versions that cannot be handled through +// substitution. For example, EIB definitions that contain a list of +// images to embed. These files should be manually reviewed on a per-release +// basis to ensure accuracy. +// ============================================================================ + +// asciidoc/guides/air-gapped-eib-deployments.adoc +// asciidoc/product/atip-management-cluster.adoc +// asciidoc/product/atip-automated-provision.adoc +// asciidoc/edge-book/releasenotes.adoc diff --git a/scripts/.gitignore b/scripts/.gitignore new file mode 100644 index 00000000..84eeb693 --- /dev/null +++ b/scripts/.gitignore @@ -0,0 +1 @@ +_release_manifest.yaml diff --git a/scripts/README.md b/scripts/README.md new file mode 100644 index 00000000..dd75982e --- /dev/null +++ b/scripts/README.md @@ -0,0 +1,13 @@ +# SUSE Edge documentation scripts + +These scripts are used to simplify the maintenance of the documentation in this repo + + + +## Update release versions + +The `versions_update.sh` script updates the `versions.adoc` using data from the Factory `release_manifest.yaml` + +```bash +./versions_update.sh +``` diff --git a/scripts/versions_update.sh b/scripts/versions_update.sh new file mode 100755 index 00000000..62e8e86e --- /dev/null +++ b/scripts/versions_update.sh @@ -0,0 +1,18 @@ +#!/usr/bin/env bash + + + +set -eux + +RELEASE_BRANCH=${RELEASE_BRANCH_:-"main"} + +echo "Downloading release manifest for ${RELEASE_BRANCH} branch" +curl "https://src.opensuse.org/suse-edge/Factory/raw/branch/${RELEASE_BRANCH}/release-manifest-image/release_manifest.yaml" -o _release_manifest.yaml + +# Uses https://github.com/mattrobenolt/jinja2-cli - on mac `brew install jinja2-cli` +VERSIONS_TEMPLATE=${VERSIONS_TEMPLATE:-"../asciidoc/edge-book/versions.adoc.j2"} +VERSIONS_FILE=${VERSIONS_FILE:-"../asciidoc/edge-book/versions.adoc"} +# Generating ${VERSIONS_FILE} +jinja2 ${VERSIONS_TEMPLATE} _release_manifest.yaml | tee ${VERSIONS_FILE} +REVISION_DATE=$(date +%Y-%m-%d) +sed -i "s/%%REVDATE%%/${REVISION_DATE}/" ${VERSIONS_FILE}