Skip to content

Commit 1777950

Browse files
committed
updated documentation based on Acrolinx recommendations
1 parent f75d764 commit 1777950

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

articles/operator-nexus/howto-use-vm-console-service.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Azure Operator Nexus: VM Console Service"
3-
description: Learn how to use the VM Console service.
3+
description: Learn how to use the VM Console service to remotely access Nexus Virtual Machine through ssh from your environment.
44
author: sshiba
55
ms.author: sidneyshiba
66
ms.service: azure-operator-nexus
@@ -11,7 +11,7 @@ ms.custom: template-how-to, devx-track-azurecli
1111

1212
# Introduction to the Virtual Machine console service
1313

14-
The Virtual Machine (VM) console service provides managed access to a VM hosted in an Operator Nexus Instance. It relies on the Azure Private Link Service (PLS) to establish a private network connection between the user's network and the Azure Operator Nexus Cluster Manager's private network.
14+
The Virtual Machine (VM) console service provides managed access to a VM hosted in an Operator Nexus Instance. It uses Azure Private Link Service (PLS) to provide network connectivity on Azure private network. The VM Console service is a secure and private way to access a VM without exposing it to the public internet.
1515

1616
:::image type="content" source="media/vm-console-service.png" alt-text="Diagram of VM Console service." lightbox="media/vm-console-service.png":::
1717

@@ -23,7 +23,7 @@ This guide helps you to:
2323

2424
1. Establish a secure private network connectivity between your network and the Cluster Manager's private network.
2525
1. Create a Console resource in your workload/tenant resource group using the `az networkcloud virtualmachine console` CLI command.
26-
1. Initiate an SSH session to connect to the Virtual Machine's Console.
26+
1. Start an SSH session to connect to the Virtual Machine's Console.
2727

2828
> [!NOTE]
2929
> In order to avoid passing the `--subscription` parameter to each Azure CLI command, execute the following command:
@@ -76,13 +76,13 @@ To help set up the environment for access to Virtual Machines, define these envi
7676
7777
## Creating Console Resource
7878

79-
The Console resource provides the information about the VM such as VM name, public SSH key, expiration date for the SSH session, etc.
79+
The Console custom resource provides the information about the Nexus VM. It provides the VM name, public SSH key, expiration date for the SSH session, and so on.
8080

8181
This section provides step-by-step guide to help you to create a Console resource using Azure CLI commands.
8282

8383
:::image type="content" source="media/vm-console-resource.png" alt-text="Diagram of VM Console Resource." lightbox="media/vm-console-resource.png":::
8484

85-
1. In order to create a ***Console*** resource in the Cluster Manager, you will need to collect some information, e.g., resource group (CM_HOSTED_RESOURCES_RESOURCE_GROUP) and custom location (CM_EXTENDED_LOCATION). You have to provide the resource group but you can retrieve the custom location if you have access rights to excute the commands listed below.
85+
1. To create a ***Console*** resource in the Cluster Manager, you'll need to collect some information, for example, resource group (CM_HOSTED_RESOURCES_RESOURCE_GROUP) and custom location (CM_EXTENDED_LOCATION). You have to provide the resource group but you can retrieve the custom location if you have access rights to excute the following commands:
8686

8787
```bash
8888
export cluster_manager_resource_id=$(az resource list -g ${CM_HOSTED_RESOURCES_RESOURCE_GROUP} --query "[?type=='Microsoft.NetworkCloud/clusterManagers'].id" --output tsv)
@@ -101,7 +101,7 @@ This section provides step-by-step guide to help you to create a Console resourc
101101
[--expiration "${CONSOLE_EXPIRATION_TIME}"]
102102
```
103103

104-
If you omit the `--expiration` parameter, the expiration will be defaulted to one day after the creation of the Console resource. Also note that the `expiration` date & time format **must** comply with RFC3339 otherwise the creation of the Console resource fails.
104+
If you omit the `--expiration` parameter, the expiration will be defaulted to one day after the creation of the Console resource. Also note that the `expiration` date & time format **must** follow RFC3339 otherwise the creation of the Console resource fails.
105105

106106
> [!NOTE]
107107
> For a complete synopsis for this command, invoke `az networkcloud console create --help`.
@@ -129,7 +129,7 @@ This section provides step-by-step guide to help you to create a Console resourc
129129

130130
## Establishing Private Network Connectivity
131131

132-
In order to establish a secure session with a Virtual Machine, you need to establish private network connectivity between your network and the Cluster Manager's private network.
132+
To establish a secure session with a Virtual Machine, you need to establish private network connectivity between your network and the Cluster Manager's private network.
133133
134134
This private network relies on the Azure Private Link Endpoint (PLE) and the Azure Private Link Service (PLS).
135135
@@ -169,7 +169,7 @@ This section provides a step-by-step guide to help you to establish a private ne
169169

170170
At this point, you have the `virtual_machine_access_id` and the `sshmux_ple_ip`. This input is the info needed for establishing a session with the VM.
171171

172-
The VM Console service is a `ssh` server that "relays" the session to the designated VM. The `sshmux_ple_ip` indirectly references the VM Console service and the `virtual_machine_access_id` the identifier for the VM.
172+
The VM Console service is a `ssh` server that "relays" the session to a Nexus VM. The `sshmux_ple_ip` indirectly references the VM Console service and the `virtual_machine_access_id` the identifier for the VM.
173173

174174
> [!IMPORTANT]
175175
> The VM Console service listens to port `2222`, therefore you **must** specify this port number in the `ssh` command.
@@ -187,7 +187,7 @@ The VM Console service was designed to allow **only** one session per Virtual Ma
187187

188188
## Updating Console Resource
189189

190-
You can disable the session to a given VM by updating the expiration date/time and/or updating the public SSH key used when creating the session with a VM.
190+
You can disable the session to a VM by updating the expiration date/time and the public SSH key used when creating the session with a VM.
191191

192192
```bash
193193
az networkcloud virtualmachine console update \
@@ -198,14 +198,14 @@ az networkcloud virtualmachine console update \
198198
[--expiration "${CONSOLE_EXPIRATION_TIME}"]
199199
```
200200

201-
If you want to disable access to a VM, you need to update the Console resource with the parameter `enabled False`. This update closes any existing session and restricts any subsequent sessions.
201+
If you want to disable access to a VM, you need to update the Console resource with the parameter `enabled False`. This update closes any existing session and restricts any later sessions.
202202

203203
> [!NOTE]
204204
> Before creating a session to a VM, the corresponding Console resource **must** be set to `--enabled True`.
205205

206206
When a Console `--expiration` time expires, it closes any session corresponding the Console resource. You'll need to update the expiration time with a future value so that you can establish a new session.
207207
208-
When you update the Console's public SSH key, the VM Console service closes any active session referenced by the Console resource. You have to provide a matching private SSH key matching the new public key when you establish a new session.
208+
When you update the Console's public SSH key, the VM Console service closes all active sessions. You present a new private SSH key to create a new session.
209209

210210
## Cleaning Up (Optional)
211211

0 commit comments

Comments
 (0)