Skip to content

add GatewayClass prerequisite documentation to deployment guide#13

Open
lautou wants to merge 2 commits intoredhat-solution-patterns:mainfrom
lautou:docs/gatewayclass-prerequisites
Open

add GatewayClass prerequisite documentation to deployment guide#13
lautou wants to merge 2 commits intoredhat-solution-patterns:mainfrom
lautou:docs/gatewayclass-prerequisites

Conversation

@lautou
Copy link
Copy Markdown

@lautou lautou commented Mar 25, 2026

This PR adds a comprehensive "GatewayClass Prerequisite" section to 03-demo.adoc that includes:

  • Detection command - oc get gatewayclass istio to verify if GatewayClass exists
  • Expected output examples - Shows what users should see when GatewayClass exists vs. missing
  • Two creation methods:
    • Option 1: Automatic creation by OpenShift Ingress Operator (when Sail Operator is installed)
    • Option 2: Manual creation with exact oc apply command
  • Important notes:
    • RHOAI compatibility (may have already created the GatewayClass)
    • Istio control plane auto-creation by Ingress Operator
    • No need to manually create Istio CR
  • Updated prerequisites checklist - Added GatewayClass verification step before running ansible

Why this is needed

During deployment testing, we discovered that:

  1. The Ansible playbook references GatewayClass "istio" in Gateway resources
  2. Neither the ansible nor helm charts create this GatewayClass - it's assumed to exist
  3. Without it, Gateway resources fail with "GatewayClass not found" errors
  4. The current documentation never mentions this prerequisite

This creates a deployment blocker for users following the guide, as they'll encounter errors with no clear resolution path.

Impact

✅ Users will now know:

  • GatewayClass "istio" must exist before deployment
  • How to check if it exists
  • How to create it (automatic or manual)
  • When it's auto-created vs. manual creation needed

Testing

Verified on OpenShift 4.19 cluster with:

  • OSSM3 (Sail Operator) installed
  • Gateway API CRDs available
  • Successfully created GatewayClass using documented manual method
  • Confirmed ansible deployment works after GatewayClass creation

lautou and others added 2 commits March 25, 2026 09:50
The inventory file setup instructions were unclear due to:
1. Missing directory context - the path 'inventories/inventory.template'
   only works after 'cd operator-setup', but the instruction to open
   the file appeared before the cd command
2. Missing copy step - users should copy the template to avoid editing
   version-controlled files
3. Wrong filename - ansible-playbook command referenced 'inventory.template'
   instead of the copied 'inventory' file

Changes:
- Add explicit 'cd operator-setup' before the copy command
- Add 'cp inventories/inventory.template inventories/inventory' command
- Update instructions to reference 'inventory' instead of 'inventory.template'
- Fix ansible-playbook command to use 'inventories/inventory'

This prevents confusion about file paths and follows Git best practices
by not editing version-controlled template files.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Documents the missing GatewayClass "istio" prerequisite that must exist before running the Ansible playbook. Includes:
- Detection command to check if GatewayClass exists
- Two creation methods (automatic via Ingress Operator, manual creation)
- Important notes about RHOAI and Istio control plane auto-creation
- Updated prerequisites checklist

This addresses a gap in the original deployment documentation where GatewayClass creation was assumed but not documented.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant