Skip to content

Commit 9b2ef29

Browse files
committed
AI: fixed underscore section IDs
1 parent 693a1ae commit 9b2ef29

6 files changed

Lines changed: 27 additions & 27 deletions

ai-prompts/Import-Rancher-docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ Convert `xref:` calls that point to a relative path into external `link:` calls.
2222

2323
* Derive the new URL by appending the relative path to the base URL found in the file's top comment.
2424
* Replace the `.adoc` file extension with `.html`.
25-
* Match cross references that start with underline such as '_features_for_all_registered_clusters' with the right section by its name and prepend the section with corresponding ID such as [#_features_for_all_registered_clusters]
25+
* Match cross references that start with underline such as 'features-for-all-registered-clusters' with the right section by its name and prepend the section with corresponding ID such as [#features-for-all-registered-clusters]

tasks/NVIDIA-Operator-installation.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ endif::[]
2828
:override-abstract!:
2929
:override-title!:
3030

31-
[#_host_os_requirements]
31+
[#host-os-requirements]
3232
== Host OS requirements
3333

3434
To expose the GPU to the pod correctly, the NVIDIA kernel drivers and the `libnvidia-ml` library must be correctly installed in the host OS. The NVIDIA Operator can automatically install drivers and libraries on some operating systems. Refer to the NVIDIA documentation for information on https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/latest/platform-support.html#supported-operating-systems-and-kubernetes-platforms[supported operating system releases]. The installation of the NVIDIA components on your host OS is out of the scope of this documentation, refer to the NVIDIA documentation for instructions.
@@ -119,7 +119,7 @@ After one minute approximately, you can perform the following checks to verify t
119119
kubectl get node $NODENAME -o jsonpath='{.metadata.labels}' | grep "nvidia.com/gpu.deploy.driver"
120120
----
121121
+
122-
You should see the value `pre-installed`. If you see `true`, the drivers were not correctly installed. If the <<_host_os_requirements,pre-requirements>> were correct, it is possible that you forgot to reboot the node after installing all packages.
122+
You should see the value `pre-installed`. If you see `true`, the drivers were not correctly installed. If the <<host-os-requirements,pre-requirements>> were correct, it is possible that you forgot to reboot the node after installing all packages.
123123
+
124124
You can also check other driver labels with:
125125
+

tasks/Rancher-installation-airgapped-kubernetes.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The steps to set up an air-gapped Kubernetes cluster on RKE2 or K3s are shown be
3737
--
3838
In this guide, we are assuming you have created your nodes in your air-gapped environment and have a secure Docker private registry on your bastion server.
3939

40-
[#_1_create_rke2_configuration]
40+
[#create-rke2-configuration]
4141
== 1. Create RKE2 configuration
4242

4343
Create the `config.yaml` file at `/etc/rancher/rke2/config.yaml`. This will contain all the configuration options necessary to create a highly available RKE2 cluster.
@@ -67,7 +67,7 @@ For more information, refer to the https://documentation.suse.com/cloudnative/rk
6767
RKE2 additionally provides a `resolv-conf` option for kubelets, which may help with configuring DNS in air-gap networks.
6868
====
6969

70-
[[_2_create_registry_yaml]]
70+
[[create-registry-yaml]]
7171
== 2. Create Registry YAML
7272

7373
Create the `registries.yaml` file at `/etc/rancher/rke2/registries.yaml`. This will tell RKE2 the necessary details to connect to your private registry.
@@ -94,7 +94,7 @@ configs:
9494
For more information on private registries configuration file for RKE2, refer to the https://documentation.suse.com/cloudnative/rke2/latest/en/install/containerd_registry_configuration.html[RKE2 documentation.]
9595

9696

97-
[[_3_install_rke2]]
97+
[[install-rke2]]
9898
== 3. Install RKE2
9999

100100
Rancher needs to be installed on a supported Kubernetes version. To find out which versions of Kubernetes are supported for your Rancher version, refer to the link:https://www.suse.com/suse-rancher/support-matrix/all-supported-versions/[SUSE Rancher Support Matrix].
@@ -124,7 +124,7 @@ systemctl start rke2-server.service
124124

125125
For more information, refer to the https://documentation.suse.com/cloudnative/rke2/latest/en/install/airgap.html[RKE2 documentation].
126126

127-
[[_4_save_and_start_using_the_kubeconfig_file]]
127+
[[save-and-start-using-the-kubeconfig-file]]
128128
== 4. Save and Start Using the kubeconfig File
129129

130130
When you installed RKE2 on each Rancher server node, a `kubeconfig` file was created on the node at `/etc/rancher/rke2/rke2.yaml`. This file contains credentials for full access to the cluster, and you should save this file in a secure location.
@@ -165,7 +165,7 @@ kubectl --kubeconfig ~/.kube/config/rke2.yaml get pods --all-namespaces
165165

166166
For more information about the `kubeconfig` file, refer to the https://documentation.suse.com/cloudnative/rke2/latest/en/cluster_access.html[RKE2 documentation] or the https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/[official Kubernetes documentation] about organizing cluster access using `kubeconfig` files.
167167

168-
[#_note_on_upgrading]
168+
[#note-on-upgrading]
169169
== Note on Upgrading
170170

171171
Upgrading an air-gap environment can be accomplished in the following manner:

tasks/Rancher-installation-airgapped-rancher.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ helm fetch rancher-prime/rancher --version=<version>
6868
----
6969

7070
=== 2. Choose your SSL Configuration
71-
[[_2_choose_your_ssl_configuration]]
71+
[[choose-your-ssl-configuration]]
7272

7373
The {ranchermanager} server is designed to be secure by default and requires SSL/TLS configuration.
7474

@@ -119,7 +119,7 @@ When setting up the Rancher Helm template, there are several options in the Helm
119119

120120
=== 3. Fetch the Cert-Manager Chart
121121

122-
Based on the choice your made in <<_2_choose_your_ssl_configuration,2. Choose your SSL Configuration>>, complete one of the procedures below.
122+
Based on the choice your made in <<choose-your-ssl-configuration,2. Choose your SSL Configuration>>, complete one of the procedures below.
123123

124124
==== Option A: Default Self-Signed Certificate
125125

tasks/Rancher-installation-quickstart.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,17 +118,17 @@ There are three recommended options for the source of the certificate used for T
118118

119119
| Rancher Generated Certificates (Default)
120120
| `ingress.tls.source=rancher`
121-
| <<_4_install_cert_manager,yes>>
121+
| <<install-cert-manager,yes>>
122122

123123
| Let's Encrypt
124124
| `ingress.tls.source=letsEncrypt`
125-
| <<_4_install_cert_manager,yes>>
125+
| <<install-cert-manager,yes>>
126126

127127
| Certificates from Files
128128
| `ingress.tls.source=secret`
129129
| no
130130
|===
131-
[#_4_install_cert_manager]
131+
[#install-cert-manager]
132132
=== 4. Install cert-manager
133133

134134
____

tasks/Rancher-register-clusters.adoc

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ endif::[]
2727

2828
The cluster registration feature replaced the feature to import clusters.
2929

30-
The control that Rancher has to manage a registered cluster depends on the type of cluster. For details, see <<_management_capabilities_for_registered_clusters,Management Capabilities for Registered Clusters.>>
30+
The control that Rancher has to manage a registered cluster depends on the type of cluster. For details, see <<management-capabilities-for-registered-clusters,Management Capabilities for Registered Clusters.>>
3131

3232
== Prerequisites
3333

@@ -81,7 +81,7 @@ endif::[]
8181
. If you are importing a generic Kubernetes cluster in Rancher, perform the following steps for setup:
8282
.. Click **Agent Environment Variables** under **Cluster Options** to set environment variables for link:https://documentation.suse.com/cloudnative/rancher-manager/v2.13/en/cluster-deployment/about-rancher-agents.html[rancher cluster agent]. The environment variables can be set using key value pairs. If rancher agent requires use of proxy to communicate with Rancher server, `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables can be set using agent environment variables.
8383
.. Enable Project Network Isolation to ensure the cluster supports Kubernetes `NetworkPolicy` resources. Users can select the **Project Network Isolation** option under the **Advanced Options** dropdown to do so.
84-
.. <<_configuring_version_management_for_suse_rancher_prime_rke2_and_suse_rancher_prime_k3s_clusters,Configure the version management feature for imported RKE2 and K3s clusters>>.
84+
.. <<configuring-version-management-for-suse-rancher-prime-rke2-and-suse-rancher-prime-k3s-clusters,Configure the version management feature for imported RKE2 and K3s clusters>>.
8585
. Click *Create*.
8686
. The prerequisite for `cluster-admin` privileges is shown (see *Prerequisites* above), including an example command to fulfil the prerequisite.
8787
. Copy the `kubectl` command to your clipboard and run it on a node where kubeconfig is configured to point to the cluster you want to import. If you are unsure it is configured correctly, run `kubectl get nodes` to verify before running the command shown in Rancher.
@@ -149,21 +149,21 @@ resource "rancher2_cluster" "my-eks-to-import" {
149149

150150
You can find additional examples for other cloud providers in the https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster[Rancher2 Terraform Provider documentation].
151151

152-
[#_management_capabilities_for_registered_clusters]
152+
[#management-capabilities-for-registered-clusters]
153153
== Management Capabilities for Registered Clusters
154154

155155
The control that Rancher has to manage a registered cluster depends on the type of cluster.
156156

157-
* <<_features_for_all_registered_clusters,Features for All Registered Clusters>>
158-
* <<_additional_features_for_registered_rke2_and_k3s_clusters,Additional Features for Registered RKE2 and K3s Clusters>>
157+
* <<features-for-all-registered-clusters,Features for All Registered Clusters>>
158+
* <<additional-features-for-registered-rke2-and-k3s-clusters,Additional Features for Registered RKE2 and K3s Clusters>>
159159
ifeval::["{build-type}" != "srfa"]
160-
* <<_additional_features_for_registered_eks_aks_and_gke_clusters,Additional Features for Registered EKS, AKS and GKE Clusters>>
160+
* <<additional-features-for-registered-eks-aks-and-gke-clusters,Additional Features for Registered EKS, AKS and GKE Clusters>>
161161
endif::[]
162162
ifeval::["{build-type}" == "srfa"]
163163
* <<_additional_features_for_registered_eks_clusters,Additional Features for Registered EKS Clusters>>
164164
endif::[]
165165

166-
[#_features_for_all_registered_clusters]
166+
[#features-for-all-registered-clusters]
167167
=== Features for All Registered Clusters
168168

169169
After registering a cluster, the cluster owner can:
@@ -174,23 +174,23 @@ After registering a cluster, the cluster owner can:
174174
* Enable link:https://documentation.suse.com/cloudnative/rancher-manager/v2.13/en/observability/istio/istio.html[Istio]
175175
* Manage projects and workloads
176176

177-
[#_additional_features_for_registered_rke2_and_k3s_clusters]
177+
[#additional-features-for-registered-rke2-and-k3s-clusters]
178178
=== Additional Features for Registered {rke2} and {k3s} Clusters
179179

180180
https://documentation.suse.com/cloudnative/k3s/latest/en/introduction.html[K3s] is a lightweight, fully compliant Kubernetes distribution for edge installations.
181181

182182
https://documentation.suse.com/cloudnative/rke2/latest/en/introduction.html[RKE2] is Rancher's next-generation Kubernetes distribution for datacenter and cloud installations.
183183

184184
When an RKE2 or K3s cluster is registered in Rancher, Rancher will recognize it.
185-
The Rancher UI will expose features available to <<_features_for_all_registered_clusters,all registered clusters>>, along with the following options for editing and upgrading the cluster:
185+
The Rancher UI will expose features available to <<features-for-all-registered-clusters,all registered clusters>>, along with the following options for editing and upgrading the cluster:
186186

187-
* Enable or disable <<_configuring_version_management_for_suse_rancher_prime_rke2_and_suse_rancher_prime_k3s_clusters,version management>>
187+
* Enable or disable <<configuring-version-management-for-suse-rancher-prime-rke2-and-suse-rancher-prime-k3s-clusters,version management>>
188188
* link:https://documentation.suse.com/cloudnative/rancher-manager/v2.13/en/cluster-admin/backups-and-restore/backups-and-restore.html[Upgrade the Kubernetes version] when version management is enabled
189-
* Configure the <<_configuring_suse_rancher_prime_rke2_and_suse_rancher_prime_k3s_cluster_upgrades,upgrade strategy>> when version management is enabled
189+
* Configure the <<configuring-suse-rancher-prime-rke2-and-suse-rancher-prime-k3s-cluster-upgrades,upgrade strategy>> when version management is enabled
190190
* View a read-only version of the cluster’s configuration arguments and environment variables used to launch each node
191191

192192
ifeval::["{build-type}" != "srfa"]
193-
[#_additional_features_for_registered_eks_aks_and_gke_clusters]
193+
[#additional-features-for-registered-eks-aks-and-gke-clusters]
194194
=== Additional Features for Registered EKS, AKS, and GKE Clusters
195195

196196
Rancher handles registered EKS, AKS, or GKE clusters similarly to clusters created in Rancher. However, Rancher doesn't destroy registered clusters when you delete them through the Rancher UI.
@@ -209,7 +209,7 @@ endif::[]
209209

210210
See link:https://documentation.suse.com/cloudnative/rancher-manager/v2.13/en/cluster-deployment/cluster-deployment.html[Cluster Management Capabilities by Cluster Type] for more information about what features are available for managing registered clusters.
211211

212-
[#_configuring_version_management_for_suse_rancher_prime_rke2_and_suse_rancher_prime_k3s_clusters]
212+
[#configuring-version-management-for-suse-rancher-prime-rke2-and-suse-rancher-prime-k3s-clusters]
213213
== Configuring Version Management for {rke2} and {k3s} Clusters
214214

215215
[WARNING]
@@ -233,7 +233,7 @@ If version management is enabled for a cluster, Rancher will deploy the `system-
233233
If version management is disabled, Rancher will remove these components from the cluster.
234234
====
235235

236-
[#_configuring_suse_rancher_prime_rke2_and_suse_rancher_prime_k3s_cluster_upgrades]
236+
[#configuring-suse-rancher-prime-rke2-and-suse-rancher-prime-k3s-cluster-upgrades]
237237
== Configuring {rke2} and {k3s} Cluster Upgrades
238238

239239
[TIP]

0 commit comments

Comments
 (0)