Skip to content

CNV-95910: Document cloud provider credential injection for VMs - #119623

Open
abrennan89 wants to merge 1 commit into
openshift:mainfrom
abrennan89:CNV95910
Open

CNV-95910: Document cloud provider credential injection for VMs#119623
abrennan89 wants to merge 1 commit into
openshift:mainfrom
abrennan89:CNV95910

Conversation

@abrennan89

Copy link
Copy Markdown
Contributor

Summary

  • Add concept, procedure, and reference modules for injecting cloud provider service account tokens (AWS IRSA, Azure Workload Identity) into VM guests using containerPath volumes and virtiofs
  • Target platforms: ROSA, ROSA HCP, and OpenShift Dedicated (ARO) — topic map entries added to those distros only
  • Draft content with TODO comments flagged for SME review (Tal Nisan)

TODOs for SME review

  • Confirm ContainerPathVolumes feature gate name and TP/GA status
  • Confirm HCO patch path syntax for enabling the feature gate
  • Confirm exact token mount paths for ROSA and ARO
  • Confirm virtiofs guest mount point for verification steps
  • Review YAML examples for accuracy

New files

File Type
virt/storage/virt-injecting-cloud-provider-credentials-into-vms.adoc Assembly
modules/virt-about-cloud-identity-credential-injection.adoc Concept
modules/virt-injecting-cloud-provider-credentials-into-vm.adoc Procedure
modules/virt-containerpath-volume-configuration-fields.adoc Reference

Modified files

  • _topic_maps/_topic_map_rosa.yml
  • _topic_maps/_topic_map_osd.yml
  • _topic_maps/_topic_map_rosa_hcp.yml

Test plan

  • Verify topic map entries render correctly for ROSA, OSD, and ROSA HCP distros
  • Verify content does not appear in OCP or MicroShift builds
  • SME review of YAML examples and feature gate configuration
  • Verify xref links resolve after related content is merged

🤖 Generated with Claude Code

Add draft documentation for injecting cloud provider service account
tokens into VM guests using containerPath volumes and virtiofs on
managed OpenShift platforms (ROSA, ARO).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Sep 9, 2026
@openshift-ci-robot

openshift-ci-robot commented Sep 9, 2026

Copy link
Copy Markdown

@abrennan89: This pull request references CNV-95910 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "5.1.0" version, but no target version was set.

Details

In response to this:

Summary

  • Add concept, procedure, and reference modules for injecting cloud provider service account tokens (AWS IRSA, Azure Workload Identity) into VM guests using containerPath volumes and virtiofs
  • Target platforms: ROSA, ROSA HCP, and OpenShift Dedicated (ARO) — topic map entries added to those distros only
  • Draft content with TODO comments flagged for SME review (Tal Nisan)

TODOs for SME review

  • Confirm ContainerPathVolumes feature gate name and TP/GA status
  • Confirm HCO patch path syntax for enabling the feature gate
  • Confirm exact token mount paths for ROSA and ARO
  • Confirm virtiofs guest mount point for verification steps
  • Review YAML examples for accuracy

New files

File Type
virt/storage/virt-injecting-cloud-provider-credentials-into-vms.adoc Assembly
modules/virt-about-cloud-identity-credential-injection.adoc Concept
modules/virt-injecting-cloud-provider-credentials-into-vm.adoc Procedure
modules/virt-containerpath-volume-configuration-fields.adoc Reference

Modified files

  • _topic_maps/_topic_map_rosa.yml
  • _topic_maps/_topic_map_osd.yml
  • _topic_maps/_topic_map_rosa_hcp.yml

Test plan

  • Verify topic map entries render correctly for ROSA, OSD, and ROSA HCP distros
  • Verify content does not appear in OCP or MicroShift builds
  • SME review of YAML examples and feature gate configuration
  • Verify xref links resolve after related content is merged

🤖 Generated with Claude Code

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 9, 2026
====
Injecting cloud provider credentials into VMs by using containerPath volumes is a Technology Preview feature only. Technology Preview features are not supported with Red{nbsp}Hat production service level agreements (SLAs) and might not be functionally complete. Red{nbsp}Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.

For more information about the support scope of Red{nbsp}Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope].

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.

annotations:
eks.amazonaws.com/role-arn: "arn:aws:iam::123456789012:role/my-role" <2>
----
<1> The name of the `ServiceAccount`. You reference this name in the VM manifest.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA.

annotations:
azure.workload.identity/client-id: "<client-id>" <2>
----
<1> The name of the `ServiceAccount`. You reference this name in the VM manifest.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA.

containerPath:
path: /var/run/secrets/eks.amazonaws.com/serviceaccount <4>
----
<1> The name of the `ServiceAccount` with the AWS IAM role annotation.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA.

containerPath:
path: /var/run/secrets/azure/tokens <5>
----
<1> Required label for Azure Workload Identity webhook injection.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA.

$ mount | grep virtiofs
$ ls /path/to/virtiofs/mount/ <1>
----
<1> The mount point depends on the guest operating system configuration. Check for the token file in the virtiofs-mounted directory.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA.

$ mount | grep virtiofs
$ ls /path/to/virtiofs/mount/ <1>
----
<1> The mount point depends on the guest operating system configuration. Check for the token file in the virtiofs-mounted directory.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA.

@openshift-ci

openshift-ci Bot commented Sep 9, 2026

Copy link
Copy Markdown

@abrennan89: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants