Uploaded image for project: 'OpenShift Specialist Platform Team'
  1. OpenShift Specialist Platform Team
  2. SPLAT-2589

HyperShift/hosted: Document CCM NLB Security Group Management Feature

    • Icon: Story Story
    • Resolution: Unresolved
    • Icon: Critical Critical
    • None
    • None
    • Product / Portfolio Work
    • False
    • Hide

      None

      Show
      None
    • False
    • None
    • None
    • None
    • None

      User Story:
      As a cluster admin, I want clear documentation for the AWS Cloud Controller Manager NLB security group management feature, so that I can understand how to use it, what it does, and how to troubleshoot issues.

      Description (Jira Wiki Markup):
      As a cluster admin, I want clear documentation for the AWS Cloud Controller Manager NLB security group management feature, so that I can understand how to use it, what it does, and how to troubleshoot issues.

      Description

      Create comprehensive documentation for the NLB Security Group Management feature in HyperShift/ROSA HCP, covering both TechPreview and GA usage.

      Documentation locations:

      • HyperShift documentation (website/docs)
      • ROSA HCP product documentation
      • Release notes for the version introducing this feature

      Acceptance Criteria

      • Verify that documentation explains what NLBSecurityGroupMode does and its benefits
      • Verify that documentation includes how to enable the feature under TechPreview (featureSet: TechPreviewNoUpgrade)
      • Verify that documentation lists AWS IAM permissions required for NLB security group management
      • Verify that documentation includes troubleshooting section for common issues
      • Verify that release notes mention the feature introduction in TechPreview
      • Verify that documentation is updated when feature moves to GA (references SPLAT-2588)

      Documentation Sections Required

      Overview

      • What is NLB Security Group Management
      • Benefits of using Managed mode
      • When to use this feature

      Prerequisites

      • Required AWS IAM permissions for CCM to manage NLB security groups
      • OpenShift version requirements
      • TechPreview enablement (for TechPreview phase)

      Configuration

      • How to enable TechPreview feature set on HostedCluster
      • Example HostedCluster YAML with featureSet
      • Verification steps after enabling

      Troubleshooting

      • Common error messages and solutions
      • How to verify CCM picked up the configuration
      • How to check NLB security group status

      Additional Context

              Unassigned Unassigned
              rhn-support-mrbraga Marco Braga
              None
              None
              None
              None
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: