Skip to content

Commit c457024

Browse files
committed
Editorial review changes
1 parent 44e19eb commit c457024

File tree

2 files changed

+23
-20
lines changed

2 files changed

+23
-20
lines changed

articles/spring-cloud/spring-cloud-github-actions-key-vault.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ ms.date: 01/20/2019
99
---
1010

1111
# Authenticate Azure Spring Cloud with Key Vault in Github Actions
12-
Key vault is a secure place to store keys. Enterprise users need to store credentials for CI/CD environments in scope that they control. The key to get credentials in the key vault should be limited to resource scope. The key to get credentials has access to only the key vault scope, not the entire Azure scope. It's like a key that can only open a strongbox not a master key that can open all doors in a building. It is a way to get a key with another key, but useful in a CICD workflow.
12+
Key vault is a secure place to store keys. Enterprise users need to store credentials for CI/CD environments in scope that they control. The key to get credentials in the key vault should be limited to resource scope. It has access to only the key vault scope, not the entire Azure scope. It's like a key that can only open a strong box not a master key that can open all doors in a building. It's a way to get a key with another key, but useful in a CICD workflow.
1313

14-
## Generate Credential to Access to Key Vault
15-
To generate the key to open the strongbox, execute command below on you local machine:
14+
## Generate Credential
15+
To generate a key to access the key vault, execute command below on your local machine:
1616
```
1717
az ad sp create-for-rbac --role contributor --scopes /subscriptions/<SUBSCRIPTION_ID>/resourceGroups/<RESOURCE_GROUP>/providers/Microsoft.KeyVault/vaults/<KEY_VAULT> --sdk-auth
1818
```
19-
Note the scope specified by the `--scopes` parameter, which limits the key access to the resource. It can only access the strongbox.
19+
Note the scope specified by the `--scopes` parameter, which limits the key access to the resource. It can only access the strong box.
2020

2121
With results:
2222
```
@@ -33,12 +33,12 @@ With results:
3333
"managementEndpointUrl": "https://management.core.windows.net/"
3434
}
3535
```
36-
Then save the results to GitHub **secrets** as described in[Set up your GitHub repository and authenticate with Azure](./spring-cloud-howto-github-actions.md#set-up-your-github-repository-and-authenticate-with-azure).
36+
Then save the results to GitHub **secrets** as described in [Set up your GitHub repository and authenticate with Azure](./spring-cloud-howto-github-actions.md#set-up-your-github-repository-and-authenticate-with-azure).
3737

3838
## Add Access Policies for the Credential
39-
The credential created above can only get general information about the Key Vault, not the contents it stores. To get secrets stored in the Key Vault, you need set access policies for the credential.
39+
The credential you created above can only get general information about the Key Vault, not the contents it stores. To get secrets stored in the Key Vault, you need set access policies for the credential.
4040

41-
Go to the **Key Vault** dashboard in Azure Portal, click the **Access control** menu, then open the **Role assignments** tab. Select **Apps** for **Type**, `This resource` for **scope**. You should see the credential you created in previous step:
41+
Go to the **Key Vault** dashboard in Azure portal, click the **Access control** menu, then open the **Role assignments** tab. Select **Apps** for **Type**, `This resource` for **scope**. You should see the credential you created in previous step:
4242

4343
![Set access policy](./media/github-actions/key-vault1.png)
4444

@@ -70,11 +70,11 @@ Again, results:
7070
"managementEndpointUrl": "https://management.core.windows.net/"
7171
}
7272
```
73-
Copy the entire JSON string. Bo back to **Key Vault** dashboard. Open the **Secrets** menu, then click the **Generate/Import** button. Input the secret name, such as `AZURE-CRENDENTIALS-FOR-SPRING`. Paste the JSON credential string to the **Value** input box. You may notice the value input box is a one-line text feild, rather then a multi-line text area. You can paste the complete JSON string there.
73+
Copy the entire JSON string. Bo back to **Key Vault** dashboard. Open the **Secrets** menu, then click the **Generate/Import** button. Input the secret name, such as `AZURE-CRENDENTIALS-FOR-SPRING`. Paste the JSON credential string to the **Value** input box. You may notice the value input box is a one-line text field, rather than a multi-line text area. You can paste the complete JSON string there.
7474

7575
![Full scope credential](./media/github-actions/key-vault3.png)
7676

77-
## Combine all credentials in GitHub Actions
77+
## Combine credentials in GitHub Actions
7878
Set the credentials used when the CICD pipeline executes:
7979

8080
```
@@ -86,7 +86,7 @@ jobs:
8686
steps:
8787
- uses: azure/login@v1
8888
with:
89-
creds: ${{ secrets.AZURE_CREDENTIALS }} # Strongbox key you generated in the first step
89+
creds: ${{ secrets.AZURE_CREDENTIALS }} # Strong box key you generated in the first step
9090
- uses: Azure/[email protected]
9191
with:
9292
keyvault: "zlhe-test"

articles/spring-cloud/spring-cloud-howto-github-actions.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ ms.date: 01/15/2019
1212
GitHub Actions support an automated software development lifecycle workflow. With GitHub Actions for Azure Spring Cloud you can create workflows in your repository to build, test, package, release, and deploy to Azure.
1313

1414
## Prerequisites
15-
This example requires the [Azure CLI](https://docs.microsoft.com/cli/azure/install-azure-cli?view=azure-cli-latest)
15+
This example requires the [Azure CLI](https://docs.microsoft.com/cli/azure/install-azure-cli?view=azure-cli-latest).
1616

17-
## Set up your GitHub repository and authenticate with Azure
17+
## Set up GitHub repository and authenticate
1818
You need an Azure service principle credential to authorize Azure login action. To get an Azure credential, execute the following commands on your local machine:
1919
```
2020
az login
@@ -39,14 +39,14 @@ This example uses the [Piggy Metrics](https://github.com/Azure-Samples/piggymetr
3939

4040
![Add new secret](./media/github-actions/actions1.png)
4141

42-
Set the secret name to AZURE_CREDENTIALS, and its value to the JSON string that you found under the heading *Set up your GitHub repository and authenticate with Azure*.
42+
Set the secret name to `AZURE_CREDENTIALS` and its value to the JSON string that you found under the heading *Set up your GitHub repository and authenticate with Azure*.
4343

4444
![Set secret data](./media/github-actions/actions2.png)
4545

46-
You can also get the Azure login credential from Key Vault in GitHub actions as explained in [Authenticate Azure Spring with Key Vault in Github Actions](./spring-cloud-github-actions-key-vault.md).
46+
You can also get the Azure login credential from Key Vault in GitHub actions as explained in [Authenticate Azure Spring with Key Vault in GitHub Actions](./spring-cloud-github-actions-key-vault.md).
4747

48-
## Provision Azure Spring Cloud service instance
49-
To provision your service instance, run the following commands using the Azure CLI.
48+
## Provision service instance
49+
To provision your Azure Spring Cloud service instance, run the following commands using the Azure CLI.
5050
```
5151
az extension add --name spring-cloud
5252
az group create --location eastus --name <resource group name>
@@ -111,7 +111,10 @@ jobs:
111111
az spring-cloud app deploy -n auth-service --jar-path ${{ github.workspace }}/auth-service/target/auth-service.jar
112112
```
113113
### Deploy with Azure CLI action
114-
The az `run` command will use the latest version of Azure CLI. In case of breaking changes, you can also use a specific version of Azure CLI with azure/CLI `action`. This will run all the az command in a new container, therefore note that `env` will not work, and cross action file access may have extra restrictions.
114+
The az `run` command will use the latest version of Azure CLI. If there are breaking changes, you can also use a specific version of Azure CLI with azure/CLI `action`.
115+
116+
> [!Note]
117+
> This command will run all the az command in a new container, so `env` will not work, and cross action file access may have extra restrictions.
115118
116119
Create the .github/workflow/main.yml file in the repository:
117120
```
@@ -188,13 +191,13 @@ jobs:
188191
## Run the workflow
189192
GitHub Actions should be enabled automatically after you push `.github/workflow/main.yml` to GitHub. The action will be triggered when you push a new commit. If you create this file in the browser, your action should have already run.
190193

191-
To verify your action has been enabled, click **Actions** tab on the GitHub repository page:
194+
To verify that the action has been enabled, click **Actions** tab on the GitHub repository page:
192195

193196
![Verify action enabled](./media/github-actions/actions3.png)
194197

195-
If your action runs in error, for example, you haven't set Azure credential, you can re-run checks after fixing the error. On GitHub repository page, click **Actions**, select the specific workflow task, then click Re-run checks button to re-run checks:
198+
If your action runs in error, for example, if you haven't set Azure credential, you can rerun checks after fixing the error. On the GitHub repository page, click **Actions**, select the specific workflow task, and then click Rerun checks button to rerun checks:
196199

197-
![Re-run checks](./media/github-actions/actions4.png)
200+
![Rerun checks](./media/github-actions/actions4.png)
198201

199202
## Next steps
200203
* [Key Vault for Spring Cloud GitHub actions](./spring-cloud-github-actions-key-vault.md)

0 commit comments

Comments
 (0)