Skip to content

Commit bfb5e4d

Browse files
brhamilton529brhamilton529
committed
initial edits, added tabs for portal/cli
1 parent 19337b9 commit bfb5e4d

File tree

1 file changed

+33
-25
lines changed

1 file changed

+33
-25
lines changed

‎articles/spring-apps/how-to-enterprise-application-configuration-service.md

Lines changed: 33 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: karlerickson
66
ms.author: xiading
77
ms.service: spring-apps
88
ms.topic: how-to
9-
ms.date: 02/09/2022
9+
ms.date: 02/02/2023
1010
ms.custom: devx-track-java, event-tier1-build-2022, engagement-fy23
1111
---
1212

@@ -17,7 +17,7 @@ ms.custom: devx-track-java, event-tier1-build-2022, engagement-fy23
1717
1818
**This article applies to:** ❌ Basic/Standard tier ✔️ Enterprise tier
1919

20-
This article shows you how to use Application Configuration Service for VMware Tanzu® with Azure Spring Apps Enterprise Tier.
20+
This article shows how to use Application Configuration Service for VMware Tanzu® with Azure Spring Apps Enterprise Tier.
2121

2222
[Application Configuration Service for VMware Tanzu](https://docs.pivotal.io/tcs-k8s/0-1/) is one of the commercial VMware Tanzu components. It enables the management of Kubernetes-native `ConfigMap` resources that are populated from properties defined in one or more Git repositories.
2323

@@ -28,29 +28,34 @@ With Application Configuration Service for Tanzu, you have a central place to ma
2828
- An already provisioned Azure Spring Apps Enterprise tier instance with Application Configuration Service for Tanzu enabled. For more information, see [Quickstart: Build and deploy apps to Azure Spring Apps using the Enterprise tier](quickstart-deploy-apps-enterprise.md).
2929

3030
> [!NOTE]
31-
> To use Application Configuration Service for Tanzu, you must enable it when you provision your Azure Spring Apps service instance. You can't enable it after you provision the instance.
31+
> To use Application Configuration Service for Tanzu, you must enable it when you provision your Azure Spring Apps service instance. You can't enable the service after you provision the instance.
3232
3333
## Manage Application Configuration Service for Tanzu settings
3434

3535
Application Configuration Service for Tanzu supports Azure DevOps, GitHub, GitLab, and Bitbucket for storing your configuration files.
3636

37-
To manage the service settings, open the **Settings** section and add a new entry under the **Repositories** section.
37+
To manage service settings in your Azure Spring Apps instance, perform the following steps:
3838

39-
:::image type="content" source="media/how-to-enterprise-application-configuration-service/config-service-settings.png" alt-text="Screenshot of the Application Configuration Service page showing how to add a repository." lightbox="media/how-to-enterprise-application-configuration-service/config-service-settings.png":::
39+
1. Select **Application Configuration Service** under **VMWare Tanzu components** in the navigation pane.
40+
41+
1. Select **Settings** and add a new entry is **Repositories**.
42+
43+
:::image type="content" source="media/how-to-enterprise-application-configuration-service/config-service-settings.png" alt-text="Screenshot of the Application Configuration Service page showing how to add a repository." lightbox="media/how-to-enterprise-application-configuration-service/config-service-settings.png":::
4044

4145
The following table describes properties for each entry.
4246

43-
| Property | Required? | Description |
44-
|---------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
45-
| `Name` | Yes | A unique name to label each Git repository. |
46-
| `Patterns` | Yes | Patterns to search in Git repositories. For each pattern, use a format such as *{application}* or *{application}/{profile}* rather than *{application}-{profile}.yml*. Separate the patterns with commas. For more information, see the [Pattern](./how-to-enterprise-application-configuration-service.md#pattern) section of this article. |
47-
| `URI` | Yes | A Git URI (for example, `https://github.com/Azure-Samples/piggymetrics-config` or `[email protected]:Azure-Samples/piggymetrics-config`) |
48-
| `Label` | Yes | The branch name to search in the Git repository. |
49-
| `Search path` | No | Optional search paths, separated by commas, for searching subdirectories of the Git repository. |
47+
| Property | Required | Description |
48+
|---------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
49+
| **Name** | Yes | A unique name to label each Git repository. |
50+
| **Patterns** | Yes | Patterns to search in Git repositories. For each pattern, use a format such as *{application}* or *{application}/{profile}* rather than *{application}-{profile}.yml*. Separate the patterns with commas. For more information, see the [Pattern](./how-to-enterprise-application-configuration-service.md#pattern) section of this article. |
51+
| **URI** | Yes | A Git URI. For example: `https://github.com/Azure-Samples/piggymetrics-config` or `[email protected]:Azure-Samples/piggymetrics-config` |
52+
| **Label** | Yes | The branch name to search in the Git repository. |
53+
| **Search path** | No | Optional search paths, separated by commas, for searching subdirectories of the Git repository. |
54+
| **Authentication** | Yes | Select from supported authentications. |
5055

51-
### Pattern
56+
### Patterns
5257

53-
Configuration is pulled from Git backends using what you define in a pattern. A pattern is a combination of *{application}/{profile}* as described in the following guidelines.
58+
A configuration is pulled from Git backends by using what you define in a pattern. A pattern is a combination of *{application}/{profile}* as described in the following guidelines.
5459

5560
- *{application}* - The name of an application whose configuration you're retrieving. The value `application` is considered the default application and includes configuration information shared across multiple applications. Any other value refers to a specific application and includes properties for both the specific application and shared properties for the default application.
5661
- *{profile}* - Optional. The name of a profile whose properties you may be retrieving. An empty value, or the value `default`, includes properties that are shared across profiles. Non-default values include properties for the specified profile and properties for the default profile.
@@ -78,15 +83,15 @@ The following image shows the three types of repository authentication supported
7883

7984
The following table shows the configurable properties you can use to set up a private Git repository with SSH.
8085

81-
| Property | Required? | Description |
86+
| Property | Required | Description |
8287
|----------------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
8388
| `Private key` | Yes | The private key that identifies the Git user. Passphrase-encrypted private keys aren't supported. |
8489
| `Host key` | No | The host key of the Git server. If you've connected to the server via Git on the command line, the host key is in your *.ssh/known_hosts* file. Don't include the algorithm prefix, because it's specified in `Host key algorithm`. |
85-
| `Host key algorithm` | No | The algorithm for `hostKey`: one of `ssh-dss`, `ssh-rsa`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, and `ecdsa-sha2-nistp521`. (Required if supplying `Host key`). |
90+
| `Host key algorithm` | No | The algorithm for `Host Key`: one of `ssh-dss`, `ssh-rsa`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, and `ecdsa-sha2-nistp521`. Required if supplying `Host key`. |
8691
| `Strict host key checking` | No | Optional value that indicates whether the backend should be ignored if it encounters an error when using the provided `Host key`. Valid values are `true` and `false`. The default value is `true`. |
8792

8893
> [!NOTE]
89-
> Application Configuration Service for Tanzu uses RSA keys with SHA-1 signatures for now. If you're using GitHub, for RSA public keys added to GitHub before November 2, 2021, the corresponding private key is supported. For RSA public keys added to GitHub after November 2, 2021, the corresponding private key is not supported, and we suggest using basic authentication instead.
94+
> Application Configuration Service for Tanzu currently uses RSA keys with SHA-1 signatures. If you're using GitHub, for the RSA public keys added to GitHub before November 2, 2021, the corresponding private key is supported. For the RSA public keys added to GitHub after November 2, 2021, the corresponding private key is not supported and we suggest using basic authentication.
9095
9196
To validate access to the target URI, select **Validate**. After validation completes successfully, select **Apply** to update the configuration settings.
9297

@@ -100,7 +105,7 @@ Use the following steps to refresh your application configuration after you upda
100105

101106
1. Load the configuration to your application.
102107

103-
A Spring application holds the properties as the beans of the Spring Application Context via the Environment interface. The following list shows several ways to load the new configurations:
108+
A Spring application holds the properties as the beans of the Spring Application Context via the Environment interface. The following scenarios show different ways to load the new configurations:
104109

105110
- Restart the application. Restarting the application always loads the new configuration.
106111

@@ -139,10 +144,12 @@ A Spring application holds the properties as the beans of the Spring Application
139144
curl -X POST http://{app-endpoint}/actuator/refresh
140145
```
141146

142-
## Configure Application Configuration Service for Tanzu settings using the portal
147+
## Configure Application Configuration Service for Tanzu settings
143148

144149
Use the following steps to configure Application Configuration Service for Tanzu using the portal.
145150

151+
### [Azure portal](#tab/Portal)
152+
146153
1. Select **Application Configuration Service**.
147154
1. Select **Overview** to view the running state and resources allocated to Application Configuration Service for Tanzu.
148155

@@ -154,10 +161,9 @@ Use the following steps to configure Application Configuration Service for Tanzu
154161

155162
:::image type="content" source="media/how-to-enterprise-application-configuration-service/config-service-settings.png" alt-text="Screenshot of the Application Configuration Service page showing the Settings tab." lightbox="media/how-to-enterprise-application-configuration-service/config-service-settings.png":::
156163

157-
## Configure Application Configuration Service for Tanzu settings using the CLI
158-
159-
Use the following steps to configure Application Configuration Service for Tanzu using the CLI.
164+
### [Azure CLI](#tab/Azure-CLI)
160165

166+
Use the following steps to configure Application Configuration Service for Tanzu.
161167
```azurecli
162168
az spring application-configuration-service git repo add \
163169
--name <entry-name> \
@@ -166,10 +172,12 @@ az spring application-configuration-service git repo add \
166172
--label <git-branch-name>
167173
```
168174

169-
## Use Application Configuration Service for Tanzu with applications using the portal
175+
## Use Application Configuration Service for Tanzu with applications
170176

171177
When you use Application Configuration Service for Tanzu with a Git back end and use the centralized configurations, you must bind the app to Application Configuration Service for Tanzu. After binding the app, use the following steps to configure the pattern to be used by the app.
172178

179+
### [Azure portal](#tab/Portal)
180+
173181
1. Open the **App binding** tab.
174182

175183
1. Select **Bind app** and choose one app in the dropdown. Select **Apply** to bind.
@@ -193,7 +201,7 @@ When you use Application Configuration Service for Tanzu with a Git back end and
193201

194202
1. Select **Save**
195203

196-
## Use Application Configuration Service for Tanzu with applications using the CLI
204+
### [Azure CLI](#tab/Azure-CLI)
197205

198206
Use the following command to use Application Configuration Service for Tanzu with applications.
199207

@@ -207,7 +215,7 @@ az spring app deploy \
207215

208216
## Enable/Disable Application Configuration Service after service creation
209217

210-
You can enable/disable Application Configuration Service after service creation using Azure portal or Azure CLI. Before disabling it, it's required to unbind all of your apps to Application Configuration Service.
218+
You can enable and disable Application Configuration Service after service creation using Azure portal or Azure CLI. Before disabling it, it's required to unbind all of your apps to Application Configuration Service.
211219

212220
### [Azure portal](#tab/Portal)
213221

0 commit comments

Comments
 (0)