Skip to content

Add documentation for AddOnDeploymentConfig namespace behavior - #522

Merged
openshift-merge-bot[bot] merged 1 commit into
open-cluster-management-io:mainfrom
zhujian7:doc-addondeploymentconfig-namespace
Oct 23, 2025
Merged

Add documentation for AddOnDeploymentConfig namespace behavior#522
openshift-merge-bot[bot] merged 1 commit into
open-cluster-management-io:mainfrom
zhujian7:doc-addondeploymentconfig-namespace

Conversation

@zhujian7

Copy link
Copy Markdown
Member

Summary

This PR adds documentation explaining how the agentInstallNamespace field in AddOnDeploymentConfig interacts with the namespace defined in AddOnTemplate manifests.

Changes

Key Documentation Points

The addon agent installation namespace is determined as follows:

  • If AddOnDeploymentConfig is not used, the namespace from AddOnTemplate is used
  • If AddOnDeploymentConfig is used with agentInstallNamespace: "", the namespace from AddOnTemplate is used
  • If AddOnDeploymentConfig is used but agentInstallNamespace is not set, the default open-cluster-management-agent-addon is used
  • If agentInstallNamespace is set to a specific namespace, that namespace is used

Test Plan

  • Documentation builds correctly
  • Cross-references work properly
  • Examples are clear and accurate

🤖 Generated with Claude Code

@netlify

netlify Bot commented Oct 23, 2025

Copy link
Copy Markdown

Deploy Preview for open-cluster-management ready!

Name Link
🔨 Latest commit e65084b
🔍 Latest deploy log https://app.netlify.com/projects/open-cluster-management/deploys/68f9d97248ec0d0008cfd83b
😎 Deploy Preview https://deploy-preview-522--open-cluster-management.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@zhujian7
zhujian7 force-pushed the doc-addondeploymentconfig-namespace branch from e2f7b50 to dc4c5d4 Compare October 23, 2025 07:26
This commit adds documentation explaining how the agentInstallNamespace
field in AddOnDeploymentConfig interacts with the namespace defined in
AddOnTemplate manifests.

Key points documented:
- When AddOnDeploymentConfig is not used, the AddOnTemplate namespace is used
- When AddOnDeploymentConfig is used with agentInstallNamespace: "",
  the AddOnTemplate namespace is used
- When AddOnDeploymentConfig is used but agentInstallNamespace is not set,
  the default "open-cluster-management-agent-addon" is used
- When agentInstallNamespace is set to a specific value, that value is used

This addresses the behavior fix from open-cluster-management-io/ocm#1209

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: zhujian <jiazhu@redhat.com>
@zhujian7
zhujian7 force-pushed the doc-addondeploymentconfig-namespace branch from dc4c5d4 to e65084b Compare October 23, 2025 07:29
@zhujian7

Copy link
Copy Markdown
Member Author

/cc @qiujian16

@openshift-ci
openshift-ci Bot requested a review from qiujian16 October 23, 2025 07:32
@qiujian16

Copy link
Copy Markdown
Member

/approve
/lgtm

@openshift-ci

openshift-ci Bot commented Oct 23, 2025

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiujian16, zhujian7

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-merge-bot
openshift-merge-bot Bot merged commit 2a1db7e into open-cluster-management-io:main Oct 23, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants