Merge pull request #268121 from ShawnJackson/six-azure-managed-instance-for-apache-cassandra-articles

[AQ] edit pass: Six Azure Managed Instance for Apache Cassandra articles

Author: ktoliver

articles/managed-instance-apache-cassandra/customer-managed-keys.md

@@ -1,6 +1,6 @@
 ---
-title: Azure Managed Instance for Apache Cassandra Customer-managed keys
-description: Customer-managed keys
+title: Azure Managed Instance for Apache Cassandra customer-managed keys
+description: Learn how to implement customer-managed keys in Azure Managed Instance for Apache Cassandra by using Azure Key Vault.
 author: TheovanKraay
 ms.author: thvankra
 ms.service: managed-instance-apache-cassandra
@@ -10,32 +10,32 @@ ms.custom: references_regions, devx-track-azurecli
 
 ---
 
-# Customer-managed keys - overview
+# Customer-managed keys in Azure Managed Instance for Apache Cassandra
 
-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.
+In Azure Managed Instance for Apache Cassandra, you can use your own key to encrypt data on disk. This article describes how to implement customer-managed keys by using Azure Key Vault.
 
 ## Prerequisites
 
-- Set up a secret using Azure Key Vault. Learn more about Azure Key Vault [here](../key-vault/secrets/about-secrets.md).
-- 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. 
+- Set up a secret by using Azure Key Vault. For more information, see [About Azure Key Vault secrets](../key-vault/secrets/about-secrets.md).
+- Deploy a virtual network in your resource group.
+- Apply the Network Contributor role with the Azure Cosmos DB service principal as a member. Use the following command:
 
-> [!IMPORTANT]
-> 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.
+  ```azurecli-interactive  
+      az role assignment create \
+      --assignee a232010e-820c-4083-83bb-3ace5fc29d0b \
+      --role 4d97b98b-1d4f-4787-a291-c67834d212e7 \
+      --scope /subscriptions/<subscriptionID>/resourceGroups/<resourceGroupName>/providers/Microsoft.Network/virtualNetworks/<vnetName>
+  ```
 
-## <a id="create-cluster"></a>Create a cluster with system assigned identity
+  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).
 
-   > [!NOTE]
-   > 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:
-   > ```azurecli-interactive  
-   >     az role assignment create \
-   >     --assignee a232010e-820c-4083-83bb-3ace5fc29d0b \
-   >     --role 4d97b98b-1d4f-4787-a291-c67834d212e7 \
-   >     --scope /subscriptions/<subscriptionID>/resourceGroups/<resourceGroupName>/providers/Microsoft.Network/virtualNetworks/<vnetName>
-   > ```
+This article requires Azure CLI version 2.30.0 or later. If you're using Azure Cloud Shell, the latest version is already installed.
 
-1. Create a cluster by specifying identity type as SystemAssigned, replacing `<subscriptionID>`, `<resourceGroupName>`, `<vnetName>`, and `<subnetName>` with the appropriate values:
+## <a id="create-cluster"></a>Create a cluster with a system-assigned identity
 
-    ```azurecli-interactive    
+1. Create a cluster by using the following command. Replace `<subscriptionID>`, `<resourceGroupName>`, `<vnetName>`, and `<subnetName>` with the appropriate values.
+
+    ```azurecli-interactive
     subnet="/subscriptions/<subscriptionID>/resourceGroups/<resourceGroupName>/providers/Microsoft.Network/virtualNetworks/<vnetName>/subnets/<subnetName>"
     cluster="thvankra-cmk-test-wcus"
     group="thvankra-nova-cmk-test"
@@ -51,13 +51,13 @@ Azure Managed Instance for Apache Cassandra provides the capability to encrypt d
         --initial-cassandra-admin-password $password
     ```
 
-1. Get the identity information of the created cluster
+1. Get the identity information of the created cluster:
 
     ```azurecli-interactive
     az managed-cassandra cluster show -c $cluster -g $group
     ```
 
-    The output will include an identity section like the below. Copy `principalId` for later use:
+    The output includes an identity section like the following example. Copy the `principalId` value for later use.
 
     ```shell
       "identity": {
@@ -66,37 +66,35 @@ Azure Managed Instance for Apache Cassandra provides the capability to encrypt d
         "type": "SystemAssigned"
       }
     ```
- 
-1. In Azure Key Vault, create an access policy to your keys:
 
-   :::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":::
+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.
 
-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:
- 
+   :::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":::
 
-   :::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":::
+1. For **Key permissions**, select **get**, **wrap**, and **unwrap**. Select the **Select principal** box to open the **Principal** pane. Enter the cluster's `principalId` value that you retrieved earlier, and then select the **Select** button. (In the portal, you can also look up the principal ID of the cluster by the cluster's name.)
 
-   > [!WARNING]
-   > Make sure the key vault has Purge Protection enabled. Datacenter deployments will fail without it. 
+   :::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":::
 
-1. After you click on `add` to add the access policy, make sure you save it:
+   > [!WARNING]
+   > Make sure that the key vault has purge protection turned on. Datacenter deployments will fail without it.
 
-   :::image type="content" source="./media/cmk/save.png" alt-text="Save Access policy" lightbox="./media/cmk/key-vault-access-policy-2.png" border="true":::
+1. Select **Add** to add the access policy, and then select **Save**.
 
-1. To get the key identifier, select your key:
+   :::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":::
 
-   :::image type="content" source="./media/cmk/select-key.png" alt-text="Select key" lightbox="./media/cmk/key-identifier-1.png" border="true":::
+1. To get the key identifier, select **Keys**, and then select your key.
 
-1. Click on current version:
+   :::image type="content" source="./media/cmk/select-key.png" alt-text="Screenshot that shows the pane for selecting a key." lightbox="./media/cmk/key-identifier-1.png" border="true":::
 
-   :::image type="content" source="./media/cmk/current-version.png" alt-text="Select current version" lightbox="./media/cmk/key-identifier-1.png" border="true":::
+1. Select the current version.
 
-1. Save the key identifier for later use:
+   :::image type="content" source="./media/cmk/current-version.png" alt-text="Screenshot that shows the box for selecting the current version of a key." lightbox="./media/cmk/key-identifier-1.png" border="true":::
 
-   :::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":::
+1. Save the key identifier for later use.
 
+   :::image type="content" source="./media/cmk/key-identifier-2.png" alt-text="Screenshot that shows copying a key identifier to the clipboard." lightbox="./media/cmk/key-identifier-1.png" border="true":::
 
-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): 
+1. Create the datacenter by replacing `<key identifier>` with the same key (the URI that you copied in the previous step) for both managed disk (`managed-disk-customer-key-uri`) and backup storage (`backup-storage-customer-key-uri`) encryption. Use the same value for `subnet` that you used earlier.
 
     ```azurecli-interactive
     managedDiskKeyUri = "<key identifier>"
@@ -120,24 +118,24 @@ Azure Managed Instance for Apache Cassandra provides the capability to encrypt d
         --sku Standard_DS14_v2
     ```
 
-1. An existing cluster with no identity information can be assigned an identity as shown below:
+You can also assign an identity to an existing cluster with no identity information:
 
-    ```azurecli-interactive
-    az managed-cassandra cluster update --identity-type SystemAssigned -g $group -c $cluster
-    ```
+```azurecli-interactive
+az managed-cassandra cluster update --identity-type SystemAssigned -g $group -c $cluster
+```
 
-## <a id="update-cluster"></a>Rotating the key
+## <a id="update-cluster"></a>Rotate the key
 
-1. Below is the command to update the key:
+To update the key, use this command:
 
-    ```azurecli-interactive
-    managedDiskKeyUri = "<key identifier>"
-    backupStorageKeyUri = "<key identifier>"
+```azurecli-interactive
+managedDiskKeyUri = "<key identifier>"
+backupStorageKeyUri = "<key identifier>"
     
-    az managed-cassandra datacenter update \
-        --resource-group $group \
-        --cluster-name $cluster \ 
-        --data-center-name $dc \
-        --managed-disk-customer-key-uri $managedDiskKeyUri \
-        --backup-storage-customer-key-uri $backupStorageKeyUri
-    ```
+az managed-cassandra datacenter update \
+    --resource-group $group \
+    --cluster-name $cluster \ 
+    --data-center-name $dc \
+    --managed-disk-customer-key-uri $managedDiskKeyUri \
+    --backup-storage-customer-key-uri $backupStorageKeyUri
+```

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

@@ -11,27 +11,27 @@ ms.date: 12/08/2023
 
 # Run Jaeger with Azure Managed Instance for Apache Cassandra
 
-Jaeger, a distributed tracing platform for monitoring microservices, enables the fast identification of performance challenges and optimization. Through features, like tracing instrumentation and logging integration.
-
-The article specifically details the use of the sample application HotROD and Jaeger alongside Azure Managed Instance for Apache Cassandra for efficient storage monitoring.
+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.
 
+This article details the use of the sample application HotROD and Jaeger alongside Azure Managed Instance for Apache Cassandra for efficient storage monitoring.
 
 ## Prerequisites and setup
-* [Create an Azure Managed Instance for Apache Cassandra cluster](create-cluster-cli.md).
-* [Ensure Docker is installed](https://www.docker.com/get-started/).
 
+* [Create an Azure Managed Instance for Apache Cassandra cluster](create-cluster-cli.md).
+* [Ensure that Docker is installed](https://www.docker.com/get-started/).
 
 ## Use Jaeger with Azure Managed Instance for Apache Cassandra
+
 1. [Download the Jaeger repository](https://github.com/jaegertracing/jaeger.git).
-1. Navigate to the docker-compose folder `cd jaeger\docker-compose`.
-1. Add your Azure Managed Instance Cassandra cluster credentials to the `jaeger-collector and jaeger-query` section within the `jaeger-docker-compose.yml` file:
+1. Go to the *docker-compose* folder: `cd jaeger\docker-compose`.
+1. In the *jaeger-docker-compose.yml* file, add your Azure Managed Instance for Apache Cassandra cluster credentials to the `jaeger-collector` and `jaeger-query` sections:
 
     ```yml
         command: ["--cassandra.port=9042", "--cassandra.servers=seed_nodes_mi_datacenters", "--cassandra.username=cassandra", "--cassandra.password=cassandra_mi_password","--cassandra.tls.skip-host-verify","--cassandra.tls.enabled", 
         "--cassandra.keyspace=jaeger_v1_dc1" ]
-    ``` 
+    ```
 
-1. Additionally, add the environment variables to the `cassandra-schema and jaeger-collector`:`
+1. Add the environment variables to the `cassandra-schema` and `jaeger-collector` sections:
 
     ```yml
     environment: 
@@ -41,7 +41,9 @@ The article specifically details the use of the sample application HotROD and Ja
         - CQLSH_SSL=--ssl
         ...
     ```
-1. To connect your Azure Managed Instance Cassandra cluster, add the Cassandra sign-in credentials to the `cassandra-schema`:
+
+1. To connect your Azure Managed Instance for Apache Cassandra cluster, add the Cassandra sign-in credentials to the `cassandra-schema` section:
+
     ```yml
       environment:
         ...
@@ -51,25 +53,30 @@ The article specifically details the use of the sample application HotROD and Ja
         - CASSANDRA_USERNAME=cassandra
         ...
     ```
+
 1. Run `docker-compose -f jaeger-docker-compose.yml up -d` to start the application.
 
-    :::image type="content" source="./media/jaeger/jaeger-running.png" alt-text="Screenshot of running jaeger." lightbox="./media/jaeger/jaeger-running.png" border="true":::
+    :::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":::
 
     > [!TIP]
-    > 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.
+    > 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`.
+
+1. After the containers are running, use the Jaeger UI to view traces from the application.
 
-1. Once the containers are running, access the Jaeger UI to view traces from the application.
-    :::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":::
+    :::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":::
 
-1. Verify by inspecting your Azure Managed Instance cluster.
-    :::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":::
+1. Verify by inspecting your Azure Managed Instance for Apache Cassandra cluster.
 
-1.  Refer to the traces table to view the data related to step 7.
-    :::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":::
+    :::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":::
 
+1. Refer to the `traces` table to view the data related to step 7.
 
-## FAQs
-If you encounter issues running or testing Jaeger, open a support ticket. Provide the subscription ID and account name where your Jaeger test is running.
+    :::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":::
+
+## Support
+
+If you have problems running or testing Jaeger, open a support ticket. Provide the subscription ID and account name where your Jaeger instance is running.
 
 ## Next steps
-- Learn about [hybrid cluster configuration](configure-hybrid-cluster.md) in Azure Managed Instance for Apache Cassandra.
+
+* Learn about [hybrid cluster configuration](configure-hybrid-cluster.md) in Azure Managed Instance for Apache Cassandra.