Skip to content

Commit 4fc07bd

Browse files
authored
docs: improve Azure cli config upload (#1433)
improve Azure cli config upload to separate steps into 2 sections, for plain files and tarballs
1 parent 8dcff61 commit 4fc07bd

File tree

1 file changed

+57
-13
lines changed

1 file changed

+57
-13
lines changed

content/nginxaas-azure/getting-started/nginx-configuration/nginx-configuration-azure-cli.md

Lines changed: 57 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,29 +23,66 @@ F5 NGINXaaS for Azure (NGINXaaS) configurations can be managed using the Azure C
2323

2424
To create a new NGINX configuration, use the `az nginx deployment configuration create` command:
2525

26+
There are two supported ways to upload your configuration:
27+
28+
1. **Plain file upload** — Upload one or more configuration files directly using the `--files` parameter.
29+
1. **Tarball upload** — Package your configuration files into a `.tar.gz` archive and upload it using the `--package` parameter.
30+
31+
Both methods are valid and can be used depending on how your configuration is structured.
32+
2633
```shell
2734
az nginx deployment configuration create --configuration-name
28-
--deployment-name
29-
--resource-group
30-
[--files]
31-
[--location]
32-
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
33-
[--package]
34-
[--protected-files]
35-
[--root-file]
35+
--deployment-name
36+
--resource-group
37+
[--files]
38+
[--location]
39+
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
40+
[--package]
41+
[--protected-files]
42+
[--root-file]
3643
```
3744

3845
### Validate your configuration
3946

4047
You can use the `analyze` command to validate your configuration before submitting it to the deployment:
4148

49+
<div data-testid="validation_tabs">
50+
{{<tabs name="validate_configuration_examples" >}}
51+
52+
{{%tab name="Validate plain files"%}}
53+
54+
If you are uploading individual configuration files, you can pass them as base64-encoded content through the `--files` parameter:
55+
4256
```shell
4357
az nginx deployment configuration analyze --deployment-name $DEPLOYMENT_NAME \
4458
--resource-group $RESOURCE_GROUP --root-file /etc/nginx/nginx.conf \
4559
--name default --files "$FILES_CONTENT"
46-
````
60+
```
4761

48-
### Examples
62+
{{%/tab%}}
63+
64+
{{%tab name="Validate a tarball package"%}}
65+
66+
If you are using a `.tar.gz` archive, encode it and pass it through the `--package` parameter:
67+
68+
```shell
69+
TAR_DATA=$(base64 -i nginx.tar.gz)
70+
az nginx deployment configuration analyze --deployment-name myDeployment \
71+
--resource-group myResourceGroup --root-file nginx.conf \
72+
--name default --package data="$TAR_DATA"
73+
```
74+
75+
{{%/tab%}}
76+
{{< /tabs >}}
77+
</div>
78+
79+
### Upload a configuration
80+
81+
{{<tabs name="upload_configuration_examples" >}}
82+
83+
{{%tab name="Upload plain files"%}}
84+
85+
The following examples show how to upload plain configuration files directly to your deployment:
4986

5087
- Create a single file configuration:
5188

@@ -90,7 +127,13 @@ az nginx deployment configuration analyze --deployment-name $DEPLOYMENT_NAME \
90127
'virtual-path':'/etc/nginx/conf.d/proxy.conf'}]"
91128
```
92129

93-
- Upload package with config files:
130+
{{%/tab%}}
131+
132+
{{%tab name="Upload a tarball package"%}}
133+
134+
You can bundle your configuration files into a `.tar.gz` archive and upload it as a single package.
135+
136+
Upload package with config files:
94137

95138
```shell
96139
$ tar -czf nginx.tar.gz nginx
@@ -172,9 +215,10 @@ az nginx deployment configuration analyze --deployment-name $DEPLOYMENT_NAME \
172215
'virtual-path':'/etc/nginx/conf.d/proxyprot.conf'}]"
173216
```
174217

175-
See the [Azure CLI Configuration Create Documentation](https://learn.microsoft.com/en-us/cli/azure/nginx/deployment/configuration?view=azure-cli-latest#az-nginx-deployment-configuration-create) for more details on the available parameters.
176-
218+
{{%/tab%}}
219+
{{< /tabs >}}
177220

221+
See the [Azure CLI Configuration Create Documentation](https://learn.microsoft.com/en-us/cli/azure/nginx/deployment/configuration?view=azure-cli-latest#az-nginx-deployment-configuration-create) for more details on the available parameters.
178222

179223
## Update a configuration
180224

0 commit comments

Comments
 (0)