Skip to content

Commit af612f9

Browse files
authored
Merge pull request #60791 from EricPonvelle/OSDOCS-6130_IMDSv2
OSDOCS-6130: Added IMDS support
2 parents 928c432 + 7b295d4 commit af612f9

File tree

4 files changed

+51
-25
lines changed

4 files changed

+51
-25
lines changed
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="rosa-imds-machine-pools-ui_{context}"]
7+
= Enabling Instance Metadata Service on machine pools in {cluster-manager}
8+
9+
You can select your Instance Metadata Service (IMDS) type when creating your cluster in {cluster-manager}. You can select to use both IMDSv1 and IMDSv2, or you can specify to only use IMDSv2.
10+
11+
.Prerequisites
12+
13+
* You installed and configured the latest AWS (`aws`), ROSA (`rosa`), and OpenShift (`oc`) CLIs on your workstation.
14+
* You logged in to your Red Hat account by using the `rosa` CLI.
15+
* You have the permissions to create and manage clusters.
16+
* You have access to {cluster-manager-url}.
17+
18+
.Procedure
19+
20+
. Log in to the web console.
21+
. Create a ROSA cluster using your preferences.
22+
. In the **Create a ROSA Cluster** wizard on the **Cluster settings** -> **Machine pool** page, under the *Instance Metadata Service (IMDS)* section, select whether your machine pools use either both IMDSv1 and IMDSv2 or if you only want to use IMDSv2.
23+
. Select *Next* to save this selection.
24+
25+
.Verification
26+
27+
. After your cluster has been created, on your cluster *Overview* tab, you see the *Instance Metadata Service (IMDS)* field that notes your IMDS version support.

modules/rosa-imds-machine-pools.adoc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc
4+
5+
:_content-type: CONCEPT
6+
[id="rosa-imds-machine-pools_{context}"]
7+
= Instance Metadata Service on machine pools
8+
9+
There are two types of ways to access instance metadata from a running instance:
10+
11+
* Instance Metadata Service Version 1 (IMDSv1) - a request/response method
12+
* Instance Metadata Service Version 2 (IMDSv2) - a session-oriented method
13+
14+
IMDSv2 uses session-oriented requests. With session-oriented requests, you create a session token that defines the session duration, which can be a minimum of one second and a maximum of six hours. During the specified duration, you can use the same session token for subsequent requests. After the specified duration expires, you must create a new session token to use for future requests.
15+
16+
When creating your ROSA cluster, you select to use either both IMDSv1 and IMDSv2 or specify that your cluster should only use IMDSv2. The instance metadata service distinguishes between IMDSv1 and IMDSv2 requests based on whether, for any given request, either the PUT or GET headers, which are unique to IMDSv2, are present in that request. If you specify to use IMDSv2 only, IMDSv1 ceases to function for your cluster. All machine pools on your cluster will use whichever IMDS type you select.

nodes/rosa-managing-worker-nodes.adoc

Lines changed: 0 additions & 25 deletions
This file was deleted.

rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,14 @@ include::modules/rosa-osd-node-label-about.adoc[leveloffset=+1]
3232
* For more information about labels, see link:https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/[Kubernetes Labels and Selectors overview].
3333
3434
include::modules/rosa-adding-node-labels.adoc[leveloffset=+2]
35+
include::modules/rosa-imds-machine-pools.adoc[leveloffset=+1]
36+
37+
[role="_additional-resources"]
38+
.Additional resources
39+
40+
* For more information about Instance Metadata Service, see link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html[Use IMDSv2] in the AWS documentation.
41+
42+
include::modules/rosa-imds-machine-pools-ui.adoc[leveloffset=+2]
3543
include::modules/rosa-adding-taints.adoc[leveloffset=+1]
3644
include::modules/rosa-adding-taints-ocm.adoc[leveloffset=+2]
3745
include::modules/rosa-adding-taints-cli.adoc[leveloffset=+2]

0 commit comments

Comments
 (0)