Skip to content

fix: add link macro for relative links #1094

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.

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

Open
wants to merge 1 commit into
base: mainline
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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 latest/ug/clusters/create-cluster-auto.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@ aws iam attach-role-policy \
+
** Replace [.replaceable]`region-code` with the {aws} Region that you want to create your cluster in.
** Replace [.replaceable]`my-cluster` with a name for your cluster. The name can contain only alphanumeric characters (case-sensitive), hyphens, and underscores. It must start with an alphanumeric character and can't be longer than 100 characters. The name must be unique within the {aws} Region and {aws} account that you're creating the cluster in.
** Replace [.replaceable]`1.30` with any eks/latest/userguide/kubernetes-versions.html[Amazon EKS supported version,type="documentation"].
** Replace [.replaceable]`1.30` with any link:eks/latest/userguide/kubernetes-versions.html[Amazon EKS supported version,type="documentation"].
** Replace [.replaceable]`111122223333` with your account ID
** If you have created differently named IAM Roles for the Cluster and Node roles, replace the ARNs.
** Replace the values for `subnetIds` with your own. You can also add additional IDs. You must specify at least two subnet IDs.
Expand Down
4 changes: 2 additions & 2 deletions latest/ug/clusters/create-cluster.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ You can create a cluster by using:
. Create an Amazon EKS `IPv4` cluster with the Amazon EKS default Kubernetes version in your default {aws} Region. Before running command, make the following replacements:
. Replace [.replaceable]`region-code` with the {aws} Region that you want to create your cluster in.
. Replace [.replaceable]`my-cluster` with a name for your cluster. The name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphanumeric character and can't be longer than 100 characters. The name must be unique within the {aws} Region and {aws} account that you're creating the cluster in.
. Replace [.replaceable]`{k8s-n}` with any eks/latest/userguide/kubernetes-versions.html[Amazon EKS supported version,type="documentation"].
. Replace [.replaceable]`{k8s-n}` with any link:eks/latest/userguide/kubernetes-versions.html[Amazon EKS supported version,type="documentation"].
. Change the values for `vpc-private-subnets` to meet your requirements. You can also add additional IDs. You must specify at least two subnet IDs. If you'd rather specify public subnets, you can change `--vpc-private-subnets` to `--vpc-public-subnets`. Public subnets have an associated route table with a route to an internet gateway, but private subnets don't have an associated route table. We recommend using private subnets whenever possible.
+
The subnets that you choose must meet the <<network-requirements-subnets,Amazon EKS subnet requirements>>. Before selecting subnets, we recommend that you're familiar with all of the <<network-reqs,Amazon EKS VPC and subnet requirements and considerations>>.
Expand Down Expand Up @@ -218,7 +218,7 @@ Cluster provisioning takes several minutes.
+
** Replace [.replaceable]`region-code` with the {aws} Region that you want to create your cluster in.
** Replace [.replaceable]`my-cluster` with a name for your cluster. The name can contain only alphanumeric characters (case-sensitive), hyphens, and underscores. It must start with an alphanumeric character and can't be longer than 100 characters. The name must be unique within the {aws} Region and {aws} account that you're creating the cluster in.
** Replace [.replaceable]`{k8s-n}` with any eks/latest/userguide/kubernetes-versions.html[Amazon EKS supported version,type="documentation"].
** Replace [.replaceable]`{k8s-n}` with any link:eks/latest/userguide/kubernetes-versions.html[Amazon EKS supported version,type="documentation"].
** Replace [.replaceable]`111122223333` with your account ID and [.replaceable]`myAmazonEKSClusterRole` with the name of your cluster IAM role.
** Replace the values for `subnetIds` with your own. You can also add additional IDs. You must specify at least two subnet IDs.
+
Expand Down
6 changes: 3 additions & 3 deletions latest/ug/clusters/update-cluster.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ When a new Kubernetes version is available in Amazon EKS, you can update your Am
[IMPORTANT]
====

Once you upgrade a cluster, you can't downgrade to a previous version. Before you update to a new Kubernetes version, we recommend that you review the information in eks/latest/userguide/kubernetes-versions.html[Understand the Kubernetes version lifecycle on EKS,type="documentation"] and the update steps in this topic.
Once you upgrade a cluster, you can't downgrade to a previous version. Before you update to a new Kubernetes version, we recommend that you review the information in link:eks/latest/userguide/kubernetes-versions.html[Understand the Kubernetes version lifecycle on EKS,type="documentation"] and the update steps in this topic.

====

Expand Down Expand Up @@ -127,7 +127,7 @@ eksctl version

For instructions on how to install and update `eksctl`, see https://eksctl.io/installation[Installation] in the `eksctl` documentation.

Update the Kubernetes version of your Amazon EKS control plane. Replace `<cluster-name>` with your cluster name. Replace `<version-number>` with the Amazon EKS supported version number that you want to update your cluster to. For a list of supported version numbers, see eks/latest/userguide/kubernetes-versions.html[Amazon EKS supported versions,type="documentation"].
Update the Kubernetes version of your Amazon EKS control plane. Replace `<cluster-name>` with your cluster name. Replace `<version-number>` with the Amazon EKS supported version number that you want to update your cluster to. For a list of supported version numbers, see link:eks/latest/userguide/kubernetes-versions.html[Amazon EKS supported versions,type="documentation"].

[source,bash,subs="verbatim,attributes"]
----
Expand All @@ -151,7 +151,7 @@ Continue to <<step4>>.
=== Update cluster - {aws} CLI

. Verify that the {aws} CLI is installed and that you are logged in. For more information, see link:cli/latest/userguide/getting-started-install.html[Installing or updating to the latest version of the {aws} CLI,type="documentation"].
. Update your Amazon EKS cluster with the following {aws} CLI command. Replace `<cluster-name>` and `<region-code>` of the cluster you want to upgrade. Replace `<version-number>` with the Amazon EKS supported version number that you want to update your cluster to. For a list of supported version numbers, see eks/latest/userguide/kubernetes-versions.html[Amazon EKS supported versions,type="documentation"].
. Update your Amazon EKS cluster with the following {aws} CLI command. Replace `<cluster-name>` and `<region-code>` of the cluster you want to upgrade. Replace `<version-number>` with the Amazon EKS supported version number that you want to update your cluster to. For a list of supported version numbers, see link:eks/latest/userguide/kubernetes-versions.html[Amazon EKS supported versions,type="documentation"].
+
[source,bash,subs="verbatim,attributes"]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ To use _access entries_, the cluster must have a platform version that is the sa
| `1.26` | `eks.11`
|===

For more information, see eks/latest/userguide/platform-versions.html[platform-versions,type="documentation"].
For more information, see link:eks/latest/userguide/platform-versions.html[platform-versions,type="documentation"].
2 changes: 1 addition & 1 deletion latest/ug/networking/deploy-ipv6-cluster.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ You can use the eksctl or CLI to deploy an `IPv6` cluster.
+
*** Replace [.replaceable]`my-cluster` with a name for your cluster. The name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphanumeric character and can't be longer than 100 characters. The name must be unique within the {aws} Region and {aws} account that you're creating the cluster in.
*** Replace [.replaceable]`region-code` with any {aws} Region that is supported by Amazon EKS. For a list of {aws} Regions, see link:general/latest/gr/eks.html[Amazon EKS endpoints and quotas,type="documentation"] in the {aws} General Reference guide.
*** The value for `version` with the version of your cluster. For more information, see eks/latest/userguide/kubernetes-versions.html[Amazon EKS supported versions,type="documentation"].
*** The value for `version` with the version of your cluster. For more information, see link:eks/latest/userguide/kubernetes-versions.html[Amazon EKS supported versions,type="documentation"].
*** Replace [.replaceable]`my-nodegroup` with a name for your node group. The node group name can't be longer than 63 characters. It must start with letter or digit, but can also include hyphens and underscores for the remaining characters.
*** Replace [.replaceable]`t3.medium` with any link:AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances[{aws} Nitro System instance type,type="documentation"].
+
Expand Down
6 changes: 3 additions & 3 deletions latest/ug/nodes/hybrid-nodes-cluster-create.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ include::../attributes.txt[]
Create hybrid nodes cluster
--

This topic provides an overview of the available options and describes what to consider when you create a hybrid nodes-enabled Amazon EKS cluster. EKS Hybrid Nodes have the same eks/latest/userguide/kubernetes-versions.html[Kubernetes version support,type="documentation"] as Amazon EKS clusters with cloud nodes, including standard and extended support.
This topic provides an overview of the available options and describes what to consider when you create a hybrid nodes-enabled Amazon EKS cluster. EKS Hybrid Nodes have the same link:eks/latest/userguide/kubernetes-versions.html[Kubernetes version support,type="documentation"] as Amazon EKS clusters with cloud nodes, including standard and extended support.

If you are not planning to use EKS Hybrid Nodes, see the primary Amazon EKS create cluster documentation at <<create-cluster>>.

Expand Down Expand Up @@ -96,7 +96,7 @@ You need to install the latest version of the `eksctl` command line tool. To ins
. Create `cluster-config.yaml` to define a hybrid nodes-enabled Amazon EKS IPv4 cluster. Make the following replacements in your `cluster-config.yaml`. For a full list of settings, see the https://eksctl.io/getting-started/[eksctl documentation].
.. Replace `CLUSTER_NAME` with a name for your cluster. The name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphanumeric character and can't be longer than 100 characters. The name must be unique within the {aws} Region and {aws} account that you're creating the cluster in.
.. Replace `AWS_REGION` with the {aws} Region that you want to create your cluster in.
.. Replace `K8S_VERSION` with any eks/latest/userguide/kubernetes-versions.html[Amazon EKS supported version,type="documentation"].
.. Replace `K8S_VERSION` with any link:eks/latest/userguide/kubernetes-versions.html[Amazon EKS supported version,type="documentation"].
.. Replace `CREDS_PROVIDER` with `ssm` or `ira` based on the credential provider you configured in the steps for <<hybrid-nodes-creds>>.
.. Replace `CA_BUNDLE_CERT` if your credential provider is set to `ira`, which uses {aws} IAM Roles Anywhere as the credential provider. The CA_BUNDLE_CERT is the certificate authority (CA) certificate body and depends on your choice of CA. The certificate must be in Privacy Enhanced Mail (PEM) format.
.. Replace `GATEWAY_ID` with the ID of your virtual private gateway or transit gateway to be attached to your VPC.
Expand Down Expand Up @@ -169,7 +169,7 @@ curl -OL 'https://raw.githubusercontent.com/aws/eks-hybrid/refs/heads/main/examp
... Not overlap with each other, the `VPC CIDR` for your cluster, or your Kubernetes service IPv4 CIDR.
.. `CLUSTER_AUTH`: the cluster authentication mode for your cluster. Valid values are `API` and `API_AND_CONFIG_MAP`. The default in the template is `API_AND_CONFIG_MAP`.
.. `CLUSTER_ENDPOINT`: the cluster endpoint connectivity for your cluster. Valid values are “Public” and “Private”. The default in the template is Private, which means you will only be able to connect to the Kubernetes API endpoint from within your VPC.
.. `K8S_VERSION`: the Kubernetes version to use for your cluster. See eks/latest/userguide/kubernetes-versions.html[Amazon EKS supported versions,type="documentation"].
.. `K8S_VERSION`: the Kubernetes version to use for your cluster. See link:eks/latest/userguide/kubernetes-versions.html[Amazon EKS supported versions,type="documentation"].
+
[source,json,subs="verbatim,attributes"]
----
Expand Down
2 changes: 1 addition & 1 deletion latest/ug/nodes/hybrid-nodes-join.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Run the command below to install the hybrid nodes dependencies on your on-premis
The hybrid nodes CLI (`nodeadm`) must be run with a user that has sudo/root access on your host.
====

* Replace `K8S_VERSION` with the Kubernetes minor version of your Amazon EKS cluster, for example `1.31`. See eks/latest/userguide/kubernetes-versions.html[Amazon EKS supported versions,type="documentation"] for a list of the supported Kubernetes versions.
* Replace `K8S_VERSION` with the Kubernetes minor version of your Amazon EKS cluster, for example `1.31`. See link:eks/latest/userguide/kubernetes-versions.html[Amazon EKS supported versions,type="documentation"] for a list of the supported Kubernetes versions.
* Replace `CREDS_PROVIDER` with the on-premises credential provider you are using. Valid values are `ssm` for {aws} SSM and `iam-ra` for {aws} IAM Roles Anywhere.

[source,bash,subs="verbatim,attributes,quotes"]
Expand Down
4 changes: 2 additions & 2 deletions latest/ug/nodes/hybrid-nodes-os.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ The table below represents the operating system versions that are compatible and

=== ARM

* If you are using ARM hardware, an ARMv8.2 compliant processor with the Cryptography Extension (ARMv8.2+crypto) is required to run version 1.31 and above of the EKS kube-proxy add-on. All Raspberry Pi systems prior to the Raspberry Pi 5, as well as Cortex-A72 based processors, do not meet this requirement. As a workaround, you can continue to use version 1.30 of the EKS kube-proxy add-on until it reaches end of extended support in July of 2026, see eks/latest/userguide/kubernetes-versions.html[Kubernetes release calendar,type="documentation"], or use a custom kube-proxy image from upstream.
* If you are using ARM hardware, an ARMv8.2 compliant processor with the Cryptography Extension (ARMv8.2+crypto) is required to run version 1.31 and above of the EKS kube-proxy add-on. All Raspberry Pi systems prior to the Raspberry Pi 5, as well as Cortex-A72 based processors, do not meet this requirement. As a workaround, you can continue to use version 1.30 of the EKS kube-proxy add-on until it reaches end of extended support in July of 2026, see link:eks/latest/userguide/kubernetes-versions.html[Kubernetes release calendar,type="documentation"], or use a custom kube-proxy image from upstream.
* The following error message in the kube-proxy log indicates this incompatibility:
[source,none]
----
Expand Down Expand Up @@ -117,7 +117,7 @@ The following environment variables must be set for building images with all ope

|K8S_VERSION
|String
|Kubernetes version for hybrid nodes (for example `1.31`). For supported Kubernetes versions, see eks/latest/userguide/kubernetes-versions.html[Amazon EKS supported versions,type="documentation"].
|Kubernetes version for hybrid nodes (for example `1.31`). For supported Kubernetes versions, see link:eks/latest/userguide/kubernetes-versions.html[Amazon EKS supported versions,type="documentation"].

|NODEADM_ARCH
|String
Expand Down
2 changes: 1 addition & 1 deletion latest/ug/nodes/hybrid-nodes-upgrade.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ include::../attributes.txt[]
Upgrade Kubernetes versions on hybrid nodes
--

The guidance for upgrading hybrid nodes is similar to self-managed Amazon EKS nodes that run in Amazon EC2. We recommend that you create new hybrid nodes on your target Kubernetes version, gracefully migrate your existing applications to the hybrid nodes on the new Kubernetes version, and remove the hybrid nodes on the old Kubernetes version from your cluster. Be sure to review the link:eks/latest/best-practices/cluster-upgrades.html[Amazon EKS Best Practices,type="documentation"] for upgrades before initiating an upgrade. Amazon EKS Hybrid Nodes have the same eks/latest/userguide/kubernetes-versions.html[Kubernetes version support,type="documentation"] for Amazon EKS clusters with cloud nodes, including standard and extended support.
The guidance for upgrading hybrid nodes is similar to self-managed Amazon EKS nodes that run in Amazon EC2. We recommend that you create new hybrid nodes on your target Kubernetes version, gracefully migrate your existing applications to the hybrid nodes on the new Kubernetes version, and remove the hybrid nodes on the old Kubernetes version from your cluster. Be sure to review the link:eks/latest/best-practices/cluster-upgrades.html[Amazon EKS Best Practices,type="documentation"] for upgrades before initiating an upgrade. Amazon EKS Hybrid Nodes have the same link:eks/latest/userguide/kubernetes-versions.html[Kubernetes version support,type="documentation"] for Amazon EKS clusters with cloud nodes, including standard and extended support.

Amazon EKS Hybrid Nodes follow the same https://kubernetes.io/releases/version-skew-policy/#supported-version-skew[version skew policy] for nodes as upstream Kubernetes. Amazon EKS Hybrid Nodes cannot be on a newer version than the Amazon EKS control plane, and hybrid nodes may be up to three Kubernetes minor versions older than the Amazon EKS control plane minor version.

Expand Down
2 changes: 1 addition & 1 deletion latest/ug/nodes/launch-workers.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ The following steps show one operation to retrieve the applicable group.
** *NodeAutoScalingGroupDesiredCapacity*: Enter the desired number of nodes to scale to when your stack is created.
** *NodeAutoScalingGroupMaxSize*: Enter the maximum number of nodes that your node Auto Scaling group can scale out to.
** *NodeInstanceType*: Choose an instance type for your nodes. For more information, see <<choosing-instance-type>>.
** *NodeImageIdSSMParam*: Pre-populated with the Amazon EC2 Systems Manager parameter of a recent Amazon EKS optimized AMI for a variable Kubernetes version. To use a different Kubernetes minor version supported with Amazon EKS, replace [.replaceable]`1.XX` with a different eks/latest/userguide/kubernetes-versions.html[supported version,type="documentation"]. We recommend specifying the same Kubernetes version as your cluster.
** *NodeImageIdSSMParam*: Pre-populated with the Amazon EC2 Systems Manager parameter of a recent Amazon EKS optimized AMI for a variable Kubernetes version. To use a different Kubernetes minor version supported with Amazon EKS, replace [.replaceable]`1.XX` with a different link:eks/latest/userguide/kubernetes-versions.html[supported version,type="documentation"]. We recommend specifying the same Kubernetes version as your cluster.
+
You can also replace [.replaceable]`amazon-linux-2` with a different AMI type. For more information, see <<retrieve-ami-id>>.
+
Expand Down
2 changes: 1 addition & 1 deletion latest/ug/nodes/retrieve-ami-id-bottlerocket.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ When deploying nodes, you can specify an ID for a pre-built Amazon EKS optimized

You can retrieve the image ID of the latest recommended Amazon EKS optimized Bottlerocket AMI with the following {aws} CLI command, which uses the sub-parameter `image_id`. Make the following modifications to the command as needed and then run the modified command:

* Replace [.replaceable]`kubernetes-version` with a supported eks/latest/userguide/platform-versions.html[platform-version,type="documentation"].
* Replace [.replaceable]`kubernetes-version` with a supported link:eks/latest/userguide/platform-versions.html[platform-version,type="documentation"].
* Replace [.replaceable]`-flavor` with one of the following options.
+
** Remove [.replaceable]`-flavor` for variants without a GPU.
Expand Down
2 changes: 1 addition & 1 deletion latest/ug/nodes/retrieve-ami-id.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ When deploying nodes, you can specify an ID for a pre-built Amazon EKS optimized

You can retrieve the image ID of the latest recommended Amazon EKS optimized Amazon Linux AMI with the following command, which uses the sub-parameter `image_id`. Make the following modifications to the command as needed and then run the modified command:

* Replace `<kubernetes-version>` with a supported eks/latest/userguide/platform-versions.html[platform-version,type="documentation"].
* Replace `<kubernetes-version>` with an link:eks/latest/userguide/kubernetes-versions.html[Amazon EKS supported version,type="documentation"].
* Replace [.replaceable]`ami-type` with one of the following options. For information about the types of Amazon EC2 instances, see link:AWSEC2/latest/UserGuide/instance-types.html[Amazon EC2 instance types,type="documentation"].
+
** Use [.replaceable]`amazon-linux-2023/x86_64/standard` for Amazon Linux 2023 (AL2023) `x86` based instances.
Expand Down
Loading