Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed dead links #604

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fixed dead links #604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion asciidoc/components/turtles.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ ifdef::env-github[]
endif::[]


See Rancher Turtles documentation at https://turtles.docs.rancher.com/turtles/{rancher-turtles-docs-version}
See Rancher Turtles documentation at https://documentation.suse.com/cloudnative/cluster-api/

[quote]
____
Expand Down
3 changes: 2 additions & 1 deletion asciidoc/edge-book/links.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@
:link-atip-examples: https://github.com/suse-edge/atip/tree/{release-tag-atip}/telco-examples/edge-clusters
:link-atip-performance-settings: https://github.com/suse-edge/atip/blob/{release-tag-atip}/telco-examples/edge-clusters/dhcp/eib/custom/files/performance-settings.sh
:link-atip-sriov-auto-filler: https://github.com/suse-edge/atip/blob/{release-tag-atip}/telco-examples/edge-clusters/dhcp/eib/custom/files/sriov-auto-filler.sh
:link-atip-sriov-operator-values: https://github.com/suse-edge/charts/blob/{release-tag-atip}/charts/sriov-network-operator/{version-sriov-network-operator-chart}/values.yaml
:link-atip-sriov-operator-values: https://github.com/suse-edge/charts/blob/main/charts/sriov-network-operator/1.4.0/values.yaml
//:link-atip-sriov-operator-values: https://github.com/suse-edge/charts/blob/{release-tag-atip}/charts/sriov-network-operator/{version-sriov-network-operator-chart}/values.yaml

:link-atip-micro-download-url: https://download.opensuse.org/repositories/isv:/SUSE:/Edge:/Telco/SL-Micro_6.0_images/
2 changes: 1 addition & 1 deletion asciidoc/guides/metallb-kube-api.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ systemctl restart ${KUBE_DISTRIBUTION}

== Installing MetalLB

To deploy `MetalLB`, the https://suse-edge.github.io/docs/quickstart/metallb[MetalLB on K3s] guide can be used.
To deploy `MetalLB`, the <<guides-metallb-k3s,MetalLB on K3s>> guide can be used.

*NOTE:* Ensure that the IP addresses of the `ip-pool` IPAddressPool do not overlap with the IP addresses previously selected for the `LoadBalancer` service.

Expand Down
10 changes: 5 additions & 5 deletions asciidoc/integrations/nats.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,12 +122,12 @@ There is an already merged PR which makes the built-in NATS in K3s straightforwa

For this reason, the K3s binary should be built manually.

In this tutorial, https://suse-edge.github.io/docs/quickstart/slemicro-utm-aarch64[SUSE Linux Micro on OSX on Apple Silicon (UTM)] VM is used.
//In this tutorial, https://suse-edge.github.io/docs/quickstart/slemicro-utm-aarch64[SUSE Linux Micro on OSX on Apple Silicon (UTM)] VM is used.

[NOTE]
====
Run the commands below on the OSX PC.
====
//[NOTE]
//====
//Run the commands below on the OSX PC.
//====

==== Building K3s

Expand Down
4 changes: 3 additions & 1 deletion asciidoc/integrations/nvidia-slemicro.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ This guide demonstrates how to implement host-level NVIDIA GPU support via the p

It is important to call out that the support for these drivers is provided by both SUSE and NVIDIA in tight collaboration, where the driver is built and shipped by SUSE as part of the package repositories. However, if you have any concerns or questions about the combination in which you use the drivers, ask your SUSE or NVIDIA account managers for further assistance. If you plan to use https://www.nvidia.com/en-gb/data-center/products/ai-enterprise/[NVIDIA AI Enterprise] (NVAIE), ensure that you are using an https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/latest/platform-support.html#supported-nvidia-gpus-and-systems[NVAIE certified GPU], which _may_ require the use of proprietary NVIDIA drivers. If you are unsure, speak with your NVIDIA representative.

Further information about NVIDIA GPU operator integration is _not_ covered in this guide. While integrating the NVIDIA GPU Operator for Kubernetes is not covered here, you can still follow most of the steps in this guide to set up the underlying operating system and simply enable the GPU operator to use the _pre-installed_ drivers via the `driver.enabled=false` flag in the NVIDIA GPU Operator Helm chart, where it will simply pick up the installed drivers on the host. More comprehensive instructions are available from NVIDIA https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/latest/install-gpu-operator.html#chart-customization-options[here]. SUSE recently also made a https://documentation.suse.com/trd/kubernetes/single-html/gs_rke2-slebci_nvidia-gpu-operator/[Technical Reference Document] (TRD) available that discusses how to use the GPU operator and the NVIDIA proprietary drivers, should this be a requirement for your use case.
Further information about NVIDIA GPU operator integration is _not_ covered in this guide. While integrating the NVIDIA GPU Operator for Kubernetes is not covered here, you can still follow most of the steps in this guide to set up the underlying operating system and simply enable the GPU operator to use the _pre-installed_ drivers via the `driver.enabled=false` flag in the NVIDIA GPU Operator Helm chart, where it will simply pick up the installed drivers on the host. More comprehensive instructions are available from NVIDIA https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/latest/install-gpu-operator.html#chart-customization-options[here].
//This doc seems to have vanished from d.s.c.
//SUSE recently also made a https://documentation.suse.com/trd/kubernetes/single-html/gs_rke2-slebci_nvidia-gpu-operator/[Technical Reference Document] (TRD) available that discusses how to use the GPU operator and the NVIDIA proprietary drivers, should this be a requirement for your use case.

== Prerequisites

Expand Down
3 changes: 1 addition & 2 deletions asciidoc/misc/rke2-selinux.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ endif::[]

== Prerequisites

* one VM. Hint https://suse-edge.github.io/docs/quickstart/slemicro-utm-aarch64[SUSE Linux Micro on OSX on Apple Silicon (UTM)] or https://suse-edge.github.io/docs/quickstart/slemicro-virt-install-x86_64[SUSE Linux Micro on X86_64 on libvirt (virt-install)] can be used as the base platform for validation here, but these instructions should work on any SUSE Linux Micro based system.
** The VM should meet the https://docs.rke2.io/install/requirements#linuxwindows[RKE2 requirements].
One VM meeting the https://docs.rke2.io/install/requirements#linuxwindows[RKE2 requirements].

== Installation

Expand Down
2 changes: 1 addition & 1 deletion asciidoc/product/atip-features.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1249,7 +1249,7 @@ For the registry changes to take effect, you need to either configure this file

[NOTE]
====
For more information about this, please check https://docs.rke2.io/install/containerd_registry_configuration#registries-configuration-file[containerd registry configuration rke2].
For more information about this, please check https://documentation.suse.com/cloudnative/rke2/latest/en/install/containerd_registry_configuration.html#_registries_configuration_file[containerd registry configuration rke2].
====

[#ptp-configuration]
Expand Down
2 changes: 1 addition & 1 deletion asciidoc/product/atip-management-cluster.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -984,7 +984,7 @@ The following is an example of the `mgmt-cluster.yaml` file with the `embeddedAr
Make sure to the listed images contain the component versions you need.
====

The `rancher-turtles-airgap-resources` helm chart must also be added, this creates resources as described in the https://turtles.docs.rancher.com/getting-started/air-gapped-environment[Rancher Turtles Airgap Documentation]. This also requires a turtles.yaml values file for the rancher-turtles chart to specify the necessary configuration.
The `rancher-turtles-airgap-resources` helm chart must also be added, this creates resources as described in the https://documentation.suse.com/cloudnative/cluster-api/v0.16/en/getting-started/air-gapped-environment.html[Rancher Turtles Airgap Documentation]. This also requires a turtles.yaml values file for the rancher-turtles chart to specify the necessary configuration.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The version used in Edge 3.2 is 0.14.1 so we should probably use https://documentation.suse.com/cloudnative/cluster-api/v0.14/en/index.html.

To ensure this isn't perpetually outdated we should probably also add a version e.g here and use an attribute?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually looks like we already have one but in links.adoc

./asciidoc/edge-book/links.adoc::rancher-turtles-docs-version: v0.14
./asciidoc/components/turtles.adoc:See Rancher Turtles documentation at https://turtles.docs.rancher.com/turtles/{rancher-turtles-docs-version}


[,yaml,subs="attributes"]
----
Expand Down