Skip to content

Commit 12ad050

Browse files
committed
merge 2 config server doc
1 parent e32dcd4 commit 12ad050

File tree

7 files changed

+52
-16
lines changed

7 files changed

+52
-16
lines changed

articles/spring-apps/basic-standard/toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ items:
113113
- name: Prepare a Java Spring app for deployment
114114
href: ../enterprise/how-to-prepare-app-deployment.md?tabs=basic-standard-plan&toc=/azure/spring-apps/basic-standard/toc.json&bc=/azure/spring-apps/basic-standard/breadcrumb/toc.json
115115
- name: Set up a Config Server
116-
href: how-to-config-server.md
116+
href: ../enterprise/how-to-enterprise-config-server.md?pivots=sc-standard&toc=/azure/spring-apps/basic-standard/toc.json&bc=/azure/spring-apps/basic-standard/breadcrumb/toc.json
117117
- name: Enable Service Registration
118118
href: how-to-service-registration.md
119119
- name: Deploy

articles/spring-apps/enterprise/how-to-enterprise-config-server.md

Lines changed: 49 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,42 @@
11
---
2-
title: How to Use Spring Cloud Config Server with the Azure Spring Apps Enterprise plan
3-
description: How to use Spring Cloud Config Server with the Azure Spring Apps Enterprise plan.
2+
title: Configure your managed Spring Cloud Config Server in Azure Spring Apps
3+
description: Learn how to configure a managed Spring Cloud Config Server in Azure Spring Apps on the Azure portal.
44
author: Guitar
55
ms.author: guitarsheng
66
ms.service: spring-apps
77
ms.topic: how-to
88
ms.date: 05/03/2025
99
ms.custom: devx-track-java, devx-track-extended-java, devx-track-azurecli
10+
zone_pivot_groups: spring-apps-tier-selection
1011
---
1112

12-
# Use Spring Cloud Config Server
13+
# Configure a managed Spring Cloud Config Server in Azure Spring Apps
1314

1415
> [!NOTE]
1516
> Azure Spring Apps is the new name for the Azure Spring Cloud service. Although the service has a new name, you'll see the old name in some places for a while as we work to update assets such as screenshots, videos, and diagrams.
1617
1718
**This article applies to:** ✔️ Java ✔️ C#
1819

19-
**This article applies to:** Basic/Standard ✔️ Enterprise
20+
**This article applies to:** ✔️ Standard consumption and dedicated (Preview) ✔️ Basic/Standard ✔️ Enterprise
2021

21-
This article shows you how to use Spring Cloud Config Server with the Azure Spring Apps Enterprise plan.
22+
This article shows you how to configure a managed Spring Cloud Config Server in Azure Spring Apps service.
2223

2324
Spring Cloud Config Server provides server and client-side support for an externalized configuration in a distributed system. The Spring Cloud Config Server instance provides a central place to manage external properties for applications across all environments. For more information, see the [Spring Cloud Config documentation](https://spring.io/projects/spring-cloud-config).
2425

26+
::: zone pivot="sc-standard"
27+
> [!NOTE]
28+
> To use config server in the Standard consumption and dedicated plan, you must enable it first. For more information, see [Enable and disable Spring Cloud Config Server in Azure Spring Apps](../consumption-dedicated/quickstart-standard-consumption-config-server.md).
29+
::: zone-end
30+
2531
## Prerequisites
2632

2733
- An Azure subscription. If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
28-
- An already provisioned and running Azure Spring Apps service instance using the Enterprise plan. To set up and launch an Azure Spring Apps service, see [Quickstart: Build and deploy apps to Azure Spring Apps using the Enterprise plan](../enterprise/quickstart.md?pivots=sc-enterprise&toc=/azure/spring-apps/enterprise/toc.json&bc=/azure/spring-apps/enterprise/breadcrumb/toc.json).
34+
::: zone pivot="sc-standard"
35+
- An already provisioned and running Azure Spring Apps service instance using the Basic or Standard plan. To set up and launch an Azure Spring Apps service, see [Quickstart: Deploy your first application to Azure Spring Apps](../enterprise/quickstart.md?pivots=sc-standard&toc=/azure/spring-apps/basic-standard/toc.json&bc=/azure/spring-apps/basic-standard/breadcrumb/toc.json).
36+
::: zone-end
37+
::: zone pivot="sc-enterprise"
38+
- An already provisioned and running Azure Spring Apps service instance. To set up and launch an Azure Spring Apps service, see [Quickstart: Build and deploy apps to Azure Spring Apps using the Enterprise plan](../enterprise/quickstart.md?pivots=sc-enterprise&toc=/azure/spring-apps/enterprise/toc.json&bc=/azure/spring-apps/enterprise/breadcrumb/toc.json).
39+
::: zone-end
2940
- [Git](https://git-scm.com/downloads).
3041

3142
## Restriction
@@ -139,7 +150,12 @@ The following table shows some examples of patterns for configuring your service
139150
| *test-config-server-app-1/dev* | The pattern and repository URI matches a Spring boot application named `test-config-server-app-1` with a dev profile. |
140151
| *test-config-server-app-2/prod* | The pattern and repository URI matches a Spring boot application named `test-config-server-app-2` with a prod profile. |
141152

142-
:::image type="content" source="media/how-to-config-server/additional-repositories.png" lightbox="media/how-to-config-server/additional-repositories.png" alt-text="Screenshot of Azure portal showing the Config Server page with the Patterns column of the Additional repositories table highlighted.":::
153+
::: zone pivot="sc-standard"
154+
:::image type="content" source="../basic-standard/media/how-to-config-server/additional-repositories.png" lightbox="media/how-to-config-server/additional-repositories.png" alt-text="Screenshot of Azure portal showing the Config Server page with the Patterns column of the Additional repositories table highlighted.":::
155+
::: zone-end
156+
::: zone pivot="sc-enterprise"
157+
:::image type="content" source="media/how-to-enterprise-config-server/additional-repositories.png" lightbox="media/how-to-enterprise-config-server/additional-repositories.png" alt-text="Screenshot of Azure portal showing the Config Server page with the Patterns column of the Additional repositories table highlighted.":::
158+
::: zone-end
143159

144160
## Configure Git repository against Config Server
145161

@@ -155,11 +171,21 @@ Now that your configuration files are saved in a repository, use the following s
155171

156172
1. Select **Validate**.
157173

158-
:::image type="content" source="media/how-to-config-server/portal-config.png" lightbox="media/how-to-config-server/portal-config.png" alt-text="Screenshot of Azure portal showing the Config Server page.":::
174+
::: zone pivot="sc-standard"
175+
:::image type="content" source="../basic-standard/media/how-to-config-server/portal-config.png" lightbox="media/how-to-config-server/portal-config.png" alt-text="Screenshot of Azure portal showing the Config Server page.":::
176+
::: zone-end
177+
::: zone pivot="sc-enterprise"
178+
:::image type="content" source="media/how-to-enterprise-config-server/portal-config.png" lightbox="media/how-to-enterprise-config-server/portal-config.png" alt-text="Screenshot of Azure portal showing the Config Server page.":::
179+
::: zone-end
159180

160181
1. When validation is complete, select **Apply** to save your changes.
161182

162-
:::image type="content" source="media/how-to-config-server/validate-complete.png" lightbox="media/how-to-config-server/validate-complete.png" alt-text="Screenshot of Azure portal showing Config Server page with Apply button highlighted.":::
183+
::: zone pivot="sc-standard"
184+
:::image type="content" source="../basic-standard/media/how-to-config-server/validate-complete.png" lightbox="media/how-to-config-server/validate-complete.png" alt-text="Screenshot of Azure portal showing Config Server page with Apply button highlighted.":::
185+
::: zone-end
186+
::: zone pivot="sc-enterprise"
187+
:::image type="content" source="media/how-to-enterprise-config-server/validate-complete.png" lightbox="media/how-to-enterprise-config-server/validate-complete.png" alt-text="Screenshot of Azure portal showing Config Server page with Apply button highlighted.":::
188+
::: zone-end
163189

164190
Updating the configuration can take a few minutes. You should get a notification when the configuration is complete.
165191

@@ -177,7 +203,7 @@ Use the steps in this section to enter repository information for a public or pr
177203

178204
- **Basic Authentication**: In the **Default repository** section, in the **Uri** box, paste the repository URI, and then select the setting under **Authentication** to open the **Edit Authentication** pane. In the **Authentication type** drop-down list, select **HTTP Basic**, and then enter your username and password/token to grant access to Azure Spring Apps. Select **OK**, and then select **Apply** to finish setting up your Config Server instance.
179205

180-
:::image type="content" source="media/how-to-config-server/basic-auth.png" lightbox="media/how-to-config-server/basic-auth.png" alt-text="Screenshot of the Default repository section showing authentication settings for Basic authentication.":::
206+
:::image type="content" source="../basic-standard/media/how-to-config-server/basic-auth.png" lightbox="media/how-to-config-server/basic-auth.png" alt-text="Screenshot of the Default repository section showing authentication settings for Basic authentication.":::
181207

182208
> [!NOTE]
183209
> Many Git repository servers support the use of tokens rather than passwords for HTTP basic authentication. Some repositories allow tokens to persist indefinitely. However, some Git repository servers, including Azure DevOps Server, force tokens to expire in a few hours. Repositories that cause tokens to expire shouldn't use token-based authentication with Azure Spring Apps. If you use such a token, remember to update it before it expires.
@@ -186,7 +212,7 @@ Use the steps in this section to enter repository information for a public or pr
186212
187213
- **SSH**: In the **Default repository** section, in the **Uri** box, paste the repository URI, and then select the setting under **Authentication** to open the **Edit Authentication** pane. In the **Edit Authentication** pane, in the **Authentication type** drop-down list, select **SSH**, and then enter your private key. Optionally, specify your host key and host key algorithm. Include your public key in your Config Server repository. Select **OK**, and then select **Apply** to finish setting up your Config Server instance.
188214

189-
:::image type="content" source="media/how-to-config-server/ssh-auth.png" lightbox="media/how-to-config-server/ssh-auth.png" alt-text="Screenshot of the Default repository section showing authentication settings for SSH authentication.":::
215+
:::image type="content" source="../basic-standard/media/how-to-config-server/ssh-auth.png" lightbox="media/how-to-config-server/ssh-auth.png" alt-text="Screenshot of the Default repository section showing authentication settings for SSH authentication.":::
190216

191217
#### Extra repositories
192218

@@ -209,7 +235,12 @@ spring:
209235
210236
Select the **Import settings** button, and then select the YAML file from your project directory. Select **Import**.
211237
212-
:::image type="content" source="media/how-to-config-server/import-settings.png" lightbox="media/how-to-config-server/import-settings.png" alt-text="Screenshot of the Config Server Import settings pane.":::
238+
::: zone pivot="sc-standard"
239+
:::image type="content" source="../basic-standard/media/how-to-config-server/import-settings.png" lightbox="media/how-to-config-server/import-settings.png" alt-text="Screenshot of the Config Server Import settings pane.":::
240+
::: zone-end
241+
::: zone pivot="sc-enterprise"
242+
:::image type="content" source="media/how-to-enterprise-config-server/import-settings.png" lightbox="media/how-to-enterprise-config-server/import-settings.png" alt-text="Screenshot of the Config Server Import settings pane.":::
243+
::: zone-end
213244
214245
Your **Notifications** displays an `async` operation. Config Server should report success after 1-2 minutes. The information from your YAML file displays in the Azure portal. Select **Apply** to finish the import.
215246

@@ -256,8 +287,9 @@ Use the following steps to get your repo URL and credentials.
256287
- For **Password**, specify the password that you saved in the previous section.
257288
- Select **OK**, and then wait for the operation to complete.
258289

259-
:::image type="content" source="media/how-to-config-server/config-server-azure-repos.png" lightbox="media/how-to-config-server/config-server-azure-repos.png" alt-text="Screenshot of repository configuration settings.":::
290+
:::image type="content" source="../basic-standard/media/how-to-config-server/config-server-azure-repos.png" lightbox="media/how-to-config-server/config-server-azure-repos.png" alt-text="Screenshot of repository configuration settings.":::
260291

292+
::: zone pivot="sc-enterprise"
261293
### **Bind** **an app** to Spring Cloud Config Server
262294

263295
Use the following command to bind an app to Spring Cloud Config Server, enabling the app to pull configurations from Config Server.
@@ -290,7 +322,8 @@ az spring app create \
290322

291323
You can also bind your application to the Spring Cloud Config Server from the Azure portal, as shown in the following screenshot:
292324

293-
:::image type="content" source="./media/how-to-enterprise-config-server/spring-cloud-config-server-bind-app-when-creation.png" alt-text="Screenshot of the Azure portal that shows the Create App page with the Bind dropdown highlighted.":::
325+
:::image type="content" source="media/how-to-enterprise-config-server/spring-cloud-config-server-bind-app-when-creation.png" alt-text="Screenshot of the Azure portal that shows the Create App page with the Bind dropdown highlighted.":::
326+
::: zone-end
294327

295328
## Delete your configuration
296329

@@ -360,6 +393,7 @@ Instead, you can automatically refresh values from Config Server by letting the
360393

361394
For more information, see the [config-client-polling](https://github.com/Azure-Samples/azure-spring-apps-samples/tree/main/config-client-polling) sample.
362395

396+
::: zone pivot="sc-enterprise"
363397
## Enable/disable Spring Cloud Config Server after service creation
364398

365399
You can enable and disable Spring Cloud Config Server after service creation using the Azure portal or Azure CLI. Before disabling Spring Cloud Config Server, you're required to unbind all of your apps from it.
@@ -388,8 +422,8 @@ az spring config-server delete \
388422
--resource-group <resource-group-name> \
389423
--service <Azure-Spring-Apps-service-instance-name>
390424
```
391-
392425
---
426+
::: zone-end
393427

394428
## Next steps
395429

328 KB
Loading
224 KB
Loading
254 KB
Loading
264 KB
Loading

articles/spring-apps/enterprise/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,8 @@ items:
134134
href: how-to-enterprise-configure-apm-integration-and-ca-certificates.md
135135
- name: Use Service Registry
136136
href: how-to-enterprise-service-registry.md
137+
- name: Set up a Config Server
138+
href: how-to-enterprise-config-server.md?pivots=sc-enterprise
137139
- name: Use API portal
138140
href: how-to-use-enterprise-api-portal.md
139141
- name: Spring Cloud Gateway

0 commit comments

Comments
 (0)