Skip to content

Commit 560309e

Browse files
KarlEricksonKarlErickson
committed
edits
1 parent 2b55306 commit 560309e

File tree

1 file changed

+32
-31
lines changed

1 file changed

+32
-31
lines changed

‎articles/spring-apps/how-to-configure-enterprise-spring-cloud-gateway.md

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,14 @@ VMware Spring Cloud Gateway includes the following features:
3131
- Circuit breaker configuration
3232
- Support for accessing application services via HTTP Basic Authentication credentials
3333

34-
To integrate with the API portal for VMware Tanzu, VMware Spring Cloud Gateway automatically generates OpenAPI version 3 documentation after any additions or changes to route configuration. For more information, see [Use API portal for VMware Tanzu](./how-to-use-enterprise-api-portal.md).
34+
To integrate with API portal for VMware Tanzu, VMware Spring Cloud Gateway automatically generates OpenAPI version 3 documentation after any additions or changes to route configuration. For more information, see [Use API portal for VMware Tanzu](./how-to-use-enterprise-api-portal.md).
3535

3636
## Prerequisites
3737

38-
- An already provisioned Azure Spring Apps (Enterprise plan) service instance with VMware Spring Cloud Gateway enabled. For more information, see [Quickstart: Build and deploy apps to Azure Spring Apps using the Enterprise plan](quickstart-deploy-apps-enterprise.md).
38+
- An already provisioned Azure Spring Apps Enterprise plan service instance with VMware Spring Cloud Gateway enabled. For more information, see [Quickstart: Build and deploy apps to Azure Spring Apps using the Enterprise plan](quickstart-deploy-apps-enterprise.md).
3939

40-
You must enable VMware Spring Cloud Gateway when you provision your Azure Spring Apps service instance. You can't enable VMware Spring Cloud Gateway after provisioning.
40+
> [!NOTE]
41+
> You must enable VMware Spring Cloud Gateway when you provision your Azure Spring Apps service instance. You can't enable VMware Spring Cloud Gateway after provisioning.
4142
4243
- Azure CLI version 2.0.67 or later. For more information, see [How to install the Azure CLI](/cli/azure/install-azure-cli).
4344

@@ -53,9 +54,9 @@ Use the following steps to enable or disable VMware Spring Cloud Gateway by usin
5354
1. Select **Manage**.
5455
1. Select or clear the **Enable Spring Cloud Gateway** checkbox, and then select **Save**.
5556

56-
You can now view the state of Spring Cloud Gateway on the **Spring Cloud Gateway** pane.
57+
You can now view the state of the Spring Cloud Gateway on the **Spring Cloud Gateway** page.
5758

58-
:::image type="content" source="media/how-to-configure-enterprise-spring-cloud-gateway/gateway-manage-restart.png" alt-text="Screenshot of the Azure portal that shows the Spring Cloud Gateway pane." lightbox="media/how-to-configure-enterprise-spring-cloud-gateway/gateway-manage-restart.png":::
59+
:::image type="content" source="media/how-to-configure-enterprise-spring-cloud-gateway/gateway-manage-restart.png" alt-text="Screenshot of the Azure portal that shows the Spring Cloud Gateway page." lightbox="media/how-to-configure-enterprise-spring-cloud-gateway/gateway-manage-restart.png":::
5960

6061
### [Azure CLI](#tab/Azure-CLI)
6162

@@ -87,11 +88,11 @@ Use the following steps to restart VMware Spring Cloud Gateway by using the Azur
8788
1. Select **Restart**.
8889
1. Select **OK** to confirm the restart.
8990

90-
:::image type="content" source="media/how-to-configure-enterprise-spring-cloud-gateway/gateway-restart.png" alt-text="Screenshot of the Azure portal that shows the Spring Cloud Gateway pane with the confirmation message about restarting the gateway." lightbox="media/how-to-configure-enterprise-spring-cloud-gateway/gateway-restart.png":::
91+
:::image type="content" source="media/how-to-configure-enterprise-spring-cloud-gateway/gateway-restart.png" alt-text="Screenshot of the Azure portal that shows the Spring Cloud Gateway page with the confirmation message about restarting the gateway." lightbox="media/how-to-configure-enterprise-spring-cloud-gateway/gateway-restart.png":::
9192

9293
### [Azure CLI](#tab/Azure-CLI)
9394

94-
Use the following Azure CLI command to restart VMware Spring Cloud Gateway:
95+
Use the following Azure CLI command to restart the gateway:
9596

9697
```azurecli
9798
az spring spring-cloud-gateway restart \
@@ -110,7 +111,7 @@ This section describes how to assign a public endpoint to VMware Spring Cloud Ga
110111
To assign an endpoint in the Azure portal, use the following steps:
111112

112113
1. Open your Azure Spring Apps instance.
113-
1. Select **Spring Cloud Gateway** on the left pane, and then select **Overview**.
114+
1. Select **Spring Cloud Gateway** on the navigation pane, and then select **Overview**.
114115
1. Set **Assign endpoint** to **Yes**.
115116

116117
After a few minutes, **URL** shows the configured endpoint URL. Save the URL to use later.
@@ -132,9 +133,9 @@ az spring gateway update \
132133

133134
## Configure VMware Spring Cloud Gateway metadata
134135

135-
VMware Spring Cloud Gateway metadata automatically generates OpenAPI version 3 documentation. You can configure VMware Spring Cloud Gateway metadata to display route groups in the API portal for VMware Tanzu. For more information, see [Use API portal for VMware Tanzu](./how-to-use-enterprise-api-portal.md).
136+
VMware Spring Cloud Gateway metadata automatically generates OpenAPI version 3 documentation. You can configure VMware Spring Cloud Gateway metadata to display route groups in API portal for VMware Tanzu. For more information, see [Use API portal for VMware Tanzu](./how-to-use-enterprise-api-portal.md).
136137

137-
The following table describes the available metadata options.
138+
The following table describes the available metadata options:
138139

139140
| Property | Description |
140141
|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -151,15 +152,15 @@ You can use the Azure portal or the Azure CLI to edit metadata properties.
151152
To edit metadata in the Azure portal, use the following steps:
152153

153154
1. Open your Azure Spring Apps instance.
154-
1. Select **Spring Cloud Gateway** on the left pane, and then select **Configuration**.
155+
1. Select **Spring Cloud Gateway** on the navigation pane, and then select **Configuration**.
155156
1. Specify values for the properties listed for **API**.
156157
1. Select **Save**.
157158

158159
:::image type="content" source="media/how-to-configure-enterprise-spring-cloud-gateway/gateway-configuration.png" alt-text="Screenshot of the Azure portal that shows the Spring Cloud Gateway configuration pane for an Azure Spring Apps instance, with the API section highlighted." lightbox="media/how-to-configure-enterprise-spring-cloud-gateway/gateway-configuration.png":::
159160

160161
#### [Azure CLI](#tab/Azure-CLI)
161162

162-
Use the following command to configure metadata properties for VMware Spring Cloud Gateway. You need the endpoint URL that you obtained when you [assigned a public endpoint to VMware Spring Cloud Gateway](#assign-a-public-endpoint-to-vmware-spring-cloud-gateway).
163+
Use the following command to configure metadata properties for VMware Spring Cloud Gateway. You need the endpoint URL that you obtained when you completed the [Assign a public endpoint to VMware Spring Cloud Gateway](#assign-a-public-endpoint-to-vmware-spring-cloud-gateway) section.
163164

164165
```azurecli
165166
az spring gateway update \
@@ -176,14 +177,14 @@ az spring gateway update \
176177

177178
## Configure single sign-on
178179

179-
VMware Spring Cloud Gateway supports authentication and authorization through single sign-on (SSO) with an OpenID identity provider. The provider supports the OpenID Connect Discovery protocol.
180+
VMware Spring Cloud Gateway supports authentication and authorization through single sign-on (SSO) with an OpenID identity provider. The provider supports the OpenID Connect Discovery protocol. The following table describes the SSO properties:
180181

181-
| Property | Required? | Description |
182-
|----------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
182+
| Property | Required? | Description |
183+
|----------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
183184
| `issuerUri` | Yes | The URI that's asserted as its issuer identifier. For example, if `issuer-uri` is `https://example.com`, an OpenID Provider Configuration Request is made to `https://example.com/.well-known/openid-configuration`. The result is expected to be an OpenID Provider Configuration Response. |
184-
| `clientId` | Yes | The OpenID Connect client ID from your identity provider. |
185-
| `clientSecret` | Yes | The OpenID Connect client secret from your identity provider. |
186-
| `scope` | Yes | A list of scopes to include in JWT identity tokens. This list should be based on the scopes that your identity provider allows. |
185+
| `clientId` | Yes | The OpenID Connect client ID from your identity provider. |
186+
| `clientSecret` | Yes | The OpenID Connect client secret from your identity provider. |
187+
| `scope` | Yes | A list of scopes to include in JWT identity tokens. This list should be based on the scopes that your identity provider allows. |
187188

188189
To set up SSO with Azure Active Directory, see [Set up single sign-on with Azure Active Directory for Spring Cloud Gateway and API portal](./how-to-set-up-sso-with-azure-ad.md).
189190

@@ -194,7 +195,7 @@ You can use the Azure portal or the Azure CLI to edit SSO properties.
194195
To edit SSO properties in the Azure portal, use the following steps:
195196

196197
1. Open your Azure Spring Apps instance.
197-
1. Select **Spring Cloud Gateway** on the left pane, and then select **Configuration**.
198+
1. Select **Spring Cloud Gateway** on the navigation pane, and then select **Configuration**.
198199
1. Specify values for the properties listed for **SSO**.
199200
1. Select **Save**.
200201

@@ -231,7 +232,7 @@ VMware Spring Cloud Gateway service instances provide a default API endpoint to
231232

232233
### Log out of the IdP and SSO session
233234

234-
If you send a `GET` request to the `/scg-logout` endpoint, the endpoint sends a `302` redirect response to the IdP logout URL. To get the endpoint to return the user to a path on the VMware Spring Cloud Gateway service instance, add a redirect parameter to the `GET` request with the `/scg-logout` endpoint. For example, use `${server-url}/scg-logout?redirect=/home`.
235+
If you send a `GET` request to the `/scg-logout` endpoint, the endpoint sends a `302` redirect response to the IdP logout URL. To get the endpoint to return the user to a path on the gateway service instance, add a redirect parameter to the `GET` request with the `/scg-logout` endpoint. For example, you can use `${server-url}/scg-logout?redirect=/home`.
235236

236237
The value of the redirect parameter must be a valid path on the VMware Spring Cloud Gateway service instance. You can't redirect to an external URL.
237238

@@ -296,8 +297,8 @@ With the certificate updated to Azure Spring Apps, you can configure the TLS cer
296297
297298
Use the following steps to configure the certificate in the Azure portal:
298299
299-
1. In your Azure Spring Apps instance, select **Spring Cloud Gateway** on the left pane.
300-
1. On the **Spring Cloud Gateway** pane, select **Certificate management**.
300+
1. In your Azure Spring Apps instance, select **Spring Cloud Gateway** on the navigation pane.
301+
1. On the **Spring Cloud Gateway** page, select **Certificate management**.
301302
1. Select **Enable cert verification**.
302303
1. Select the TLS certificate in **Certificates**.
303304
1. Select **Save**.
@@ -365,8 +366,8 @@ VMware Spring Cloud Gateway restarts to ensure that the gateway uses the new cer
365366

366367
Use the following steps to synchronize certificates:
367368

368-
1. In your Azure Spring Apps instance, select **Spring Cloud Gateway** on the left pane.
369-
1. On the **Spring Cloud Gateway** pane, select **Restart**, and then confirm the operation.
369+
1. In your Azure Spring Apps instance, select **Spring Cloud Gateway** on the navigation pane.
370+
1. On the **Spring Cloud Gateway** page, select **Restart**, and then confirm the operation.
370371

371372
#### [Azure CLI](#tab/Azure-CLI)
372373

@@ -421,7 +422,7 @@ But if you have requirements that you can't fulfill by other configurations desc
421422

422423
To configure environment variables in the Azure portal, use the following steps:
423424

424-
1. In your Azure Spring Apps instance, select **Spring Cloud Gateway** on the left pane, and then select **Configuration**.
425+
1. In your Azure Spring Apps instance, select **Spring Cloud Gateway** on the navigation pane, and then select **Configuration**.
425426
1. Fill in the key/value pairs for the environment variables in the **Properties** and **Secrets** sections. You can include variables with sensitive information in the **Secrets** section.
426427
1. Select **Save** to save your changes.
427428

@@ -469,7 +470,7 @@ You can use the Azure portal or the Azure CLI to set up APM in VMware Spring Clo
469470

470471
Use the following steps to set up APM by using the Azure portal:
471472

472-
1. In your Azure Spring Apps instance, select **Spring Cloud Gateway** on the left pane, and then select **Configuration**.
473+
1. In your Azure Spring Apps instance, select **Spring Cloud Gateway** on the navigation pane, and then select **Configuration**.
473474
1. Choose the APM type in the **APM** list to monitor a gateway.
474475
1. Fill in the key/value pairs for the APM environment variables in the **Properties** and **Secrets** sections. You can put variables with sensitive information in **Secrets**.
475476
1. Select **Save** to save your changes.
@@ -538,7 +539,7 @@ To get environment variable keys, add the `logging.level.` prefix, and then set
538539

539540
To configure log levels in the Azure portal, use the following steps:
540541

541-
1. In your Azure Spring Apps instance, select **Spring Cloud Gateway** on the left pane, and then select **Configuration**.
542+
1. In your Azure Spring Apps instance, select **Spring Cloud Gateway** on the navigation pane, and then select **Configuration**.
542543
1. Fill in the key/value pairs for the log levels' environment variables in the **Properties** and **Secrets** sections. If the log level is sensitive information in your case, you can include it by using the **Secrets** section.
543544
1. Select **Save** to save your changes.
544545
@@ -587,8 +588,8 @@ The following list shows the supported add-on configurations for the add-on key
587588
- Key name: `sso`
588589
- Value type: Object
589590
- Properties:
590-
- `RolesAttributeName` (string): Specifies the name of the attribute that contains the roles associated with the SSO session.
591-
- `InactiveSessionExpirationInMinutes` (integer): Specifies the expiration time, in minutes, for inactive SSO sessions. A value of `0` means the session never expires.
591+
- `RolesAttributeName` (String): Specifies the name of the attribute that contains the roles associated with the SSO session.
592+
- `InactiveSessionExpirationInMinutes` (Integer): Specifies the expiration time, in minutes, for inactive SSO sessions. A value of `0` means the session never expires.
592593
- Example:
593594

594595
```json
@@ -604,7 +605,7 @@ The following list shows the supported add-on configurations for the add-on key
604605
- Key name: `api`
605606
- Value type: Object
606607
- Properties
607-
- `groupId` (string): A unique identifier for the group of APIs available on the VMware Spring Cloud Gateway instance. The value can contain only lowercase letters and numbers.
608+
- `groupId` (String): A unique identifier for the group of APIs available on the VMware Spring Cloud Gateway instance. The value can contain only lowercase letters and numbers.
608609
- Example:
609610

610611
```json
@@ -619,7 +620,7 @@ Use the following steps to update the add-on configuration.
619620

620621
### [Azure portal](#tab/Azure-portal)
621622

622-
1. In your Azure Spring Apps instance, select **Spring Cloud Gateway** on the left pane, and then select **Configuration**.
623+
1. In your Azure Spring Apps instance, select **Spring Cloud Gateway** on the navigation pane, and then select **Configuration**.
623624
1. Specify the JSON value for **Addon Configs**.
624625
1. Select **Save**.
625626

0 commit comments

Comments
 (0)