Skip to content

Commit 9729442

Browse files
m8rmclarenm8rmclaren
committed
chore(docs): Docs
1 parent 5402a7a commit 9729442

11 files changed

+54
-40
lines changed

‎.github/images/AppGwBin-custom-fields-store-type-dialog.png

-36.9 KB
Binary file not shown.

‎.github/images/AzureAppGw-custom-fields-store-type-dialog.png

-36.9 KB
Binary file not shown.

‎docs/appgwbin.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -180,11 +180,11 @@ Custom fields operate at the certificate store level and are used to control how
180180

181181
| Name | Display Name | Type | Default Value/Options | Required | Description |
182182
| ---- | ------------ | ---- | --------------------- | -------- | ----------- |
183-
| ServerUsername | Server Username | Secret | | | |
184-
| ServerPassword | Server Password | Secret | | | |
185-
| ClientCertificate | Client Certificate | Secret | | | |
186-
| ServerUseSsl | Use SSL | Bool | true | ✅ | |
187-
| AzureCloud | Azure Global Cloud Authority Host | MultipleChoice | public,china,germany,government | | |
183+
| ServerUsername | Server Username | Secret | | | Application ID of the service principal, representing the identity used for managing the Application Gateway. |
184+
| ServerPassword | Server Password | Secret | | | A Client Secret that the extension will use to authenticate with the Azure Resource Management API for managing Application Gateway certificates, OR the password that encrypts the private key in ClientCertificate |
185+
| ClientCertificate | Client Certificate | Secret | | | The client certificate used to authenticate with Azure Resource Management API for managing Application Gateway certificates. See the [requirements](#client-certificate-or-client-secret) for more information. |
186+
| AzureCloud | Azure Global Cloud Authority Host | MultipleChoice | public,china,germany,government | | Specifies the Azure Cloud instance used by the organization. |
187+
| ServerUseSsl | Use SSL | Bool | true | ✅ | Specifies whether SSL should be used for communication with the server. Set to 'true' to enable SSL, and 'false' to disable it. |
188188

189189

190190
The Custom Fields tab should look like this:
@@ -205,14 +205,14 @@ The following table describes the required and optional fields for the `AppGwBin
205205
| --------- | ----------- |
206206
| Category | Select "Azure Application Gateway Certificate Binding" or the customized certificate store name from the previous step. |
207207
| Container | Optional container to associate certificate store with. |
208-
| Client Machine | |
209-
| Store Path | |
208+
| Client Machine | The Azure Tenant (directory) ID that owns the Service Principal. |
209+
| Store Path | Azure resource ID of the application gateway, following the format: /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/applicationGateways/<application-gateway-name>. |
210210
| Orchestrator | Select an approved orchestrator capable of managing `AppGwBin` certificates. Specifically, one with the `AzureAppGwBin` capability. |
211-
| ServerUsername | |
212-
| ServerPassword | |
213-
| ClientCertificate | |
214-
| ServerUseSsl | |
215-
| AzureCloud | |
211+
| ServerUsername | Application ID of the service principal, representing the identity used for managing the Application Gateway. |
212+
| ServerPassword | A Client Secret that the extension will use to authenticate with the Azure Resource Management API for managing Application Gateway certificates, OR the password that encrypts the private key in ClientCertificate |
213+
| ClientCertificate | The client certificate used to authenticate with Azure Resource Management API for managing Application Gateway certificates. See the [requirements](#client-certificate-or-client-secret) for more information. |
214+
| AzureCloud | Specifies the Azure Cloud instance used by the organization. |
215+
| ServerUseSsl | Specifies whether SSL should be used for communication with the server. Set to 'true' to enable SSL, and 'false' to disable it. |
216216

217217
* **Using kfutil**
218218

‎docs/azureappgw.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -176,11 +176,11 @@ Custom fields operate at the certificate store level and are used to control how
176176

177177
| Name | Display Name | Type | Default Value/Options | Required | Description |
178178
| ---- | ------------ | ---- | --------------------- | -------- | ----------- |
179-
| ServerUsername | Server Username | Secret | | ✅ | |
180-
| ServerPassword | Server Password | Secret | | ✅ | |
181-
| ClientCertificate | Client Certificate | Secret | | | |
182-
| ServerUseSsl | Use SSL | Bool | true | | |
183-
| AzureCloud | Azure Global Cloud Authority Host | MultipleChoice | public,china,germany,government | | |
179+
| ServerUsername | Server Username | Secret | | | Application ID of the service principal, representing the identity used for managing the Application Gateway. |
180+
| ServerPassword | Server Password | Secret | | | A Client Secret that the extension will use to authenticate with the Azure Resource Management API for managing Application Gateway certificates, OR the password that encrypts the private key in ClientCertificate |
181+
| ClientCertificate | Client Certificate | Secret | | | The client certificate used to authenticate with Azure Resource Management API for managing Application Gateway certificates. See the [requirements](#client-certificate-or-client-secret) for more information. |
182+
| AzureCloud | Azure Global Cloud Authority Host | MultipleChoice | public,china,germany,government | | Specifies the Azure Cloud instance used by the organization. |
183+
| ServerUseSsl | Use SSL | Bool | true | ✅ | Specifies whether SSL should be used for communication with the server. Set to 'true' to enable SSL, and 'false' to disable it. |
184184

185185

186186
The Custom Fields tab should look like this:
@@ -201,14 +201,14 @@ The following table describes the required and optional fields for the `AzureApp
201201
| --------- | ----------- |
202202
| Category | Select "Azure Application Gateway Certificate" or the customized certificate store name from the previous step. |
203203
| Container | Optional container to associate certificate store with. |
204-
| Client Machine | |
205-
| Store Path | |
204+
| Client Machine | The Azure Tenant (directory) ID that owns the Service Principal. |
205+
| Store Path | Azure resource ID of the application gateway, following the format: /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/applicationGateways/<application-gateway-name>. |
206206
| Orchestrator | Select an approved orchestrator capable of managing `AzureAppGw` certificates. Specifically, one with the `AzureAppGw` capability. |
207-
| ServerUsername | |
208-
| ServerPassword | |
209-
| ClientCertificate | |
210-
| ServerUseSsl | |
211-
| AzureCloud | |
207+
| ServerUsername | Application ID of the service principal, representing the identity used for managing the Application Gateway. |
208+
| ServerPassword | A Client Secret that the extension will use to authenticate with the Azure Resource Management API for managing Application Gateway certificates, OR the password that encrypts the private key in ClientCertificate |
209+
| ClientCertificate | The client certificate used to authenticate with Azure Resource Management API for managing Application Gateway certificates. See the [requirements](#client-certificate-or-client-secret) for more information. |
210+
| AzureCloud | Specifies the Azure Cloud instance used by the organization. |
211+
| ServerUseSsl | Specifies whether SSL should be used for communication with the server. Set to 'true' to enable SSL, and 'false' to disable it. |
212212

213213
* **Using kfutil**
214214

‎.github/images/AppGwBin-advanced-store-type-dialog.png renamed to ‎docsource/images/AppGwBin-advanced-store-type-dialog.png

40.7 KB
Loading

‎.github/images/AppGwBin-basic-store-type-dialog.png renamed to ‎docsource/images/AppGwBin-basic-store-type-dialog.png

55.1 KB
Loading

‎docsource/images/AppGwBin-custom-fields-store-type-dialog.png

39.3 KB
Loading

‎.github/images/AzureAppGw-advanced-store-type-dialog.png renamed to ‎docsource/images/AzureAppGw-advanced-store-type-dialog.png

40.7 KB
Loading

‎.github/images/AzureAppGw-basic-store-type-dialog.png renamed to ‎docsource/images/AzureAppGw-basic-store-type-dialog.png

54.6 KB
Loading

‎docsource/images/AzureAppGw-custom-fields-store-type-dialog.png

39.3 KB
Loading

‎integration-manifest.json

+30-16
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@
3434
"ShortName": "AzureAppGw",
3535
"Capability": "AzureAppGw",
3636
"LocalStore": false,
37+
"ClientMachineDescription": "The Azure Tenant (directory) ID that owns the Service Principal.",
38+
"StorePathDescription": "Azure resource ID of the application gateway, following the format: /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/applicationGateways/<application-gateway-name>.",
3739
"SupportedOperations": {
3840
"Add": true,
3941
"Remove": true,
@@ -46,33 +48,38 @@
4648
"Name": "ServerUsername",
4749
"DisplayName": "Server Username",
4850
"Type": "Secret",
49-
"Required": true
51+
"Description": "Application ID of the service principal, representing the identity used for managing the Application Gateway.",
52+
"Required": false
5053
},
5154
{
5255
"Name": "ServerPassword",
5356
"DisplayName": "Server Password",
5457
"Type": "Secret",
55-
"Required": true
58+
"Description": "A Client Secret that the extension will use to authenticate with the Azure Resource Management API for managing Application Gateway certificates, OR the password that encrypts the private key in ClientCertificate",
59+
"Required": false
5660
},
5761
{
5862
"Name": "ClientCertificate",
5963
"DisplayName": "Client Certificate",
6064
"Type": "Secret",
61-
"Required": false
62-
},
63-
{
64-
"Name": "ServerUseSsl",
65-
"DisplayName": "Use SSL",
66-
"Type": "Bool",
67-
"DefaultValue": "true",
65+
"Description": "The client certificate used to authenticate with Azure Resource Management API for managing Application Gateway certificates. See the [requirements](#client-certificate-or-client-secret) for more information.",
6866
"Required": false
6967
},
7068
{
7169
"Name": "AzureCloud",
7270
"DisplayName": "Azure Global Cloud Authority Host",
7371
"Type": "MultipleChoice",
7472
"DefaultValue": "public,china,germany,government",
73+
"Description": "Specifies the Azure Cloud instance used by the organization.",
7574
"Required": false
75+
},
76+
{
77+
"Name": "ServerUseSsl",
78+
"DisplayName": "Use SSL",
79+
"Type": "Bool",
80+
"DefaultValue": "true",
81+
"Description": "Specifies whether SSL should be used for communication with the server. Set to 'true' to enable SSL, and 'false' to disable it.",
82+
"Required": true
7683
}
7784
],
7885
"PasswordOptions": {
@@ -91,6 +98,8 @@
9198
"ShortName": "AppGwBin",
9299
"Capability": "AzureAppGwBin",
93100
"LocalStore": false,
101+
"ClientMachineDescription": "The Azure Tenant (directory) ID that owns the Service Principal.",
102+
"StorePathDescription": "Azure resource ID of the application gateway, following the format: /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/applicationGateways/<application-gateway-name>.",
94103
"SupportedOperations": {
95104
"Add": true,
96105
"Remove": false,
@@ -103,33 +112,38 @@
103112
"Name": "ServerUsername",
104113
"DisplayName": "Server Username",
105114
"Type": "Secret",
115+
"Description": "Application ID of the service principal, representing the identity used for managing the Application Gateway.",
106116
"Required": false
107117
},
108118
{
109119
"Name": "ServerPassword",
110120
"DisplayName": "Server Password",
111121
"Type": "Secret",
122+
"Description": "A Client Secret that the extension will use to authenticate with the Azure Resource Management API for managing Application Gateway certificates, OR the password that encrypts the private key in ClientCertificate",
112123
"Required": false
113124
},
114125
{
115126
"Name": "ClientCertificate",
116127
"DisplayName": "Client Certificate",
117128
"Type": "Secret",
129+
"Description": "The client certificate used to authenticate with Azure Resource Management API for managing Application Gateway certificates. See the [requirements](#client-certificate-or-client-secret) for more information.",
118130
"Required": false
119131
},
120-
{
121-
"Name": "ServerUseSsl",
122-
"DisplayName": "Use SSL",
123-
"Type": "Bool",
124-
"DefaultValue": "true",
125-
"Required": true
126-
},
127132
{
128133
"Name": "AzureCloud",
129134
"DisplayName": "Azure Global Cloud Authority Host",
130135
"Type": "MultipleChoice",
131136
"DefaultValue": "public,china,germany,government",
137+
"Description": "Specifies the Azure Cloud instance used by the organization.",
132138
"Required": false
139+
},
140+
{
141+
"Name": "ServerUseSsl",
142+
"DisplayName": "Use SSL",
143+
"Type": "Bool",
144+
"DefaultValue": "true",
145+
"Description": "Specifies whether SSL should be used for communication with the server. Set to 'true' to enable SSL, and 'false' to disable it.",
146+
"Required": true
133147
}
134148
],
135149
"PasswordOptions": {

0 commit comments

Comments
 (0)