Skip to content

Commit 2fd6e0a

Browse files
committed
edit pass: six-azure-managed-instance-for-apache-cassandra-articles
1 parent be2847a commit 2fd6e0a

File tree

5 files changed

+216
-208
lines changed

5 files changed

+216
-208
lines changed
Lines changed: 45 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Azure Managed Instance for Apache Cassandra Customer-managed keys
3-
description: Customer-managed keys
2+
title: Azure Managed Instance for Apache Cassandra customer-managed keys
3+
description: Learn how to implement customer-managed keys in Azure Managed Instance for Apache Cassandra by using Azure Key Vault.
44
author: TheovanKraay
55
ms.author: thvankra
66
ms.service: managed-instance-apache-cassandra
@@ -10,32 +10,32 @@ ms.custom: references_regions, devx-track-azurecli
1010

1111
---
1212

13-
# Customer-managed keys - overview
13+
# Customer-managed keys in Azure Managed Instance for Apache Cassandra
1414

15-
Azure Managed Instance for Apache Cassandra provides the capability to encrypt data on disk using your own key. This article describes how to implement customer-managed keys with Azure Key Vault.
15+
In Azure Managed Instance for Apache Cassandra, you can encrypt data on disk by using your own key. This article describes how to implement customer-managed keys by using Azure Key Vault.
1616

1717
## Prerequisites
1818

19-
- Set up a secret using Azure Key Vault. Learn more about Azure Key Vault [here](../key-vault/secrets/about-secrets.md).
20-
- Deployed a virtual network in your resource group, and applied the network contributor role with the Azure Cosmos DB service principal as a member. See [Create an Azure Managed Instance for Apache Cassandra cluster using Azure CLI](create-cluster-cli.md) for more detail.
19+
- Set up a secret by using Azure Key Vault. For more information, see [About Azure Key Vault secrets](../key-vault/secrets/about-secrets.md).
20+
- Deploy a virtual network in your resource group.
21+
- Apply the network contributor role with the Azure Cosmos DB service principal as a member. Use the following command:
2122

22-
> [!IMPORTANT]
23-
> This article requires the Azure CLI version 2.30.0 or higher. If you are using Azure Cloud Shell, the latest version is already installed.
23+
```azurecli-interactive
24+
az role assignment create \
25+
--assignee a232010e-820c-4083-83bb-3ace5fc29d0b \
26+
--role 4d97b98b-1d4f-4787-a291-c67834d212e7 \
27+
--scope /subscriptions/<subscriptionID>/resourceGroups/<resourceGroupName>/providers/Microsoft.Network/virtualNetworks/<vnetName>
28+
```
2429

25-
## <a id="create-cluster"></a>Create a cluster with system assigned identity
30+
Applying the appropriate role to your virtual network helps you avoid failure when you deploy an Azure Managed Instance for Apache Cassandra cluster. For more information, see [Create an Azure Managed Instance for Apache Cassandra cluster by using the Azure CLI](create-cluster-cli.md).
2631

27-
> [!NOTE]
28-
> As mentioned in pre-requisites, to avoid deployment failure, make sure you have applied the appropriate role to your virtual network before attempting to deploy a managed instance cluster:
29-
> ```azurecli-interactive
30-
> az role assignment create \
31-
> --assignee a232010e-820c-4083-83bb-3ace5fc29d0b \
32-
> --role 4d97b98b-1d4f-4787-a291-c67834d212e7 \
33-
> --scope /subscriptions/<subscriptionID>/resourceGroups/<resourceGroupName>/providers/Microsoft.Network/virtualNetworks/<vnetName>
34-
> ```
32+
This article requires Azure CLI version 2.30.0 or later. If you're using Azure Cloud Shell, the latest version is already installed.
3533

36-
1. Create a cluster by specifying identity type as SystemAssigned, replacing `<subscriptionID>`, `<resourceGroupName>`, `<vnetName>`, and `<subnetName>` with the appropriate values:
34+
## <a id="create-cluster"></a>Create a cluster with a system-assigned identity
3735

38-
```azurecli-interactive
36+
1. Create a cluster by using the following command. Replace `<subscriptionID>`, `<resourceGroupName>`, `<vnetName>`, and `<subnetName>` with the appropriate values.
37+
38+
```azurecli-interactive
3939
subnet="/subscriptions/<subscriptionID>/resourceGroups/<resourceGroupName>/providers/Microsoft.Network/virtualNetworks/<vnetName>/subnets/<subnetName>"
4040
cluster="thvankra-cmk-test-wcus"
4141
group="thvankra-nova-cmk-test"
@@ -51,13 +51,13 @@ Azure Managed Instance for Apache Cassandra provides the capability to encrypt d
5151
--initial-cassandra-admin-password $password
5252
```
5353
54-
1. Get the identity information of the created cluster
54+
1. Get the identity information of the created cluster:
5555
5656
```azurecli-interactive
5757
az managed-cassandra cluster show -c $cluster -g $group
5858
```
5959
60-
The output will include an identity section like the below. Copy `principalId` for later use:
60+
The output includes an identity section like the following example. Copy the `principalId` value for later use.
6161
6262
```shell
6363
"identity": {
@@ -66,37 +66,35 @@ Azure Managed Instance for Apache Cassandra provides the capability to encrypt d
6666
"type": "SystemAssigned"
6767
}
6868
```
69-
70-
1. In Azure Key Vault, create an access policy to your keys:
7169
72-
:::image type="content" source="./media/cmk/key-vault-access-policy-1.png" alt-text="Key Vault Access policy 1" lightbox="./media/cmk/key-vault-access-policy-1.png" border="true":::
70+
1. In the Azure portal, go to your key vault and select **Access policies**. Then select **Add Access Policy** to create an access policy for your keys:
71+
72+
:::image type="content" source="./media/cmk/key-vault-access-policy-1.png" alt-text="Screenshot that shows the pane for access policies in the Azure portal." lightbox="./media/cmk/key-vault-access-policy-1.png" border="true":::
7373
74-
1. Assign `get`, `wrap` and `unwrap` key permissions on the key vault to the cluster's `principalId` retrieved above. In the portal, you can also look up the Principal ID of the cluster by the cluster's name:
75-
74+
1. For **Key permissions**, select **get**, **wrap**, and **unwrap**. Choose the **Select principal** box to open the **Principal** pane. Enter the cluster's `principalId` value that you retrieved earlier, and then choose the **Select** button. (In the portal, you can also look up the principal ID of the cluster by the cluster's name.)
7675
77-
:::image type="content" source="./media/cmk/key-vault-access-policy-2.png" alt-text="Key Vault Access policy 2" lightbox="./media/cmk/key-vault-access-policy-2.png" border="true":::
76+
:::image type="content" source="./media/cmk/key-vault-access-policy-2.png" alt-text="Screenshot that shows an example of adding a principal for an access policy." lightbox="./media/cmk/key-vault-access-policy-2.png" border="true":::
7877
7978
> [!WARNING]
80-
> Make sure the key vault has Purge Protection enabled. Datacenter deployments will fail without it.
79+
> Make sure that the key vault has purge protection turned on. Datacenter deployments will fail without it.
8180
82-
1. After you click on `add` to add the access policy, make sure you save it:
81+
1. Select **Add** to add the access policy, and then select **Save**.
8382
84-
:::image type="content" source="./media/cmk/save.png" alt-text="Save Access policy" lightbox="./media/cmk/key-vault-access-policy-2.png" border="true":::
83+
:::image type="content" source="./media/cmk/save.png" alt-text="Screenshot that shows the button for saving an access policy." lightbox="./media/cmk/key-vault-access-policy-2.png" border="true":::
8584
86-
1. To get the key identifier, select your key:
85+
1. To get the key identifier, select your key.
8786
8887
:::image type="content" source="./media/cmk/select-key.png" alt-text="Select key" lightbox="./media/cmk/key-identifier-1.png" border="true":::
8988
90-
1. Click on current version:
89+
1. Select the current version:
9190
9291
:::image type="content" source="./media/cmk/current-version.png" alt-text="Select current version" lightbox="./media/cmk/key-identifier-1.png" border="true":::
9392
94-
1. Save the key identifier for later use:
93+
1. Save the key identifier for later use.
9594
9695
:::image type="content" source="./media/cmk/key-identifier-2.png" alt-text="Key identifier step 2" lightbox="./media/cmk/key-identifier-1.png" border="true":::
9796
98-
99-
1. Create the datacenter by replacing `<key identifier>` with the same key (the uri you copied in previous step) for both managed disk (managed-disk-customer-key-uri) and backup storage (backup-storage-customer-key-uri) encryption as shown below (use the same value for `subnet` you used earlier):
97+
1. Create the datacenter by replacing `<key identifier>` with the same key (the uri you copied in previous step) for both managed disk (managed-disk-customer-key-uri) and backup storage (backup-storage-customer-key-uri) encryption as shown below (use the same value for `subnet` you used earlier):
10098
10199
```azurecli-interactive
102100
managedDiskKeyUri = "<key identifier>"
@@ -126,18 +124,18 @@ Azure Managed Instance for Apache Cassandra provides the capability to encrypt d
126124
az managed-cassandra cluster update --identity-type SystemAssigned -g $group -c $cluster
127125
```
128126
129-
## <a id="update-cluster"></a>Rotating the key
127+
## <a id="update-cluster"></a>Rotate the key
130128
131-
1. Below is the command to update the key:
129+
To update the key, use this command:
132130
133-
```azurecli-interactive
134-
managedDiskKeyUri = "<key identifier>"
135-
backupStorageKeyUri = "<key identifier>"
131+
```azurecli-interactive
132+
managedDiskKeyUri = "<key identifier>"
133+
backupStorageKeyUri = "<key identifier>"
136134
137-
az managed-cassandra datacenter update \
138-
--resource-group $group \
139-
--cluster-name $cluster \
140-
--data-center-name $dc \
141-
--managed-disk-customer-key-uri $managedDiskKeyUri \
142-
--backup-storage-customer-key-uri $backupStorageKeyUri
143-
```
135+
az managed-cassandra datacenter update \
136+
--resource-group $group \
137+
--cluster-name $cluster \
138+
--data-center-name $dc \
139+
--managed-disk-customer-key-uri $managedDiskKeyUri \
140+
--backup-storage-customer-key-uri $backupStorageKeyUri
141+
```

articles/managed-instance-apache-cassandra/jaeger.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.date: 12/08/2023
1313

1414
Jaeger is a distributed tracing platform for monitoring microservices. It enables the fast identification of performance challenges and optimization through features like tracing instrumentation and logging integration.
1515

16-
The article details the use of the sample application HotROD and Jaeger alongside Azure Managed Instance for Apache Cassandra for efficient storage monitoring.
16+
This article details the use of the sample application HotROD and Jaeger alongside Azure Managed Instance for Apache Cassandra for efficient storage monitoring.
1717

1818
## Prerequisites and setup
1919

@@ -42,7 +42,7 @@ The article details the use of the sample application HotROD and Jaeger alongsid
4242
...
4343
```
4444

45-
1. To connect your Azure Managed Instance Cassandra cluster, add the Cassandra sign-in credentials to the `cassandra-schema` section:
45+
1. To connect your Azure Managed Instance for Apache Cassandra cluster, add the Cassandra sign-in credentials to the `cassandra-schema` section:
4646

4747
```yml
4848
environment:
@@ -59,19 +59,19 @@ The article details the use of the sample application HotROD and Jaeger alongsid
5959
:::image type="content" source="./media/jaeger/jaeger-running.png" alt-text="Screenshot of a running Jaeger application." lightbox="./media/jaeger/jaeger-running.png" border="true":::
6060

6161
> [!TIP]
62-
> Five containers are created, and you should be able to access the test application at `http://localhost:8080/` to generate traces that can be viewed at `http://localhost:16686/search`.
62+
> The command creates five containers. You can access the test application at `http://localhost:8080/` to generate traces that you can view at `http://localhost:16686/search`.
6363

64-
1. Once the containers are running, access the Jaeger UI to view traces from the application.
64+
1. After the containers are running, use the Jaeger UI to view traces from the application.
6565

66-
:::image type="content" source="./media/jaeger/jaeger-page-1.png" alt-text="Screenshot of jaeger web interface." lightbox="./media/jaeger/jaeger-page-1.png" border="true":::
66+
:::image type="content" source="./media/jaeger/jaeger-page-1.png" alt-text="Screenshot of the Jaeger web interface." lightbox="./media/jaeger/jaeger-page-1.png" border="true":::
6767

68-
1. Verify by inspecting your Azure Managed Instance cluster.
68+
1. Verify by inspecting your Azure Managed Instance for Apache Cassandra cluster.
6969

70-
:::image type="content" source="./media/jaeger/jaeger-table-1.png" alt-text="Screenshot of jaeger tables in managed instance cluster." lightbox="./media/jaeger/jaeger-table-1.png" border="true":::
70+
:::image type="content" source="./media/jaeger/jaeger-table-1.png" alt-text="Screenshot of Jaeger tables in a managed instance cluster." lightbox="./media/jaeger/jaeger-table-1.png" border="true":::
7171

72-
1. Refer to the traces table to view the data related to step 7.
72+
1. Refer to the `traces` table to view the data related to step 7.
7373

74-
:::image type="content" source="./media/jaeger/jaeger-table-2.png" alt-text="Screenshot of jaeger trace table." lightbox="./media/jaeger/jaeger-table-2.png" border="true":::
74+
:::image type="content" source="./media/jaeger/jaeger-table-2.png" alt-text="Screenshot of the Jaeger traces table." lightbox="./media/jaeger/jaeger-table-2.png" border="true":::
7575

7676
## Support
7777

0 commit comments

Comments
 (0)