OSDOCS-18910: Document OLM v1 deployment configuration API

[cbippley]

Overview

Documents the deployment configuration API for OLM v1, providing feature parity with OLM v0's SubscriptionConfig.

Related Issues

• JIRA: OSDOCS-18910
• Upstream Feature: OCPSTRAT-2305
• Enhancement Proposal: OPRUN-4099: OLMv1 Deployment Configuration API enhancements#1915

Content Added

6 new documentation modules (21.9K):

• olmv1-deployment-config-api.adoc (4.4K) - Core concepts
• olmv1-clusterobjectsets-deployment-mechanism.adoc (2.7K) - Deployment mechanism
• olmv1-customizing-operator-deployments.adoc (2.1K) - Procedures
• olmv1-deployment-config-examples.adoc (4.7K) - Examples
• olmv1-deployment-config-reference.adoc (5.8K) - Field reference
• olmv1-deployment-config-troubleshooting.adoc (2.2K) - Troubleshooting

Quality Assurance

✅ DITA compliant (0 errors)
✅ Style guide compliant (0 errors, 0 warnings)
✅ Validated against upstream documentation
✅ Tested on live cluster (OpenShift 4.22 nightly)

• All commands and jsonpaths verified working
• Label selectors for finding operator deployments confirmed
• Condition paths and status queries tested with cert-manager operator
• Deployment specification paths validated

Technical Improvements

• Fixed bundle status documentation to clarify output format and added command for retrieving full bundle annotations
• All troubleshooting commands verified against running ClusterExtension resources

Target: OpenShift 4.22 (Tech Preview)

[openshift-ci-robot]

@cbippley: This pull request references OSDOCS-18910 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 either version "5.0." or "openshift-5.0.", but it targets "openshift-4.22" instead.

Details

In response to this:

Overview

Documents the deployment configuration API for OLM v1, providing feature parity with OLM v0's SubscriptionConfig.

Related Issues

• JIRA: OSDOCS-18910
• Upstream Feature: OCPSTRAT-2305
• Enhancement Proposal: OPRUN-4099: OLMv1 Deployment Configuration API enhancements#1915

Content Added

6 new documentation modules (21.9K):

• olmv1-deployment-config-api.adoc (4.4K) - Core concepts
• olmv1-clusterobjectsets-deployment-mechanism.adoc (2.7K) - Deployment mechanism
• olmv1-customizing-operator-deployments.adoc (2.1K) - Procedures
• olmv1-deployment-config-examples.adoc (4.7K) - Examples
• olmv1-deployment-config-reference.adoc (5.8K) - Field reference
• olmv1-deployment-config-troubleshooting.adoc (2.2K) - Troubleshooting

Quality Assurance

✅ DITA compliant (0 errors)
✅ Style guide compliant (0 errors, 0 warnings)
✅ Validated against upstream documentation

SME Review Required

See inline comments for areas needing verification by Per Goncalves da Silva.

Target: OpenShift 4.22 (Tech Preview)

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.

[cbippley]

✅ Validated Content Summary

The following content has been fully validated against upstream documentation and is accurate:

Merge Behaviors (8 fields)

• ✅ env/envFrom: Merge, deployment config wins
• ✅ resources: Complete replacement
• ✅ nodeSelector: Complete replacement
• ✅ tolerations: Append
• ✅ affinity: Selective override (non-nil fields)
• ✅ volumes/volumeMounts: Append
• ✅ annotations: Merge, bundle wins

Schema Validation

• ✅ Schema source: SubscriptionConfig type from operator-framework API
• ✅ Validation error types: unknown field, type mismatch, required field
• ✅ JSON schema from Kubernetes API definitions

Field Structures

• ✅ Environment variable field structure (name, value, valueFrom)
• ✅ Resource field structure (requests, limits, cpu, memory)
• ✅ Toleration field structure (key, operator, value, effect)
• ✅ All field descriptions match upstream documentation

Examples

• ✅ All YAML examples are syntactically correct
• ✅ Examples cover common use cases from upstream docs
• ✅ KMM operator environment variable example
• ✅ CA certificate volume mount example

---

Documentation Quality Assurance

✅ DITA Compliance: 0 errors, 0 warnings
✅ Vale Linting: 0 errors, 0 warnings (Red Hat + IBM style guides)
✅ Module Types: Proper CONCEPT, PROCEDURE, REFERENCE structure
✅ No Callouts: All code explanations use DITA-compliant definition lists
✅ Concise Writing: ~30-40% reduction in prose while maintaining accuracy
✅ Cross-references: All internal links valid
✅ Technical Accuracy: Commands and jsonpaths verified on live cluster

[ocpdocs-previewbot]

🤖 Mon May 11 19:15:21 - Prow CI generated the docs preview:

https://111495--ocpdocs-pr.netlify.app/openshift-enterprise/latest/extensions/ce/olmv1-configuring-extensions.html

[openshift-ci]

@cbippley: 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.