Skip to content

docs: add guide for switching instances between namespaces#2029

Open
AliMahmoudDev wants to merge 3 commits into
nginx:mainfrom
AliMahmoudDev:docs/add-switch-namespace-guide
Open

docs: add guide for switching instances between namespaces#2029
AliMahmoudDev wants to merge 3 commits into
nginx:mainfrom
AliMahmoudDev:docs/add-switch-namespace-guide

Conversation

@AliMahmoudDev

Copy link
Copy Markdown
Contributor

Summary

Adds a step-by-step guide for switching an NGINX instance from one namespace to another in NGINX One Console. The guide covers:

  • Creating a data plane key in the target namespace
  • Revoking the old data plane key
  • Updating the NGINX Agent configuration with the new key
  • Restarting the agent
  • Verifying the instance appears in the new namespace

Also updates the glossary entry for "Namespace" to link to the new guide instead of just describing the process.

Closes #1339

@AliMahmoudDev AliMahmoudDev requested review from a team as code owners June 3, 2026 18:46
@AliMahmoudDev

Copy link
Copy Markdown
Contributor Author

I have hereby read the F5 CLA and agree to its terms

@github-actions github-actions Bot added documentation Improvements or additions to documentation product/nginx-one-console Issues related to NGINX One Console labels Jun 3, 2026
@AliMahmoudDev

Copy link
Copy Markdown
Contributor Author

Hi maintainers! Just a heads up that this branch may need a rebase with the latest main. Happy to address any feedback on the guide content. Thanks!

@mjang mjang requested a review from y82 June 9, 2026 19:28
@mjang

mjang commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

cc @kamalchaturvedi


## Switch to a new namespace

### Step 1: Create a data plane key in the target namespace

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the contribution! One style note before merging: please remove the "Step x:" prefix from the subheadings (for example, "Step 1: Create a data plane key in the target namespace" → "Create a data plane key in the target namespace").

The F5 style guide recommends against numbering steps in headings. See: https://github.com/F5Docs/style-guide/blob/main/procedures/step-numbers-in-headings.md

@y82 y82 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good to me—thanks for the contribution!

@mjang

mjang commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Note: this has received internal approval (Slack) from the issue author, https://github.com/kamalchaturvedi

So once you've addressed @travisamartin 's request, we should be ready to merge. Thank you for your contribution!

@mjang mjang added the community Issues or pull requests started by community members label Jun 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community Issues or pull requests started by community members documentation Improvements or additions to documentation product/nginx-one-console Issues related to NGINX One Console

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Story]: Add documentation for how a customer can switch their instance to the new target namespace.

4 participants