You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/spring-apps/how-to-configure-enterprise-spring-cloud-gateway.md
+43-9Lines changed: 43 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,6 +46,8 @@ To integrate with API portal for VMware Tanzu, VMware Spring Cloud Gateway autom
46
46
47
47
This section describes how to assign a public endpoint to Spring Cloud Gateway and configure its properties.
48
48
49
+
#### [Azure portal](#tab/Azure-Portal)
50
+
49
51
To assign an endpoint in the Azure portal, do the following steps:
50
52
51
53
1. Open your Azure Spring Apps instance.
@@ -56,12 +58,16 @@ After a few minutes, **URL** will show the configured endpoint URL. Save the URL
56
58
57
59
:::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":::
58
60
59
-
You can also use Azure CLI to assign the endpoint, as shown in the following command.
61
+
#### [Azure CLI](#tab/Azure-CLI)
62
+
63
+
The following command assigns the endpoint.
60
64
61
65
```azurecli
62
66
az spring gateway update --assign-endpoint
63
67
```
64
68
69
+
---
70
+
65
71
## Configure VMware Spring Cloud Gateway metadata
66
72
67
73
You can configure VMware Spring Cloud Gateway metadata, which automatically generates OpenAPI version 3 documentation, 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).
@@ -79,7 +85,23 @@ The available metadata options are described in the following table.
79
85
> [!NOTE]
80
86
> The `serverUrl` property is mandatory if you want to integrate with [API portal](./how-to-use-enterprise-api-portal.md).
81
87
82
-
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.
88
+
You can use the Azure portal and the Azure CLI to edit metdata properties.
89
+
90
+
#### [Azure portal](#tab/Azure-Portal)
91
+
92
+
To edit metadata in the Azure portal, do these steps:
93
+
94
+
1. Open your Azure Spring Apps instance.
95
+
1. Select **Spring Cloud Gateway** in the navigation pane, and then select **Overview**.
96
+
1. Select **Configuration**.
97
+
1. Specify values for the properties listed in for **API**.
98
+
1. Select **Save**.
99
+
100
+
:::image type="content" source="media/how-to-configure-enterprise-spring-cloud-gateway/gateway-configuration.png" alt-text="Screenshot of Azure portal showing the Spring Cloud Gateway configuration page for an Azure Spring Apps instance with the API section highlighted." lightbox="media/how-to-configure-enterprise-spring-cloud-gateway/gateway-configuration.png":::
101
+
102
+
#### [Azure CLI](#tab/Azure-CLLI)
103
+
104
+
Use the following command to configure VMware Spring Cloud Gateway metadata properties. You'll need the endpoint URL obtained from the [Configure Spring Cloud Gateway](#configure-spring-cloud-gateway) section.
83
105
84
106
```azurecli
85
107
az spring gateway update \
@@ -90,9 +112,7 @@ az spring gateway update \
90
112
--allowed-origins "*"
91
113
```
92
114
93
-
You can also view or edit these properties in the Azure portal, as shown in the following screenshot.
94
-
95
-
:::image type="content" source="media/how-to-configure-enterprise-spring-cloud-gateway/gateway-configuration.png" alt-text="Screenshot of Azure portal showing the Spring Cloud Gateway configuration page for an Azure Spring Apps instance." lightbox="media/how-to-configure-enterprise-spring-cloud-gateway/gateway-configuration.png":::
115
+
---
96
116
97
117
## Configure single sign-on (SSO)
98
118
@@ -107,7 +127,23 @@ VMware Spring Cloud Gateway supports authentication and authorization using sing
107
127
108
128
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).
109
129
110
-
Use the following command to configure SSO properties for VMware Spring Cloud Gateway.
130
+
You can use the Azure portal and the Azure CLI to edit SSO properties.
131
+
132
+
#### [Azure portal](#tab/Azure-Portal)
133
+
134
+
To edit SSO properties in the Azure portal, do these steps:
135
+
136
+
1. Open your Azure Spring Apps instance.
137
+
1. Select **Spring Cloud Gateway** in the navigation pane, and then select **Overview**.
138
+
1. Select **Configuration**.
139
+
1. Specify values for the properties listed in for **SSO**.
140
+
1. Select **Save**.
141
+
142
+
:::image type="content" source="media/how-to-configure-enterprise-spring-cloud-gateway/gateway-sso-configuration.png" alt-text="Screenshot of Azure portal showing the Spring Cloud Gateway configuration page for an Azure Spring Apps instance with the Single Sign On section highlighted." lightbox="media/how-to-configure-enterprise-spring-cloud-gateway/gateway-sso-configuration.png":::
143
+
144
+
#### [Azure CLI](#tab/Azure-CLI)
145
+
146
+
The following command configures SSO properties for VMware Spring Cloud Gateway.
111
147
112
148
```azurecli
113
149
az spring gateway update \
@@ -117,9 +153,7 @@ az spring gateway update \
117
153
--scope <scope>
118
154
```
119
155
120
-
You can also view or edit those properties in the Azure portal, as shown in the following screenshot.
121
-
122
-
:::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":::
156
+
---
123
157
124
158
> [!NOTE]
125
159
> VMware Spring Cloud Gateway supports only the authorization servers that support OpenID Connect Discovery protocol. Also, be sure to configure the external authorization server to allow redirects back to the gateway. Refer to your authorization server's documentation and add `https://<gateway-external-url>/login/oauth2/code/sso` to the list of allowed redirect URIs.
0 commit comments