Skip to content

Commit 99231c8

Browse files
SteveSaunders1952SteveSaunders1952
committed
edits and cleanup
1 parent 0e78f00 commit 99231c8

File tree

2 files changed

+25
-25
lines changed

2 files changed

+25
-25
lines changed

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

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ ms.custom: devx-track-java, event-tier1-build-2022
2020

2121
This article shows you how to configure a managed Spring Cloud Config Server in Azure Spring Apps service.
2222

23-
Spring Cloud Config Server provides server and client-side support for an externalized configuration in a distributed system. The Config Server instance provides a central place to manage external properties for applications across all environments. For more information, see the [Spring Cloud Config Server reference](https://spring.io/projects/spring-cloud-config).
23+
Spring Cloud Config Server provides server and client-side support for an externalized configuration in a distributed system. The 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).
2424

2525
## Prerequisites
2626

2727
- 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 of basic or standard tier. To set up and launch an Azure Spring Apps service, see [Quickstart: Launch a Java Spring application by using the Azure CLI](./quickstart.md). Spring Cloud Config Server isn't applicable to enterprise tier.
28+
- An already provisioned and running Azure Spring Apps service of basic or standard tier. To set up and launch an Azure Spring Apps service, see [Quickstart: Deploy your first application to Azure Spring Apps](./quickstart.md). Spring Cloud Config Server isn't applicable to enterprise tier.
2929

3030
## Restriction
3131

@@ -52,61 +52,61 @@ Azure Spring Apps supports Azure DevOps, GitHub, GitLab, and Bitbucket for stori
5252
Additionally, some configurable properties are available only for certain types. The following subsections list the properties for each repository type.
5353

5454
> [!NOTE]
55-
> Config Server takes `master` (on Git) as the default label if you don't specify one. However, GitHub has recently changed the default branch from `master` to `main`. To avoid Azure Spring Apps Config Server failure, be sure to pay attention to the default label when setting up Config Server with GitHub, especially for newly-created repositories.
55+
> Config Server takes *master* (on Git) as the default label if you don't specify one. However, GitHub has recently changed the default branch from *master* to *main*. To avoid Azure Spring Apps Config Server failure, be sure to pay attention to the default label when setting up Config Server with GitHub, especially for newly-created repositories.
5656
5757
### Public repository
5858

59-
When you use a public repository, your configurable properties are more limited.
59+
When you use a public repository, your configurable properties are more limited than with a private repository.
6060

61-
All configurable properties that are used to set up the public Git repository are listed in the following table:
61+
The following table lists the configurable properties that you can use to set up a public Git repository.
6262

6363
> [!NOTE]
6464
> Using a hyphen (-) to separate words is the only naming convention that's currently supported. For example, you can use *default-label*, but not *defaultLabel*.
6565
6666
| Property | Required | Feature |
6767
|:----------------|----------|---------------------------------------------------------------------------------------------------------------------------------|
68-
| `uri` | Yes | The URI of the Git repository that's used as the Config Server back end begins with *http://*, *https://*, *git@*, or *ssh://*. |
69-
| `default-label` | No | The default label of the Git repository, should be the *branch name*, *tag name*, or *commit-id* of the repository. |
68+
| `uri` | Yes | The URI of the Git repository that's used as the Config Server back end. Should begin with `http://`, `https://`, `git@`, or `ssh://`. |
69+
| `default-label` | No | The default label of the Git repository. Should be the branch name, tag name, or commit ID of the repository. |
7070
| `search-paths` | No | An array of strings that are used to search subdirectories of the Git repository. |
7171

7272
### Private repository with SSH authentication
7373

74-
All configurable properties used to set up private Git repository with SSH are listed in the following table:
74+
The following table lists the configurable properties that you can use to set up a private Git repository with SSH.
7575

7676
> [!NOTE]
7777
> Using a hyphen (-) to separate words is the only naming convention that's currently supported. For example, you can use *default-label*, but not *defaultLabel*.
7878
7979
| Property | Required | Feature |
8080
|:---------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
81-
| `uri` | Yes | The URI of the Git repository used as the Config Server back end, should be started with *http://*, *https://*, *git@*, or *ssh://*. |
82-
| `default-label` | No | The default label of the Git repository, should be the *branch name*, *tag name*, or *commit-id* of the repository. |
81+
| `uri` | Yes | The URI of the Git repository used as the Config Server back end. Should begin with `http://`, `https://`, `git@`, or `ssh://`. |
82+
| `default-label` | No | The default label of the Git repository. Should be the branch name, tag name, or commit ID of the repository. |
8383
| `search-paths` | No | An array of strings used to search subdirectories of the Git repository. |
84-
| `private-key` | No | The SSH private key to access the Git repository, required when the URI starts with *git@* or *ssh://*. |
85-
| `host-key` | No | The host key of the Git repository server shouldn't include the algorithm prefix as covered by `host-key-algorithm`. |
86-
| `host-key-algorithm` | No | The host key algorithm should be *ssh-dss*, *ssh-rsa*, *ecdsa-sha2-nistp256*, *ecdsa-sha2-nistp384*, or *ecdsa-sha2-nistp521*. *Required* only if `host-key` exists. |
84+
| `private-key` | No | The SSH private key to access the Git repository. Required when the URI starts with `git@` or `ssh://`. |
85+
| `host-key` | No | The host key of the Git repository server. Shouldn't include the algorithm prefix as covered by `host-key-algorithm`. |
86+
| `host-key-algorithm` | No | The host key algorithm. Should be *ssh-dss*, *ssh-rsa*, *ecdsa-sha2-nistp256*, *ecdsa-sha2-nistp384*, or *ecdsa-sha2-nistp521*. Required only if `host-key` exists. |
8787
| `strict-host-key-checking` | No | Indicates whether the Config Server instance will fail to start when using the private `host-key`. Should be *true* (default value) or *false*. |
8888

8989
> [!NOTE]
9090
> Config Server doesn't support SHA-2 signatures yet. Until support is added, use SHA-1 signatures or basic auth instead.
9191
9292
### Private repository with basic authentication
9393

94-
All configurable properties used to set up a private Git repository with basic authentication are listed below.
94+
The following table lists the configurable properties that you can use to set up a private Git repository with basic authentication.
9595

9696
> [!NOTE]
9797
> Using a hyphen (-) to separate words is the only naming convention that's currently supported. For example, use *default-label*, not *defaultLabel*.
9898
9999
| Property | Required | Feature |
100100
|:----------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
101-
| `uri` | Yes | The URI of the Git repository that's used as the Config Server back end should be started with *http://*, *https://*, *git@*, or *ssh://*. |
102-
| `default-label` | No | The default label of the Git repository, should be the *branch name*, *tag name*, or *commit-id* of the repository. |
101+
| `uri` | Yes | The URI of the Git repository that's used as the Config Server back end. Should begin with `http://`, `https://`, `git@`, or `ssh://`.
102+
| `default-label` | No | The default label of the Git repository. Should be the *branch name*, *tag name*, or *commit-id* of the repository. |
103103
| `search-paths` | No | An array of strings used to search subdirectories of the Git repository. |
104-
| `username` | No | The username that's used to access the Git repository server, required when the Git repository server supports `Http Basic Authentication`. |
105-
| `password` | No | The password or personal access token used to access the Git repository server, required when the Git repository server supports `Http Basic Authentication`. |
104+
| `username` | No | The username that's used to access the Git repository server. Required when the Git repository server supports HTTP basic authentication. |
105+
| `password` | No | The password or personal access token used to access the Git repository server. Required when the Git repository server supports HTTP basic authentication. |
106106

107107
> [!NOTE]
108-
> 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.
109-
> GitHub has removed support for password authentication, so you'll need to use a personal access token instead of password authentication for GitHub. For more information, see [Token authentication](https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/).
108+
> 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.
109+
> GitHub has removed support for password authentication, so you'll need to use a personal access token instead of password authentication for GitHub. For more information, see [Token authentication requirements for Git operations](https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/).
110110
111111
### Other Git repositories
112112

@@ -130,7 +130,7 @@ All configurable properties used to set up Git repositories with a pattern are l
130130
| `repos."host-key-algorithm"` | No | The host key algorithm should be *ssh-dss*, *ssh-rsa*, *ecdsa-sha2-nistp256*, *ecdsa-sha2-nistp384*, or *ecdsa-sha2-nistp521*. Required only if `host-key` exists. |
131131
| `repos."strict-host-key-checking"` | No | Indicates whether the Config Server instance will fail to start when using the private `host-key`. Should be *true* (default value) or *false*. |
132132

133-
The following table shows some examples for the **Additional repositories** section. For more information, see [Pattern Matching and Multiple Repositories](https://cloud.spring.io/spring-cloud-config/reference/html/#_pattern_matching_and_multiple_repositories) in the Spring documentation.
133+
The following table shows some examples for the **Additional repositories** section. For more information, see the [Pattern Matching and Multiple Repositories section](https://cloud.spring.io/spring-cloud-config/reference/html/#_pattern_matching_and_multiple_repositories) of the Spring documentation.
134134

135135
| Patterns | Description |
136136
|:--------------------------------|------------------------------------------------------------------------------------------------------------------------|
@@ -176,7 +176,7 @@ Updating the configuration can take a few minutes. You should get a notification
176176

177177
> [!CAUTION]
178178
> Some Git repository servers use a *personal-token* or an *access-token*, such as a password, for **Basic Authentication**. You can use that kind of token as a password in Azure Spring Apps because it will never expire. But for other Git repository servers, such as Bitbucket and Azure DevOps Server, the *access-token* expires in one or two hours. As a result, this approach isn't viable when you use those repository servers with Azure Spring Apps.
179-
> GitHub has removed support for password authentication, so you'll need to use a personal access token instead of password authentication for GitHub. For more information, see [Token authentication](https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/).
179+
> GitHub has removed support for password authentication, so you'll need to use a personal access token instead of password authentication for GitHub. For more information, see [Token authentication requirements for Git operations](https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/).
180180
181181
- **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.
182182

@@ -218,8 +218,6 @@ Use the following steps to get your repo URL and credentials.
218218

219219
1. In the Azure Repos portal for your project, select the **Clone** button:
220220

221-
:::image type="content" source="media/how-to-config-server/clone-button.png" lightbox="media/how-to-config-server/clone-button.png" alt-text="Screenshot of the Clone button on the Azure Repos portal for your project.":::
222-
223221
1. Copy the clone URL from the textbox. This URL will typically be in the following form:
224222

225223
```text
@@ -261,7 +259,9 @@ Select **Reset** on the **Config Server** tab to erase your existing settings. D
261259

262260
## Config Server refresh
263261

264-
When properties are changed, services consuming those properties must be notified before changes can be made. The default solution for Spring Cloud Config is to manually trigger the [refresh event](https://spring.io/guides/gs/centralized-configuration/), which may not be feasible if there are lots of app instances. Instead, you can automatically refresh values from the config server by letting the config client poll for changes based on a refresh internal, as follows:
262+
When properties are changed, services consuming those properties must be notified before changes can be made. The default solution for Spring Cloud Config is to manually trigger the refresh event, which may not be feasible if there are many app instances. For more information, see [Centralized Configuration](https://spring.io/guides/gs/centralized-configuration/)
263+
264+
Instead, you can automatically refresh values from the config server by letting the config client poll for changes based on a refresh internal, as follows:
265265

266266
1. Register a scheduled task to refresh the context in a given interval.
267267

‎articles/spring-apps/media/how-to-config-server/clone-button.png

-1.22 KB
Binary file not shown.

0 commit comments

Comments
 (0)