generated from nginx/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 143
NLB-2234: update vmss backend documentation #1642
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 5 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
7f32fba
NLB-2234: update vmss backend documentation
Naveen-Gopu-F5 f0526a0
NLB-2234: Add additional references
Naveen-Gopu-F5 13c8156
NLB-2234: Make dataplane api key as a common page
Naveen-Gopu-F5 47fe0dc
NLB-2234: Remove steps numbering
Naveen-Gopu-F5 c62dea8
NLB-2234: Update container steps for vmss
Naveen-Gopu-F5 4cdbe87
NLB:2234: Remove unnecessary usage of pii
Naveen-Gopu-F5 80cc514
NLB-2234: Add ACI approach for vmss to docs
Naveen-Gopu-F5 1c87b7d
NLB-2234: Update title to VMSS loadbalancing
Naveen-Gopu-F5 62baf4f
NLB-2234: Update file references
Naveen-Gopu-F5 9d58c9e
NLB-2234: Collapse all options
Naveen-Gopu-F5 2ffb1fc
Merge branch 'main' into NLB-2234-add-vmss-backend-docs
JTorreG 0d640a7
Apply suggestions from code review
Naveen-Gopu-F5 17f7a83
NLB-2234: Add some details about nginx-asg-sync
Naveen-Gopu-F5 a51c99b
Merge branch 'main' into NLB-2234-add-vmss-backend-docs
Naveen-Gopu-F5 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| --- | ||
| title: Create NGINXaaS Dataplane API Key | ||
| weight: 50 | ||
| toc: true | ||
| url: /nginxaas/azure/quickstart/dataplane-api-key/ | ||
| nd-content-type: how-to | ||
| nd-product: NAZURE | ||
| --- | ||
|
|
||
| ## Overview | ||
|
|
||
| The NGINXaaS dataplane API key is used to authenticate with your NGINXaaS deployment's dataplane API. This key is required for various integrations including VMSS backend synchronization and Kubernetes load balancing. | ||
Naveen-Gopu-F5 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Requirements | ||
|
|
||
| {{< call-out "note" >}} | ||
| The data plane API key has the following requirements: | ||
|
|
||
| - The key should have an expiration date. The default expiration date is six months from the date of creation. The expiration date cannot be longer than two years from the date of creation. | ||
| - The key should be at least 12 characters long. | ||
| - The key requires three out of four of the following types of characters: | ||
| - lowercase characters. | ||
| - uppercase characters. | ||
| - symbols. | ||
| - numbers. | ||
|
|
||
| A good example of an API key that will satisfy the requirements is UUIDv4. | ||
| {{< /call-out >}} | ||
|
|
||
| ## Create the API Key | ||
|
|
||
| The data plane API key can be created using the Azure CLI or portal. | ||
russokj marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### Create an NGINXaaS data plane API key using the Azure portal | ||
|
|
||
| 1. Go to your NGINXaaS for Azure deployment. | ||
| 2. Select **NGINXaaS Loadbalancer for Kubernetes** on the left blade. | ||
| 3. Select **New API Key**. | ||
| 4. Provide a name for the new API key in the right panel, and select an expiration date. | ||
| 5. Select the **Add API Key** button. | ||
| 6. Copy the value of the new API key. | ||
|
|
||
| {{< call-out "note" >}} | ||
| Make sure to write down the key value in a safe location after creation, as you cannot retrieve it again. If you lose the generated value, delete the existing key and create a new one. | ||
| {{< /call-out >}} | ||
|
|
||
| ### Create an NGINXaaS data plane API key using the Azure CLI | ||
|
|
||
| Set shell variables about the name of the NGINXaaS you've already created: | ||
|
|
||
| ```bash | ||
| ## Customize this to provide the details about my already created NGINXaaS deployment | ||
| nginxName=myNginx | ||
| nginxGroup=myNginxGroup | ||
| ``` | ||
|
|
||
| Generate a new random data plane API key: | ||
|
|
||
| ```bash | ||
| # Generate a new random key or specify a value for it. | ||
| keyName=myKey | ||
| keyValue=$(uuidgen --random) | ||
| ``` | ||
|
|
||
| Create the key for your NGINXaaS deployment: | ||
|
|
||
| ```bash | ||
| az nginx deployment api-key create --name $keyName --secret-text $keyValue --deployment-name $nginxName --resource-group $nginxGroup | ||
| ``` | ||
|
|
||
Naveen-Gopu-F5 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## Get the Dataplane API Endpoint | ||
|
|
||
| The data plane API endpoint can be retrieved using the Azure CLI or portal. | ||
|
|
||
| ### View NGINXaaS data plane API endpoint using the Azure portal | ||
|
|
||
| 1. Go to your NGINXaaS for Azure deployment. | ||
| 2. Select **NGINXaaS Loadbalancer for Kubernetes** on the left blade. | ||
| 3. The data plane API endpoint associated with the deployment is available at the top of the screen. | ||
|
|
||
| ### View NGINXaaS data plane API endpoint using the Azure CLI | ||
|
|
||
| ```bash | ||
| dataplaneAPIEndpoint=$(az nginx deployment show -g "$nginxGroup" -n "$nginxName" --query properties.dataplaneApiEndpoint -o tsv) | ||
| ``` | ||
|
|
||
| ## Next Steps | ||
|
|
||
| Once you have created the dataplane API key and obtained the endpoint, you can use them in various NGINXaaS integrations: | ||
|
|
||
| - [VMSS Backend Integration]({{< ref "/nginxaas-azure/vmss-backend/" >}}) | ||
| - [Load Balancer for Kubernetes]({{< ref "/nginxaas-azure/loadbalancer-kubernetes/" >}}) | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.