Add helper script for creating deployment connectivity resources #1306
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
documentation
✅ Deploy Preview will be available once build job completes!
|
tstraley
approved these changes
Oct 16, 2025
| To set up connectivity to your NGINXaaS deployment, you will need to configure a [Private Service Connect backend](https://cloud.google.com/vpc/docs/private-service-connect-backends). | ||
|
|
||
| 1. Access the [Google Cloud Console](https://console.cloud.google.com/). | ||
| 1. Access the [Google Cloud Console](https://console.cloud.google.com/) and choose a project where you would like to create resources for connecting to your F5 NGINXaaS deployment. |
There was a problem hiding this comment.
Suggested change
| 1. Access the [Google Cloud Console](https://console.cloud.google.com/) and choose a project where you would like to create resources for connecting to your F5 NGINXaaS deployment. | |
| 1. Access the [Google Cloud Console](https://console.cloud.google.com/) and select the project where your networking resources for connecting to your F5 NGINXaaS deployment should be created. |
There was a problem hiding this comment.
(probably just my own personal word style -- didn't like the "where you would like to" verbiage, but feel free to resolve as really not important)
| - For **Port number**, enter the same port as your NEG's Producer port, for example, port `80`. | ||
|
|
||
|
|
||
| If you have multiple ports configured on NGINX, you will have to create a new network endpoint group for every port. You can also automate these steps by using the following helper script: |
There was a problem hiding this comment.
Suggested change
| If you have multiple ports configured on NGINX, you will have to create a new network endpoint group for every port. You can also automate these steps by using the following helper script: | |
| Each listening port configured on NGINX requires its own network endpoint group with a matching port. You can use the following helper script to automate these steps: |
| {{< details summary="Show helper script" >}} | ||
|
|
||
| ```bash | ||
| #!/bin/bash |
There was a problem hiding this comment.
I think we should always apply set -eo pipefail in any bash scripts, otherwise poor error handling can lead to unexpected results.
I'd also suggest -u to ensure any expected env vars are set (set -euo pipefail)
| Example: | ||
| $0 --project my-project --region us-central1 --network my-vpc \\ | ||
| --service-attachment "projects/producer-proj/regions/us-central1 serviceAttachments/ my-service" \\ |
There was a problem hiding this comment.
there are some interesting white-spaces added in this example. intentional?
Suggested change
| --service-attachment "projects/producer-proj/regions/us-central1 serviceAttachments/ my-service" \\ | |
| --service-attachment "projects/producer-proj/regions/us-central1/serviceAttachments/sa-aa4c6965-4b03-4518-85ea-2ca6fc2e869c" \\ |
Comment on lines
+180
to
+182
| # Set auto-generated proxy subnet name and VIP name | ||
| PROXY_SUBNET="psc-proxy-subnet" | ||
| VIPNAME="psc-vip" |
There was a problem hiding this comment.
nit: move these up to the top with the other default env vars. even though there isn't a command line flag to modify them right now, a user might want to just change what is hardcoded and it's easier to find at the top
tstraley
reviewed
Oct 16, 2025
| - For **Port number**, enter the same port as your NEG's Producer port, for example, port `80`. | ||
|
|
||
|
|
||
| If you have multiple ports configured on NGINX, you will have to create a new network endpoint group for every port. You can also automate these steps by using the following helper script: |
There was a problem hiding this comment.
Suggested change
| If you have multiple ports configured on NGINX, you will have to create a new network endpoint group for every port. You can also automate these steps by using the following helper script: | |
| Each listening port configured on NGINX requires its own network endpoint group with a matching port. You can use the following helper script to automate these steps: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Checklist
Before sharing this pull request, I completed the following checklist:
Footnotes
Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content. ↩