Skip to content

Commit abe6fe0

Browse files
authored
Update naas docs to call out expectations on network attachments (#1429)
We have cases where users will have network attachments with a list of projects allowed on it. We are making changes to the service to handle this better and float the error to the user. This change calls out what the user sees and should do in a situation where flow they have project allowlists on the network attachment.
1 parent 6f4226b commit abe6fe0

File tree

2 files changed

+10
-8
lines changed

2 files changed

+10
-8
lines changed

content/nginxaas-google/getting-started/create-deployment/deploy-console.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,15 @@ Before you can deploy NGINXaaS, follow the steps in the [Prerequisites]({{< ref
1818

1919
### Create a network attachment
2020

21-
NGINXaaS requires a [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to connect your consumer Virtual Private Cloud (VPC) network and your NGINXaaS deployment's VPC network.
21+
NGINXaaS requires a [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to connect your NGINXaaS deployment to your VPC network.
2222

2323
1. Access the [Google Cloud Console](https://console.cloud.google.com/).
2424
1. Create a consumer VPC network and subnetwork. See [Google's documentation on creating a VPC and subnet](https://cloud.google.com/vpc/docs/create-modify-vpc-networks#console_1) for a step-by-step guide.
25-
- The region you choose in this step must match the region where your NGINXaaS deployment will be created.
26-
1. Create a network attachment in your new subnet that automatically accepts connections. See [Google's documentation on creating a network attachment](https://cloud.google.com/vpc/docs/create-manage-network-attachments#console_1) for a step-by-step guide.
27-
1. Make a note of the network attachment ID. You will need it in the next steps to create your NGINXaaS deployment.
25+
- The region you select for the network attachment determines the region where your NGINXaaS deployment will be created. You do not manually select a region when creating an NGINXaaS deployment; it will automatically be created in the same region as the network attachment.
26+
1. Create a network attachment in your new subnet. See [Google's documentation on creating a network attachment](https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments) for a step-by-step guide.
27+
- For **production use cases**, we recommend setting the **Connection preference** on the Network Attachment resource to **Accept connections from selected projects**. This lets you manually approve trusted connections, as this setting cannot be changed later. To start, you can leave the list of accepted projects empty and add the NGINXaaS deployment project after it is created.
28+
- For **development use cases**, you can set the **Connection preference** to **Automatically accept connections from all projects**, which allows connections without manual approval. If you choose this option, you don't need to explicitly allow the NGINXaaS deployment project.
29+
2. Make a note of the network attachment ID. You will need it in the next steps to create your NGINXaaS deployment.
2830

2931
{{< call-out "caution" >}}NGINXaaS for Google Cloud currently supports the following regions:
3032

@@ -68,6 +70,8 @@ Next, create a new NGINXaaS deployment using the NGINXaaS Console:
6870

6971
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".
7072

73+
{{< call-out "important" >}}If the **Connection preference** on the Network Attachment resource is set to **Accept connections from selected projects**, you will need to add the **NGINXaaS deployment project** to the list of **Accepted projects** for the deployment to provision successfully. The NGINXaaS deployment `Project ID` can be found under the `Cloud Info` section for your deployment. Failing to do so will leave the deployment in a `Pending` state, with details provided on the necessary actions required to proceed.{{< /call-out >}}
74+
7175
## Configure your deployment
7276

7377
In the NGINXaaS Console,

content/nginxaas-google/glossary.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,7 @@ This document provides definitions for terms and acronyms commonly used in F5 NG
1818
| GC (Geographical Controller)| Geographical Controller (GC) is a control plane that serves users in a given geographical boundary while taking into account concerns relating to data residency and localization. Example: A US geographical controller serves US customers. We currently have presence in two Geographies: **US** and **EU**. |
1919
| NGINXaas Account | Represents a Google Cloud procurement with an active Marketplace NGINXaaS subscription, linked to a billing account. To create an account, see the signup documentation in [prerequisites]({{< ref "/nginxaas-google/getting-started/prerequisites.md" >}}). |
2020
| NGINXaaS User | NGINXaaS Users are granted access to all resources in the NGINXaaS Account. User authentication is performed securely via Google Cloud, requiring a matching identity. Individuals can be added as users to multiple NGINXaaS Accounts, and can switch between them using the steps documented below. |
21-
| Network attachment | A Google Cloud resource that enables a VM instance to connect to a VPC network. [More information](https://cloud.google.com/vpc/docs/about-network-attachments). |
2221
| VPC network | A Virtual Private Cloud (VPC) network is a virtual version of a physical network, implemented within Google Cloud. It provides networking functionality for your Google Cloud resources. [More information](https://cloud.google.com/vpc/docs/vpc). |
22+
| Network attachment | A Google Cloud resource that connects your NGINXaaS deployment to upstream applications in your VPC network. [More information](https://cloud.google.com/vpc/docs/about-network-attachments). |
2323

24-
25-
26-
{{</table>}}
24+
{{</table>}}

0 commit comments

Comments
 (0)