Skip to content

feat: update network attachment docs - #2278

Open
nparikh03 wants to merge 2 commits into
mainfrom
naas/network-attachments
Open

feat: update network attachment docs#2278
nparikh03 wants to merge 2 commits into
mainfrom
naas/network-attachments

Conversation

@nparikh03

@nparikh03 nparikh03 commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

Proposed changes

Updates GCP deployment documentation to reflect the new network attachment workflow:

  1. network attachments are now optional at deployment creation (previously required)
  2. they can be added and removed after deployment via the update flow.
  3. reorders content so network attachment setup follows deployment creation
  4. adds guidance on the required region-matching and remove-then-add sequence for changing attachments,
  5. notes that legacy deployments (pre–Sept 8, 2026) don't support attachment changes.
  6. also updates the glossary pages for consistency

Checklist

Before sharing this pull request, I completed the following checklist:

Footnotes

  1. Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content.

@nparikh03
nparikh03 requested a review from a team as a code owner September 11, 2026 22:07
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Sep 11, 2026
@github-actions

Copy link
Copy Markdown

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/2278/

@nparikh03
nparikh03 force-pushed the naas/network-attachments branch from 80d28f1 to 0942735 Compare September 11, 2026 22:16

Copilot AI 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.

🟡 Changes recommended

Unresolved documentation issues remain in the deployment workflow and glossary.

Get a fresh assessment by requesting another Copilot review.

Pull request overview

Updates NGINXaaS for Google Cloud documentation for optional and post-deployment network attachment management.

Changes:

  • Reorders deployment and attachment setup guidance.
  • Documents region matching, replacement workflows, and legacy limitations.
  • Updates glossary terminology.
File summaries
File Summary
content/nginxaas/overview/glossary.md Reflects network attachment update capabilities.
content/nginxaas/google/deploy/create-deployment/deploy-console.md Updates deployment and network attachment workflow guidance.
Review details

Suppressed comments (7)

content/nginxaas/google/deploy/create-deployment/deploy-console.md:50

  • When an existing attachment is selected during deployment creation, this step does not state that its region must match the Region selected above. That mismatch makes the attachment unusable for this deployment, so document the same-region requirement on this path as well, not only for attachments created after deployment.
      - The default value of `20 NCU` should be adequate for most scenarios.

content/nginxaas/google/deploy/create-deployment/deploy-console.md:52

  • The selected-projects requirement is only described for attachments created in the next section. A reader who selects a pre-created attachment with Accept connections from selected projects is not told to add the deployment's Project ID to its accepted-project list, so provisioning can remain pending. Add that instruction to this creation path as well.
   - In the Apply Configuration section, select an NGINX configuration [you created earlier](#create-or-import-an-nginx-configuration) from the **Choose Configuration** list.

content/nginxaas/google/deploy/create-deployment/deploy-console.md:63

  • This new path allows an attachment to be supplied during deployment creation, but the following section unconditionally tells every reader to create and add another attachment. It also drops the previous instruction to add the deployment Project ID to a pre-existing attachment's selected-project accept list, which can leave the deployment Pending. Branch this section: update the accept list for an attachment supplied at creation, and show the creation steps only when the field was left empty.
   - Select **Managed Public Endpoint** or **Private Endpoint** under Service Frontend.
      - Refer to the [Service Frontend]({{< ref "/nginxaas/google/overview.md#service-frontend" >}}) documentation for more information on these two frontend types.
   - Select **Submit** to begin the deployment process.

Your new deployment will appear in the list of deployments. The status of the deployment will be "Pending" while the deployment is being created. Once the deployment is complete, the status will change to "Ready".

content/nginxaas/google/deploy/create-deployment/deploy-console.md:87

  • These internal links use relative fragments, but repository guidance requires internal links to use an absolute ref shortcode with the .md path. Use canonical page paths for both links here.
      For development and testing purposes, or in scenarios where speed and simplicity are prioritized over security, you have the option to configure the **Connection Preference** to **Automatically accept connections for all projects**. Please note that this approach is inherently less secure and may expose your service to unintended or unauthorized access. We encourage you to exercise caution if using the less restrictive option and to avoid using it in production or sensitive environments.

content/nginxaas/google/deploy/create-deployment/deploy-console.md:89

  • This internal link uses a relative fragment, but repository guidance requires internal links to use an absolute ref shortcode with the .md path. Use the canonical page path here.
    content/nginxaas/google/deploy/create-deployment/deploy-console.md:107
  • This internal link uses a relative fragment, but repository guidance requires internal links to use an absolute ref shortcode with the .md path. Use the canonical page path here.
In the NGINXaaS Console,

content/nginxaas/overview/glossary.md:20

  • This new definition is unconditional, but the deployment procedure says deployments created before September 8, 2026 cannot change network attachments. Because this file is reused as the source for the provider glossaries, the current wording promises an unsupported operation for legacy deployments; qualify the statement with the cutoff.
| Network attachment          | A Google Cloud resource that connects your NGINXaaS for Google Cloud deployment to upstream applications in your VPC network. You can add or remove it when updating a deployment. [More information](https://cloud.google.com/vpc/docs/about-network-attachments).   |
  • Files reviewed: 2/2 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread content/nginxaas/google/deploy/create-deployment/deploy-console.md Outdated

Copilot AI 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.

🟡 Changes recommended

The workflow and glossary need qualification for existing attachments and unsupported legacy deployments.

Get a fresh assessment by requesting another Copilot review.

Review details
  • Files reviewed: 2/2 changed files
  • Comments generated: 2
  • Review effort level: Balanced

Comment thread content/nginxaas/google/deploy/create-deployment/deploy-console.md Outdated
Comment thread content/nginxaas/overview/glossary.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants