diff --git a/docs/moonray/howto/networking/default-ingress-mr.md b/docs/moonray/howto/networking/default-ingress-mr.md index 24f9b435a..ff152cdc3 100644 --- a/docs/moonray/howto/networking/default-ingress-mr.md +++ b/docs/moonray/howto/networking/default-ingress-mr.md @@ -4,7 +4,7 @@ enabled, it tells your cluster how external HTTP and HTTPS traffic should be routed to its services. -## What you'll need +## Prerequisites This guide assumes the following: @@ -41,7 +41,7 @@ sudo k8s help enable Discover your configuration options by running: ``` -sudo k8s get ingress +sudo k8s get ingress ``` You should see three options: diff --git a/docs/src/charm/howto/ceph-csi.md b/docs/src/charm/howto/ceph-csi.md index 7d6dc4f5a..f7d8eaf12 100755 --- a/docs/src/charm/howto/ceph-csi.md +++ b/docs/src/charm/howto/ceph-csi.md @@ -6,7 +6,7 @@ storage solution for {{product}}. The ``ceph-csi`` plugin automatically provisions and attaches the Ceph volumes to Kubernetes workloads. -## What you'll need +## Prerequisites This guide assumes that you have an existing {{product}} cluster. See the [charm installation] guide for more details. diff --git a/docs/src/charm/howto/charm.md b/docs/src/charm/howto/charm.md index c1655f7f7..0c1892e8a 100644 --- a/docs/src/charm/howto/charm.md +++ b/docs/src/charm/howto/charm.md @@ -3,7 +3,7 @@ {{product}} is packaged as a [charm], available from Charmhub for all supported platforms. -## What you'll need +## Prerequisites This guide assumes the following: diff --git a/docs/src/charm/howto/custom-workers.md b/docs/src/charm/howto/custom-workers.md index 0f4efce42..fd17b9a9b 100644 --- a/docs/src/charm/howto/custom-workers.md +++ b/docs/src/charm/howto/custom-workers.md @@ -4,7 +4,7 @@ This guide will walk you through how to deploy multiple `k8s-worker` applications with different configurations, to create node groups with specific capabilities or requirements. -## What you'll need +## Prerequisites This guide assumes the following: - A working Kubernetes cluster deployed with the `k8s` charm @@ -60,4 +60,3 @@ juju status --watch 1s [charm configuration]: https://charmhub.io/k8s/configurations - diff --git a/docs/src/charm/howto/install-custom.md b/docs/src/charm/howto/install-custom.md index dbb4a74a5..24dd9e7bd 100644 --- a/docs/src/charm/howto/install-custom.md +++ b/docs/src/charm/howto/install-custom.md @@ -3,7 +3,7 @@ This guide will walk you through deploying {{product}} using Juju with custom configuration options. -## What you'll need +## Prerequisites This guide assumes the following: - You have Juju installed on your system with your cloud credentials diff --git a/docs/src/snap/howto/epa.md b/docs/src/snap/howto/epa.md index 1e53f5198..f595a486c 100644 --- a/docs/src/snap/howto/epa.md +++ b/docs/src/snap/howto/epa.md @@ -10,7 +10,7 @@ networking components. Finally, the steps needed to test every EPA feature: HugePages, Real-time Kernel, CPU Pinning / NUMA Topology Awareness and SR-IOV/DPDK. -## What you'll need +## Prerequisites - An Ubuntu Pro subscription (required for real-time kernel) - Ubuntu instances **or** a MAAS environment to run {{product}} on diff --git a/docs/src/snap/howto/external-datastore.md b/docs/src/snap/howto/external-datastore.md index bd583a3ca..6e1395971 100644 --- a/docs/src/snap/howto/external-datastore.md +++ b/docs/src/snap/howto/external-datastore.md @@ -4,7 +4,7 @@ instead of the bundled dqlite datastore. This guide walks you through configuring an external etcd datastore. -## What you'll need +## Prerequisites This guide assumes the following: diff --git a/docs/src/snap/howto/install/snap.md b/docs/src/snap/howto/install/snap.md index c16dafc30..7839075ba 100644 --- a/docs/src/snap/howto/install/snap.md +++ b/docs/src/snap/howto/install/snap.md @@ -3,7 +3,7 @@ {{product}} is packaged as a [snap], available from the snap store for all supported platforms. -## What you'll need +## Prerequisites This guide assumes the following: diff --git a/docs/src/snap/howto/networking/default-dns.md b/docs/src/snap/howto/networking/default-dns.md index 6cc6e4aac..2a8850131 100644 --- a/docs/src/snap/howto/networking/default-dns.md +++ b/docs/src/snap/howto/networking/default-dns.md @@ -5,7 +5,7 @@ essential for internal cluster communication. When enabled, the DNS facilitates service discovery by assigning each service a DNS name. When disabled, you can integrate a custom DNS solution into your cluster. -## What you'll need +## Prerequisites This guide assumes the following: diff --git a/docs/src/snap/howto/networking/default-ingress.md b/docs/src/snap/howto/networking/default-ingress.md index e70d66157..66f61dcd9 100644 --- a/docs/src/snap/howto/networking/default-ingress.md +++ b/docs/src/snap/howto/networking/default-ingress.md @@ -4,7 +4,7 @@ enabled, it tells your cluster how external HTTP and HTTPS traffic should be routed to its services. -## What you'll need +## Prerequisites This guide assumes the following: @@ -41,7 +41,7 @@ sudo k8s help enable Discover your configuration options by running: ``` -sudo k8s get ingress +sudo k8s get ingress ``` You should see three options: diff --git a/docs/src/snap/howto/networking/default-loadbalancer.md b/docs/src/snap/howto/networking/default-loadbalancer.md index 6552b87a0..f59a30ac4 100644 --- a/docs/src/snap/howto/networking/default-loadbalancer.md +++ b/docs/src/snap/howto/networking/default-loadbalancer.md @@ -4,7 +4,7 @@ essential service for all deployments, it is not enabled by default. This guide explains how to configure and enable the load-balancer. -## What you'll need +## Prerequisites This guide assumes the following: diff --git a/docs/src/snap/howto/networking/default-network.md b/docs/src/snap/howto/networking/default-network.md index d39537bc2..9c4bb5717 100644 --- a/docs/src/snap/howto/networking/default-network.md +++ b/docs/src/snap/howto/networking/default-network.md @@ -5,7 +5,7 @@ called Cilium. The network component allows cluster administrators to leverage software-defined networking to automatically scale and secure network policies across their cluster. -## What you'll need +## Prerequisites This guide assumes the following: @@ -62,7 +62,7 @@ sudo k8s kubectl exec -it cilium-97vcw -n kube-system -c cilium-agent \ -- cilium status ``` -You should see a wide range of metrics and configuration values for your +You should see a wide range of metrics and configuration values for your cluster. ## Disable Network @@ -70,13 +70,13 @@ cluster. You can `disable` the built-in network: ``` {warning} - If you have an active cluster, disabling Network may impact external + If you have an active cluster, disabling Network may impact external access to services within your cluster. - Ensure that you have alternative configurations in place before + Ensure that you have alternative configurations in place before disabling Network. ``` -If your underlying network is cilium you will have to run +If your underlying network is cilium you will have to run `sudo k8s disable gateway` before disabling network. ``` diff --git a/docs/src/snap/howto/security/cis-assessment.md b/docs/src/snap/howto/security/cis-assessment.md index 7ce60cacf..0cbd625f8 100644 --- a/docs/src/snap/howto/security/cis-assessment.md +++ b/docs/src/snap/howto/security/cis-assessment.md @@ -14,7 +14,7 @@ needs. This guide covers: * Manually configuring and auditing each CIS hardening recommendation -## What you'll need +## Prerequisites This guide assumes the following: diff --git a/docs/src/snap/howto/security/disa-stig-assessment.md b/docs/src/snap/howto/security/disa-stig-assessment.md index 3b60d824b..aa3e94376 100644 --- a/docs/src/snap/howto/security/disa-stig-assessment.md +++ b/docs/src/snap/howto/security/disa-stig-assessment.md @@ -10,7 +10,7 @@ potential security concerns for a Kubernetes deployment. {{product}} aligns with many DISA STIG compliance recommendations by default. However, additional hardening steps are required to fully meet the standard. -## What you'll need +## Prerequisites This guide assumes the following: diff --git a/docs/src/snap/howto/storage/ceph.md b/docs/src/snap/howto/storage/ceph.md index 46d58bf70..5d5f33e42 100644 --- a/docs/src/snap/howto/storage/ceph.md +++ b/docs/src/snap/howto/storage/ceph.md @@ -9,7 +9,7 @@ volume. RBD stands for RADOS Block Device and it is the abstraction used by Ceph to provide reliable and distributed storage. This how-to guide is adapted from [block-devices-and-kubernetes]. -## What you'll need +## Prerequisites This guide assumes the following: diff --git a/docs/src/snap/howto/storage/cloud.md b/docs/src/snap/howto/storage/cloud.md index a38f0dfd1..365333a69 100644 --- a/docs/src/snap/howto/storage/cloud.md +++ b/docs/src/snap/howto/storage/cloud.md @@ -5,7 +5,7 @@ solutions like Amazon EBS. This guide provides steps to configure IAM policies, deploy the cloud controller manager, and set up the necessary drivers for you to take advantage of cloud storage solutions in the context of Kubernetes. -## What you'll need +## Prerequisites This guide is for AWS and assumes the following: diff --git a/docs/src/snap/howto/storage/storage.md b/docs/src/snap/howto/storage/storage.md index 3b7d0a261..667abc3f4 100644 --- a/docs/src/snap/howto/storage/storage.md +++ b/docs/src/snap/howto/storage/storage.md @@ -4,7 +4,7 @@ cluster, especially for single-node support. This guide walks you through enabling and configuring this feature. -## What you'll need +## Prerequisites This guide assumes the following: