Skip to content

Commit 3373821

Browse files
committed
edits on both files
1 parent 2c3375c commit 3373821

File tree

2 files changed

+22
-20
lines changed

2 files changed

+22
-20
lines changed

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

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@ ms.custom: devx-track-java, event-tier1-build-2022
1818

1919
This article shows you how to configure VMware Spring Cloud Gateway for VMware Tanzu with Azure Spring Apps Enterprise tier.
2020

21-
[VMware Spring Cloud Gateway](https://docs.vmware.com/en/VMware-Spring-Cloud-Gateway-for-Kubernetes/index.html) is a commercial VMware Tanzu component based on the open-source Spring Cloud Gateway project. Spring Cloud Gateway for Tanzu handles the cross-cutting concerns for API development teams, such as single sign-on (SSO), access control, rate-limiting, resiliency, security, and more. You can accelerate API delivery using modern cloud native patterns and any programming language for API development.
21+
[VMware Spring Cloud Gateway](https://docs.vmware.com/en/VMware-Spring-Cloud-Gateway-for-Kubernetes/index.html) is a commercial VMware Tanzu component based on the open-source Spring Cloud Gateway project. Spring Cloud Gateway for Tanzu handles the cross-cutting concerns for API development teams, such as single sign-on (SSO), access control, rate-limiting, resiliency, security, and more. You can accelerate API delivery using modern cloud native patterns using your choice of programming language for API development.
2222

2323
A Spring Cloud Gateway instance routes traffic according to rules. Both *scale in/out* and *up/down* are supported to meet a dynamic traffic load.
2424

2525
VMware Spring Cloud Gateway includes the following features:
2626

27-
- Dynamic routing configuration, independent of applications that can be applied and changed without recompiling.
28-
- Commercial API route filters for transporting authorized JSON Web Token (JWT) claim to application services.
27+
- Dynamic routing configuration, that's independent of applications that can be applied and changed without recompiling.
28+
- Commercial API route filters, for transporting authorized JSON Web Token (JWT) claim to application services.
2929
- Client certificate authorization.
3030
- Rate-limiting approaches.
3131
- Circuit breaker configuration.
@@ -52,11 +52,11 @@ To assign an endpoint in the Azure portal, do the following steps:
5252
1. Select **Spring Cloud Gateway** in the navigation pane, and then select **Overview**.
5353
1. Set **Assign endpoint** to **Yes**.
5454

55-
After a few minutes, **URL** will show the configured endpoint URL. Save the URL to use later, such as to configure VMware Spring Cloud Gateway metadata properties.
55+
After a few minutes, **URL** will show the configured endpoint URL. Save the URL to use later.
5656

5757
:::image type="content" source="media/how-to-configure-enterprise-spring-cloud-gateway/gateway-overview.png" alt-text="Screenshot of Azure portal showing the Spring Cloud Gateway overview page for an Azure Spring Apps instance with the Assign endpoint buttons highlighted and the configured endpoint URL displayed." lightbox="media/how-to-configure-enterprise-spring-cloud-gateway/gateway-overview.png":::
5858

59-
You can also use Azure CLI to assign the endpoint, as shown in the following command:
59+
You can also use Azure CLI to assign the endpoint, as shown in the following command.
6060

6161
```azurecli
6262
az spring gateway update --assign-endpoint
@@ -77,7 +77,7 @@ The available metadata options are described in the following table.
7777
| serverUrl | The base URL to access APIs on the Gateway instance. |
7878

7979
> [!NOTE]
80-
> `serverUrl` is mandatory if you want to integrate with [API portal](./how-to-use-enterprise-api-portal.md).
80+
> The `serverUrl` property is mandatory if you want to integrate with [API portal](./how-to-use-enterprise-api-portal.md).
8181
8282
Use the following command to configure VMware Spring Cloud Gateway metadata properties. You need the endpoint URL obtained from the [Configure Spring Cloud Gateway](#configure-spring-cloud-gateway) section.
8383

@@ -96,7 +96,7 @@ You can also view or edit these properties in the Azure portal, as shown in the
9696

9797
## Configure single sign-on (SSO)
9898

99-
VMware Spring Cloud Gateway supports authentication and authorization using single sign-on (SSO), using an OpenID identity provider (IdP) that supports OpenID Connect Discovery protocol.
99+
VMware Spring Cloud Gateway supports authentication and authorization using single sign-on (SSO), using an OpenID identity provider that supports OpenID Connect Discovery protocol.
100100

101101
| Property | Required? | Description |
102102
|----------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -107,7 +107,7 @@ VMware Spring Cloud Gateway supports authentication and authorization using sing
107107

108108
To set up SSO with Azure AD, see [How to 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).
109109

110-
Use the following command to configure SSO properties for VMware Spring Cloud Gateway:
110+
Use the following command to configure SSO properties for VMware Spring Cloud Gateway.
111111

112112
```azurecli
113113
az spring gateway update \
@@ -117,7 +117,7 @@ az spring gateway update \
117117
--scope <scope>
118118
```
119119

120-
You can also view or edit those properties in the Azure portal, as shown in the following screenshot:
120+
You can also view or edit those properties in the Azure portal, as shown in the following screenshot.
121121

122122
:::image type="content" source="media/how-to-configure-enterprise-spring-cloud-gateway/gateway-sso-configuration.png" alt-text="Screenshot of Azure portal showing Azure Spring Apps Spring Cloud Gateway page with Configuration pane showing including Single Sign On Configuration." lightbox="media/how-to-configure-enterprise-spring-cloud-gateway/gateway-sso-configuration.png":::
123123

@@ -139,7 +139,7 @@ VMware Spring Cloud Gateway service instances provide a default API endpoint to
139139

140140
If you send a `GET` request to the `/scg-logout` endpoint, then the endpoint sends a `302` redirect response to the IdP logout URL. To get the endpoint to return the user back to a path on the gateway service instance, add a redirect parameter to the `GET` request with the `/scg-logout` endpoint. For example, `${server-url}/scg-logout?redirect=/home`.
141141

142-
The following steps describe an example of how to implement the function in your microservices.
142+
The following steps describe an example of how to implement the function in your microservices:
143143

144144
1. Get a route config to route the logout request to your application. For example, see the `Animal Rescue UI Pages` route config in [Azure samples](https://github.com/Azure-Samples/animal-rescue/blob/0e343a27f44cc4a4bfbf699280476b0517854d7b/frontend/azure/api-route-config.json#L32) on GitHub.
145145

@@ -183,7 +183,7 @@ You can customize resource allocation for Spring Cloud Gateway instances, includ
183183
> [!NOTE]
184184
> For high availability, a single replica is not recommended.
185185
186-
The following table describes the default resource usage:
186+
The following table describes the default resource usage.
187187
188188
| Component name | Instance count | vCPU per instance | Memory per instance |
189189
|----------------------------------------------|----------------|-------------------|---------------------|
@@ -212,7 +212,7 @@ For other supported environment variables, see the following sources:
212212
213213
### Manage APM in Spring Cloud Gateway
214214
215-
You can use the Azure portal or the Azure CLI to set up application performance monitoring (APM) in Spring Cloud Gateway. Specify the types of APM Java agents to use and the corresponding APM environment variables they support.
215+
You can use the Azure portal or the Azure CLI to set up application performance monitoring (APM) in Spring Cloud Gateway. You will specify the types of APM Java agents to use and the corresponding APM environment variables they support.
216216
217217
#### [Azure portal](#tab/Azure-portal)
218218
@@ -230,7 +230,7 @@ Updating the configuration can take a few minutes. You should get a notification
230230
231231
#### [Azure CLI](#tab/Azure-CLI)
232232
233-
Use the following command to set up APM using Azure CLI:
233+
Use the following command to set up APM using Azure CLI.
234234
235235
```azurecli
236236
az spring gateway update \
@@ -239,7 +239,7 @@ az spring gateway update \
239239
--secrets <key=value>
240240
```
241241
242-
Allowed values for `--apm-types` are `ApplicationInsights`, `AppDynamics`, `Dynatrace`, `NewRelic`, and `ElasticAPM`. The following command shows the usage using Application Insights as an example:
242+
Allowed values for `--apm-types` are `ApplicationInsights`, `AppDynamics`, `Dynatrace`, `NewRelic`, and `ElasticAPM`. The following command shows the usage using Application Insights as an example.
243243
244244
```azurecli
245245
az spring gateway update \
@@ -252,8 +252,8 @@ You can also put environment variables in `--secrets` parameter instead of `--pr
252252
---
253253
254254
> [!NOTE]
255-
> Azure Spring Apps will upgrade the APM agent with the same cadence as deployed apps to keep compatibility of agents between Spring Cloud Gateway and Spring apps.
256-
> By default, Azure Spring Apps prints the logs of the APM Java agent to `STDOUT`. These logs are mixed with the Spring Cloud Gateway logs. You can check the version of the APM agent used in the logs. You can query these logs in Log Analytics to troubleshoot.
255+
> Azure Spring Apps upgrades the APM agent and deployed apps with the same cadence to keep compatibility of agents between Spring Cloud Gateway and Spring apps.
256+
> By default, Azure Spring Apps prints the logs of the APM Java agent to `STDOUT`. These logs are included with the Spring Cloud Gateway logs. You can check the version of the APM agent used in the logs. You can query these logs in Log Analytics to troubleshoot.
257257
> To make the APM agents work correctly, increase the CPU and memory of Spring Cloud Gateway.
258258
259259
## Next steps

articles/spring-apps/quickstart-configure-single-sign-on-enterprise.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,9 @@ To register the application with Azure Active Directory, follow these steps. If
130130

131131
## Deploy the Identity Service application
132132

133-
To complete the single sign-on experience, use the following steps to deploy the Identity Service application. The Identity Service application provides a single route to aid in identifying the user. For these steps, be sure to navigate to the project folder before running any commands.
133+
To complete the single sign-on experience, use the following steps to deploy the Identity Service application. The Identity Service application provides a single route to aid in identifying the user.
134+
135+
1. Navigate to the project folder.
134136

135137
1. Use the following command to create the `identity-service` application.
136138

@@ -184,7 +186,7 @@ To complete the single sign-on experience, use the following steps to deploy the
184186

185187
## Configure single sign-on for Spring Cloud Gateway
186188

187-
You can configure Spring Cloud Gateway to authenticate requests via single sign-on. To configure Spring Cloud Gateway to use single sign-on, follow these steps:
189+
You can configure Spring Cloud Gateway to authenticate requests using single sign-on. To configure Spring Cloud Gateway to use single sign-on, follow these steps:
188190

189191
1. Use the following commands to configure Spring Cloud Gateway to use single sign-on.
190192

@@ -233,7 +235,7 @@ You can configure Spring Cloud Gateway to authenticate requests via single sign-
233235
echo "https://${GATEWAY_URL}"
234236
```
235237

236-
You can open the output URL in a browser to explore the updated application. The Log In function will now work, allowing you to add items to the cart and place orders. After you sign in, the customer information button will display the signed-in username.
238+
You can open the output URL in a browser to explore the updated application. The Log In function is now operational, allowing you to add items to the cart and place orders. After you sign in, the customer information button will display the signed-in username.
237239

238240
## Configure single sign-on for API Portal
239241

@@ -263,7 +265,7 @@ PORTAL_URL=$(az spring api-portal show \
263265
echo "https://${PORTAL_URL}"
264266
```
265267

266-
You can open the output URL in a browser to explore the application APIs. This time, you'll be directed to sign on before exploring APIs.
268+
You can open the output URL in a browser to explore the application APIs. You'll be initially directed to sign on before exploring APIs.
267269

268270
---
269271

0 commit comments

Comments
 (0)