Skip to content

Commit

Permalink
First 4.17 iteration (#103)
Browse files Browse the repository at this point in the history
Signed-off-by: Mario Vazquez <[email protected]>
  • Loading branch information
mvazquezc authored Nov 11, 2024
1 parent d5a29c6 commit ecd9162
Show file tree
Hide file tree
Showing 17 changed files with 97 additions and 99 deletions.
1 change: 1 addition & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ on:
- 'lab-4.14'
- 'lab-4.15'
- 'lab-4.16'
- 'lab-4.17'
env:
SITE_DIR: "gh-pages"
jobs:
Expand Down
2 changes: 1 addition & 1 deletion documentation/antora.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: 4.16
name: 4.17
title: LAB - 5G RAN Deployments on OpenShift
version: ~
nav:
Expand Down
122 changes: 61 additions & 61 deletions documentation/modules/ROOT/pages/_attributes.adoc
Original file line number Diff line number Diff line change
@@ -1,75 +1,75 @@
code:experimental:
:source-highlighter: highlightjs
:branch: lab-4.16
// :github-repo: https://github.com/RHsyseng/5g-ran-deployments-on-ocp-lab/blob/{branch}
:branch: lab-4.17
:repo_user: RHsyseng
:github-repo: https://github.com/{repo_user}/5g-ran-deployments-on-ocp-lab/blob/{branch}
:profile: 5g-ran-lab
:openshift-release: v4.16
:openshift-release: v4.17
:rds-link: https://docs.google.com/document/d/1qWUNGGaEEnzEF3hO0b00K1531YXQf0IxIUmq0FchB3I
:policygen-common-file: common-416.yaml
:policygen-common-label: ocp416
:lvms-channel: stable-4.16
:catalogsource-index-image-tag: v4.16-1723045275
:ztp-sitegenerate-disconnected-image: infra.5g-deployment.lab:8443/openshift4/ztp-site-generate-rhel8:v4.16.1-5
:example-sno-siteconfig-link: https://github.com/openshift-kni/cnf-features-deploy/blob/release-4.16/ztp/gitops-subscriptions/argocd/example/siteconfig/example-sno.yaml
:example-groupdu-policygen-link: https://github.com/openshift-kni/cnf-features-deploy/blob/release-4.16/ztp/gitops-subscriptions/argocd/example/policygentemplates/group-du-standard-ranGen.yaml
:reference-documentation: https://docs.openshift.com/container-platform/4.16/scalability_and_performance/ztp_far_edge/ztp-vdu-validating-cluster-tuning.html#ztp-du-firmware-config-reference_vdu-config-ref
:hub-cluster-ocp-version: v4.16.3
:policygen-common-file: common-417.yaml
:policygen-common-label: ocp417
:lvms-channel: stable-4.17
:catalogsource-index-image-tag: v4.17-1731286606
:ztp-sitegenerate-disconnected-image: infra.5g-deployment.lab:8443/openshift4/ztp-site-generate-rhel8:v4.17.0-25
:example-sno-siteconfig-link: https://github.com/openshift-kni/cnf-features-deploy/blob/release-4.17/ztp/gitops-subscriptions/argocd/example/siteconfig/example-sno.yaml
:example-groupdu-policygen-link: https://github.com/openshift-kni/cnf-features-deploy/blob/release-4.17/ztp/gitops-subscriptions/argocd/example/policygentemplates/group-du-standard-ranGen.yaml
:reference-documentation: https://docs.openshift.com/container-platform/4.17/edge_computing/ztp-vdu-validating-cluster-tuning.html#ztp-du-firmware-config-reference_vdu-config-ref
:hub-cluster-ocp-version: v4.17.4
:hub-cluster-kubeversion: v1.29.6+aba1e8d
:sno-cluster-version1: v4.16.0
:sno-cluster-version2: v4.16.3
:sno-cluster-version1: v4.17.3
:sno-cluster-version2: v4.17.4
:sno-cluster-version1-kubeversion: v1.29.5+29c95f3
:sno-cluster-version2-kubeversion: v1.29.6+aba1e8d
:sno-cluster-version1-cvo: 4.16.0
:sno-cluster-version2-cvo: 4.16.3
:sno-cluster-version1-cvo: 4.17.3
:sno-cluster-version2-cvo: 4.17.4
:active-ocp-version-clusterimageset: infra.5g-deployment.lab:8443/openshift/release-images:{sno-cluster-version1-cvo}-x86_64
:talm-update-file: zone-europe-upgrade-416-3.yaml
:talm-update-channel: stable-4.16
:talm-update-version: 4.16.3
// oc adm release info 4.16.3 | grep "Pull From"
:talm-update-image: infra.5g-deployment.lab:8443/openshift/release-images@sha256:3ec3a43ded1decc18134e5677f56037d8929f4442930f5d1156e7a77cdf1b9b3
:talm-update-policy-name: version-416-3
:rhacm-version: v2.11
:rhacm-template-processing: https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/governance/governance#template-processing
:mce-version: v2.6
:policygentool-version: v4.16
:kcli-tools-tag: 4.16
:talm-update-file: zone-europe-upgrade-417-4.yaml
:talm-update-channel: stable-4.17
:talm-update-version: 4.17.4
:lab-major-version: 4.17
// oc adm release info 4.17.4 | grep "Pull From"
:talm-update-image: infra.5g-deployment.lab:8443/openshift/release-images@sha256:bada2d7626c8652e0fb68d3237195cb37f425e960347fbdd747beb17f671cf13
:talm-update-policy-name: version-417-4
:rhacm-version: v2.12
:rhacm-template-processing: https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.12/html/governance/governance#template-processing
:mce-version: v2.7
:policygentool-version: v4.17
:kcli-tools-tag: 4.17
:kcli-rpm: https://github.com/{repo_user}/5g-ran-deployments-on-ocp-lab/raw/{branch}/lab-materials/kcli-rpm/kcli-99.0.0.git.202409091407.2293cfe-0.el9.x86_64.rpm
:rhcos-rootfs-url: https://mirror.openshift.com/pub/openshift-v4/x86_64/dependencies/rhcos/4.16/4.16.0/rhcos-4.16.0-x86_64-live-rootfs.x86_64.img
:rhcos-rootfs-filename: rhcos-4.16.0-x86_64-live-rootfs.x86_64.img
:rhcos-liveiso-url: https://mirror.openshift.com/pub/openshift-v4/x86_64/dependencies/rhcos/4.16/4.16.0/rhcos-4.16.0-x86_64-live.x86_64.iso
:rhcos-liveiso-filename: rhcos-4.16.0-x86_64-live.x86_64.iso
:disconnected-registry-docs: https://docs.openshift.com/container-platform/4.16/installing/disconnected_install/installing-mirroring-disconnected.html
:openshift-gitops-docs: https://docs.openshift.com/gitops/1.13/understanding_openshift_gitops/about-redhat-openshift-gitops.html
:cnf-features-source-crs: https://github.com/openshift-kni/cnf-features-deploy/tree/release-4.16/ztp/source-crs
:cnf-features-siteconfig-gen: https://github.com/openshift-kni/cnf-features-deploy/tree/release-4.16/ztp/siteconfig-generator
:cnf-features-policy-gen: https://github.com/openshift-kni/cnf-features-deploy/tree/release-4.16/ztp/policygenerator
:cnf-features-clustersgo: https://github.com/openshift-kni/cnf-features-deploy/blob/release-4.16/ztp/siteconfig-generator/siteConfig/clusterCRsV1.go
:cnf-features-siteconfig-plugin: https://github.com/openshift-kni/cnf-features-deploy/tree/release-4.16/ztp/siteconfig-generator-kustomize-plugin
:cnf-features-policygen-plugin: https://github.com/openshift-kni/cnf-features-deploy/tree/release-4.16/ztp/policygenerator-kustomize-plugin
:rhacm-governance-doc: https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/governance/governance
:ocp-cli-docs: https://docs.openshift.com/container-platform/4.16/cli_reference/openshift_cli/getting-started-cli.html
:sno-preparing-docs: https://docs.openshift.com/container-platform/4.16/installing/installing_sno/install-sno-preparing-to-install-sno.html#install-sno-requirements-for-installing-on-a-single-node_install-sno-preparing
:sno-installing-docs: https://docs.openshift.com/container-platform/4.16/installing/installing_sno/install-sno-installing-sno.html#installing-single-node-openshift-using-the-assisted-installer
:sno-install-manually-docs: https://docs.openshift.com/container-platform/4.16/installing/installing_sno/install-sno-installing-sno.html#install-sno-installing-sno-manually
:talm-recovery-from-failed-upgrade-doc: https://docs.openshift.com/container-platform/4.16/scalability_and_performance/ztp_far_edge/cnf-talm-for-cluster-upgrades.html#talo-backup-recovery_cnf-topology-aware-lifecycle-manager
:talm-cluster-upgrades-doc: https://docs.openshift.com/container-platform/4.16/scalability_and_performance/ztp_far_edge/cnf-talm-for-cluster-upgrades.html
:rhcos-rootfs-url: https://mirror.openshift.com/pub/openshift-v4/dependencies/rhcos/4.17/4.17.0/rhcos-4.17.0-x86_64-live-rootfs.x86_64.img
:rhcos-rootfs-filename: rhcos-4.17.0-x86_64-live-rootfs.x86_64.img
:rhcos-liveiso-url: https://mirror.openshift.com/pub/openshift-v4/dependencies/rhcos/4.17/4.17.0/rhcos-4.17.0-x86_64-live.x86_64.iso
:rhcos-liveiso-filename: rhcos-4.17.0-x86_64-live.x86_64.iso
:disconnected-registry-docs: https://docs.openshift.com/container-platform/4.17/disconnected/mirroring/installing-mirroring-disconnected.html
:openshift-gitops-docs: https://docs.openshift.com/gitops/1.14/understanding_openshift_gitops/about-redhat-openshift-gitops.html
:cnf-features-source-crs: https://github.com/openshift-kni/cnf-features-deploy/tree/release-4.17/ztp/source-crs
:cnf-features-siteconfig-gen: https://github.com/openshift-kni/cnf-features-deploy/tree/release-4.17/ztp/siteconfig-generator
:cnf-features-policy-gen: https://github.com/openshift-kni/cnf-features-deploy/tree/release-4.17/ztp/policygenerator
:cnf-features-clustersgo: https://github.com/openshift-kni/cnf-features-deploy/blob/release-4.17/ztp/siteconfig-generator/siteConfig/clusterCRsV1.go
:cnf-features-siteconfig-plugin: https://github.com/openshift-kni/cnf-features-deploy/tree/release-4.17/ztp/siteconfig-generator-kustomize-plugin
:cnf-features-policygen-plugin: https://github.com/openshift-kni/cnf-features-deploy/tree/release-4.17/ztp/policygenerator-kustomize-plugin
:rhacm-governance-doc: https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.12/html/governance/governance
:ocp-cli-docs: https://docs.openshift.com/container-platform/4.17/cli_reference/openshift_cli/getting-started-cli.html
:sno-preparing-docs: https://docs.openshift.com/container-platform/4.17/installing/installing_sno/install-sno-preparing-to-install-sno.html#install-sno-requirements-for-installing-on-a-single-node_install-sno-preparing
:sno-installing-docs: https://docs.openshift.com/container-platform/4.17/installing/installing_sno/install-sno-installing-sno.html#installing-single-node-openshift-using-the-assisted-installer
:sno-install-manually-docs: https://docs.openshift.com/container-platform/4.17/installing/installing_sno/install-sno-installing-sno.html#install-sno-installing-sno-manually
:talm-recovery-from-failed-upgrade-doc: https://docs.openshift.com/container-platform/4.17/scalability_and_performance/ztp_far_edge/cnf-talm-for-cluster-upgrades.html#talo-backup-recovery_cnf-topology-aware-lifecycle-manager
:talm-cluster-upgrades-doc: https://docs.openshift.com/container-platform/4.17/scalability_and_performance/ztp_far_edge/cnf-talm-for-cluster-upgrades.html
:talm-upstream-project: https://github.com/openshift-kni/cluster-group-upgrades-operator
:talm-precachingconfig-doc: https://docs.openshift.com/container-platform/4.16/scalability_and_performance/ztp_far_edge/ztp-talm-updating-managed-policies.html#talm-prechache-user-specified-images-concept_ztp-talm
:workload-hints-doc: https://docs.openshift.com/container-platform/4.16/scalability_and_performance/cnf-low-latency-tuning.html#cnf-understanding-workload-hints_cnf-master
:ztp-gitops-docs: https://docs.openshift.com/container-platform/4.16/scalability_and_performance/ztp_far_edge/ztp-preparing-the-hub-cluster.html#installing-disconnected-rhacm_ztp-preparing-the-hub-cluster
:nto-docs: https://docs.openshift.com/container-platform/4.16/scalability_and_performance/using-node-tuning-operator.html
:sriov-docs: https://docs.openshift.com/container-platform/4.16/networking/hardware_networks/about-sriov.html
:sriov-supported-nics: https://docs.openshift.com/container-platform/4.16/networking/hardware_networks/about-sriov.html#supported-devices_about-sriov
:ptp-docs: https://docs.openshift.com/container-platform/4.16/networking/ptp/about-ptp.html
:workload-partitioning-docs: https://docs.openshift.com/container-platform/4.16/scalability_and_performance/enabling-workload-partitioning.html
:advanced-ztp-policy-config: https://docs.openshift.com/container-platform/4.16/edge_computing/policygentemplate_for_ztp/ztp-advanced-policy-config.html#ztp-adding-new-content-to-gitops-ztp_ztp-advanced-policy-config
:ztp-precaching-config-docs: https://docs.openshift.com/container-platform/4.16/edge_computing/policygentemplate_for_ztp/ztp-talm-updating-managed-policies.html#talm-prechache-user-specified-images-concept_ztp-talm
:talm-precachingconfig-doc: https://docs.openshift.com/container-platform/4.17/edge_computing/policygenerator_for_ztp/ztp-talm-updating-managed-policies-pg.html#talm-prechache-user-specified-images-concept_ztp-talm-pg
:workload-hints-doc: https://docs.openshift.com/container-platform/4.17/scalability_and_performance/cnf-low-latency-tuning.html#cnf-understanding-workload-hints_cnf-master
:ztp-gitops-docs: https://docs.openshift.com/container-platform/4.17/edge_computing/ztp-preparing-the-hub-cluster.html#installing-disconnected-rhacm_ztp-preparing-the-hub-cluster
:nto-docs: https://docs.openshift.com/container-platform/4.17/scalability_and_performance/using-node-tuning-operator.html
:sriov-docs: https://docs.openshift.com/container-platform/4.17/networking/hardware_networks/about-sriov.html
:sriov-supported-nics: https://docs.openshift.com/container-platform/4.17/networking/hardware_networks/about-sriov.html#supported-devices_about-sriov
:ptp-docs: https://docs.openshift.com/container-platform/4.17/networking/ptp/about-ptp.html
:workload-partitioning-docs: https://docs.openshift.com/container-platform/4.17/scalability_and_performance/enabling-workload-partitioning.html
:advanced-ztp-policy-config: https://docs.openshift.com/container-platform/4.17/edge_computing/policygentemplate_for_ztp/ztp-advanced-policy-config.html#ztp-adding-new-content-to-gitops-ztp_ztp-advanced-policy-config
:ztp-precaching-config-docs: https://docs.openshift.com/container-platform/4.17/edge_computing/policygentemplate_for_ztp/ztp-talm-updating-managed-policies.html#talm-prechache-user-specified-images-concept_ztp-talm
:ssh-pub-key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQC5pFKFLOuxrd9Q/TRu9sRtwGg2PV+kl2MHzBIGUhCcR0LuBJk62XG9tQWPQYTQ3ZUBKb6pRTqPXg+cDu5FmcpTwAKzqgUb6ArnjECxLJzJvWieBJ7k45QzhlZPeiN2Omik5bo7uM/P1YIo5pTUdVk5wJjaMOb7Xkcmbjc7r22xY54cce2Wb7B1QDtLWJkq++eJHSX2GlEjfxSlEvQzTN7m2N5pmoZtaXpLKcbOqtuSQSVKC4XPgb57hgEs/ZZy/LbGGHZyLAW5Tqfk1JCTFGm6Q+oOd3wAOF1SdUxM7frdrN3UOB12u/E6YuAx3fDvoNZvcrCYEpjkfrsjU91oz78aETZV43hOK9NWCOhdX5djA7G35/EMn1ifanVoHG34GwNuzMdkb7KdYQUztvsXIC792E2XzWfginFZha6kORngokZ2DwrzFj3wgvmVyNXyEOqhwi6LmlsYdKxEvUtiYhdISvh2Y9GPrFcJ5DanXe7NVAKXe5CyERjBnxWktqAPBzXJa36FKIlkeVF5G+NWgufC6ZWkDCD98VZDiPP9sSgqZF8bSR4l4/vxxAW4knKIZv11VX77Sa1qZOR9Ml12t5pNGT7wDlSOiDqr5EWsEexga/2s/t9itvfzhcWKt+k66jd8tdws2dw6+8JYJeiBbU63HBjxCX+vCVZASrNBjiXhFw==
:aap-docs: https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/2.4/
:aap-hub-docs: https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/2.4/html/deploying_the_red_hat_ansible_automation_platform_operator_on_openshift_container_platform/installing-hub-operator
:aap-controller-docs: https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/2.4/html/deploying_the_red_hat_ansible_automation_platform_operator_on_openshift_container_platform/installing-controller-operator
:aap-get-manifest-docs: https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/2.4/html/red_hat_ansible_automation_platform_operations_guide/assembly-aap-obtain-manifest-files
:aap-docs: https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/2.5/
:aap-hub-docs: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/installing_on_openshift_container_platform/installing-hub-operator
:aap-controller-docs: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/installing_on_openshift_container_platform/installing-controller-operator
:aap-get-manifest-docs: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/access_management_and_authentication/assembly-gateway-licensing#assembly-aap-obtain-manifest-files
:sriov-channel: stable
:last-update-date: 2024-09-12
:last-update-date: 2024-11-11
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ If you require cluster configuration changes outside of the base GitOps Zero Tou

WARNING: We recommend a directory structure to keep reference manifests corresponding to the y-stream release.

In this lab we do not need extra content, however we are going to pave the way for future requirements. Let's first extract the predefined source-crs from the ztp-generate container 4.16 version to the reference-crs folder.
In this lab we do not need extra content, however we are going to pave the way for future requirements. Let's first extract the predefined source-crs from the ztp-generate container {lab-major-version} version to the reference-crs folder.

[.console-input]
[source,bash,subs="attributes+,+macros"]
Expand Down
12 changes: 6 additions & 6 deletions documentation/modules/ROOT/pages/crafting-deployments-iac.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ As we saw in a previous section, the Git repository we will be using will have t
│ ├── hub-1
| | └── extra-manifest
| | └── reference-manifest
| | | └── 4.16
| | | └── {lab-major-version}
│ ├── pre-reqs
│ │ └── sno2
│ └── resources
Expand All @@ -83,9 +83,9 @@ IMPORTANT: The cluster name for the SNO that we will be deploying in the lab wil
[source,bash,subs="attributes+,+macros"]
-----
cd ~/5g-deployment-lab/ztp-repository/
mkdir -p site-configs/{hub-1,resources,pre-reqs/sno2,hub-1/extra-manifest,reference-manifest/4.16}
mkdir -p site-configs/{hub-1,resources,pre-reqs/sno2,hub-1/extra-manifest,reference-manifest/{lab-major-version}}
mkdir -p site-policies/{fleet/active/source-crs/reference-crs,fleet/active/source-crs/custom-crs,fleet/testing,sites/hub-1}
touch site-configs/{hub-1,resources,pre-reqs/sno2,hub-1/extra-manifest,reference-manifest/4.16}/.gitkeep
touch site-configs/{hub-1,resources,pre-reqs/sno2,hub-1/extra-manifest,reference-manifest/{lab-major-version}}/.gitkeep
touch site-policies/{fleet/active/source-crs/reference-crs,fleet/active/source-crs/custom-crs,fleet/testing,sites/hub-1}/.gitkeep
git add --all
git commit -m 'Initialized repo structure'
Expand Down Expand Up @@ -214,7 +214,7 @@ spec:
extraManifests:
searchPaths:
- hub-1/extra-manifest/
- reference-manifest/4.16/
- reference-manifest/{lab-major-version}/
# Cluster labels (this will be used by RHACM)
clusterLabels:
common: "{policygen-common-label}"
Expand Down Expand Up @@ -291,15 +291,15 @@ EOF
[#reference-manifest-siteconfig]
=== Reference Manifest Configuration

Let's add the reference RAN configuration for the version of OCP we are about to deploy. In the workstation, run the following command to extract the reference ZTP 4.16 RAN configuration. Notice that `reference-manifest/4.16/` refers to the Git subdirectory that stores the contents of the RAN configuration for a specific version . This configuration is applied during installation. Those manifests are extracted from the `/extra-manifest` folder of the ztp-site-generate container.
Let's add the reference RAN configuration for the version of OCP we are about to deploy. In the workstation, run the following command to extract the reference ZTP {lab-major-version} RAN configuration. Notice that `reference-manifest/{lab-major-version}/` refers to the Git subdirectory that stores the contents of the RAN configuration for a specific version . This configuration is applied during installation. Those manifests are extracted from the `/extra-manifest` folder of the ztp-site-generate container.

WARNING: If you get `ERRO[0000] running `/usr/bin/newuidmap 51706 0 1000 1 1 100000 65536`: newuidmap: write to uid_map failed: Operation not permitted` when running podman commands, run them with sudo.

[.console-input]
[source,bash,subs="attributes+,+macros"]
-----
podman login infra.5g-deployment.lab:8443 -u admin -p r3dh4t1! --tls-verify=false
podman run --log-driver=none --rm --tls-verify=false {ztp-sitegenerate-disconnected-image} extract /home/ztp/extra-manifest --tar | tar x -C ~/5g-deployment-lab/ztp-repository/site-configs/reference-manifest/4.16/
podman run --log-driver=none --rm --tls-verify=false {ztp-sitegenerate-disconnected-image} extract /home/ztp/extra-manifest --tar | tar x -C ~/5g-deployment-lab/ztp-repository/site-configs/reference-manifest/{lab-major-version}/
-----

Our recommendation is to always create a reference and keep the reference and user defined manifests (see next section) separately. This makes later updates to the reference based on z-stream releases significantly easier (simply replace the contents of reference-manifests with updated content)
Expand Down
Loading

0 comments on commit ecd9162

Please sign in to comment.