Copilot commented on code in PR #638:
URL:
https://github.com/apache/cloudstack-documentation/pull/638#discussion_r3031445050
##########
source/adminguide/systemvm.rst:
##########
@@ -147,51 +147,138 @@ Accessing System VMs
It may sometimes be necessary to access System VMs for diagnostics of certain
issues, for example if you are experiencing SSVM (Secondary Storage VM)
-connection issues. Use the steps below in order to connect to the SSH console
-of a running System VM.
+connection issues. Use the methods below in order to connect to any running
+System VM, including VR (Virtual Router) and CPVM (ConsoleProxyVM).
+
+Option A: Accessing via SSH
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
Accessing System VMs over the network requires the use of private keys and
-connecting to System VMs SSH Daemon on port 3922. XenServer/KVM Hypervisors
-store this key at /root/.ssh/id_rsa.cloud on each CloudStack agent. To access
+connecting to System VMs SSH Daemon on port **3922**. XenServer/KVM Hypervisors
+store this key at ``/root/.ssh/id_rsa.cloud`` on each CloudStack agent. To
access
System VMs running on ESXi, the key is stored on the management server at
-~cloud/.ssh/id_rsa.
+``~cloud/.ssh/id_rsa``.
#. Find the details of the System VM
- #. Log in with admin privileges to the CloudStack UI.
+ #. Log in with Root Admin privileges to the **CloudStack UI**.
- #. Click Infrastructure, then System VMs, and then click the name of a
+ #. Click **Infrastructure > System VMs**, and then click the name of a
running VM.
#. Take a note of the 'Host', 'Private IP Address' and 'Link Local IP
Address' of the System VM you wish to access.
-#. XenServer/KVM Hypervisors
+#. For XenServer/KVM Hypervisors
- #. Connect to the Host of which the System VM is running.
+ #. Connect via SSH as `root` to the Host of which the System VM is running.
Review Comment:
Inline markup: use literal formatting for the username (``root``) instead of
single backticks (`root`). In Sphinx/reST, single backticks are interpreted
text and can create unresolved-reference warnings depending on the default role.
```suggestion
#. Connect via SSH as ``root`` to the Host of which the System VM is
running.
```
##########
source/adminguide/systemvm.rst:
##########
@@ -147,51 +147,138 @@ Accessing System VMs
It may sometimes be necessary to access System VMs for diagnostics of certain
issues, for example if you are experiencing SSVM (Secondary Storage VM)
-connection issues. Use the steps below in order to connect to the SSH console
-of a running System VM.
+connection issues. Use the methods below in order to connect to any running
+System VM, including VR (Virtual Router) and CPVM (ConsoleProxyVM).
+
+Option A: Accessing via SSH
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
Accessing System VMs over the network requires the use of private keys and
-connecting to System VMs SSH Daemon on port 3922. XenServer/KVM Hypervisors
-store this key at /root/.ssh/id_rsa.cloud on each CloudStack agent. To access
+connecting to System VMs SSH Daemon on port **3922**. XenServer/KVM Hypervisors
+store this key at ``/root/.ssh/id_rsa.cloud`` on each CloudStack agent. To
access
System VMs running on ESXi, the key is stored on the management server at
-~cloud/.ssh/id_rsa.
+``~cloud/.ssh/id_rsa``.
#. Find the details of the System VM
- #. Log in with admin privileges to the CloudStack UI.
+ #. Log in with Root Admin privileges to the **CloudStack UI**.
- #. Click Infrastructure, then System VMs, and then click the name of a
+ #. Click **Infrastructure > System VMs**, and then click the name of a
running VM.
#. Take a note of the 'Host', 'Private IP Address' and 'Link Local IP
Address' of the System VM you wish to access.
-#. XenServer/KVM Hypervisors
+#. For XenServer/KVM Hypervisors
- #. Connect to the Host of which the System VM is running.
+ #. Connect via SSH as `root` to the Host of which the System VM is running.
#. SSH to the 'Link Local IP Address' of the System VM from the Host on
which the VM is running.
- Format: ssh -i <path-to-private-key> <link-local-ip> -p 3922
+ Format:
+
+ .. code:: bash
+
+ ssh -i <path-to-private-key> <link-local-ip> -p 3922
+
+ Example:
+
+ .. code:: bash
- Example: root@kvm01:~# ssh -i /root/.ssh/id_rsa.cloud 169.254.3.93 -p
3922
+ root@kvm01:~# ssh -i /root/.ssh/id_rsa.cloud 169.254.3.93 -p 3922
-#. ESXi Hypervisors
+#. For ESXi Hypervisors
#. Connect to your CloudStack Management Server.
#. ESXi users should SSH to the private IP address of the System VM.
- Format: ssh -i <path-to-private-key> <vm-private-ip> -p 3922
+ Format:
+
+ .. code:: bash
+
+ ssh -i <path-to-private-key> <vm-private-ip> -p 3922
+
+ Example:
+
+ .. code:: bash
+
+ root@management:~# ssh -i ~cloud/.ssh/id_rsa 172.16.0.250 -p 3922
+
+
+Option B: Accessing via the Web Console
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If network access is restricted or the SSH daemon is unresponsive,
administrators can
+access the System VM directly through the CloudStack UI.
+
+#. For any hypervisor, using the default password.
+
+ #. Log in with Root Admin privileges to the **CloudStack UI**.
+
+ #. Click **Infrastructure > System VMs**, and then click the name of a
+ running VM.
+
+ #. Click the **View Console** button (screen icon) in the top right toolbar.
+
+ #. Default Username: ``root``
+
+ #. Default Password: ``password``
+
+#. For any hypervisor, if ``system.vm.random.password`` is enabled
(recommended).
+
+ #. Log in with Root Admin privileges to the **CloudStack UI**.
+
+ #. Click **Infrastructure > System VMs**, and then click the name of a
+ running VM.
+
+ #. Click the **View Console** button (screen icon) in the top right toolbar.
+
+ #. Default Username: ``root``
+
+ #. The decrypted password can be found under the ``system.vm.password``
global parameter.
+
+
+How to Enable System VM Random Password
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To step up the security of the environment, by configuring the
``system.vm.random.password`` parameter to **True**, and restart the Management
Server, a random password is generated and stored encrypted in the database.
The decrypted password found under the ``system.vm.password`` global parameter,
or by calling the ``listConfigurations`` API, still need to be decrypted to
reveal the usable password.
Review Comment:
Wording is internally inconsistent and grammatically off: it refers to a
“decrypted password” under ``system.vm.password`` but then says it “still
need(s) to be decrypted”. Consider rephrasing to state that enabling
``system.vm.random.password`` generates a random password stored encrypted, and
the value retrieved from ``system.vm.password`` / ``listConfigurations`` must
be decrypted to obtain the usable password.
```suggestion
To improve the security of the environment, set the
``system.vm.random.password`` parameter to **True** and restart the Management
Server. A random password is then generated and stored in encrypted form in the
database. The value returned by the ``system.vm.password`` global parameter, or
by calling the ``listConfigurations`` API, must be decrypted to obtain the
usable password.
```
##########
source/adminguide/systemvm.rst:
##########
@@ -147,51 +147,138 @@ Accessing System VMs
It may sometimes be necessary to access System VMs for diagnostics of certain
issues, for example if you are experiencing SSVM (Secondary Storage VM)
-connection issues. Use the steps below in order to connect to the SSH console
-of a running System VM.
+connection issues. Use the methods below in order to connect to any running
+System VM, including VR (Virtual Router) and CPVM (ConsoleProxyVM).
+
+Option A: Accessing via SSH
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
Accessing System VMs over the network requires the use of private keys and
-connecting to System VMs SSH Daemon on port 3922. XenServer/KVM Hypervisors
-store this key at /root/.ssh/id_rsa.cloud on each CloudStack agent. To access
+connecting to System VMs SSH Daemon on port **3922**. XenServer/KVM Hypervisors
+store this key at ``/root/.ssh/id_rsa.cloud`` on each CloudStack agent. To
access
System VMs running on ESXi, the key is stored on the management server at
-~cloud/.ssh/id_rsa.
+``~cloud/.ssh/id_rsa``.
#. Find the details of the System VM
- #. Log in with admin privileges to the CloudStack UI.
+ #. Log in with Root Admin privileges to the **CloudStack UI**.
- #. Click Infrastructure, then System VMs, and then click the name of a
+ #. Click **Infrastructure > System VMs**, and then click the name of a
running VM.
#. Take a note of the 'Host', 'Private IP Address' and 'Link Local IP
Address' of the System VM you wish to access.
-#. XenServer/KVM Hypervisors
+#. For XenServer/KVM Hypervisors
- #. Connect to the Host of which the System VM is running.
+ #. Connect via SSH as `root` to the Host of which the System VM is running.
#. SSH to the 'Link Local IP Address' of the System VM from the Host on
which the VM is running.
- Format: ssh -i <path-to-private-key> <link-local-ip> -p 3922
+ Format:
+
+ .. code:: bash
+
+ ssh -i <path-to-private-key> <link-local-ip> -p 3922
+
+ Example:
+
+ .. code:: bash
- Example: root@kvm01:~# ssh -i /root/.ssh/id_rsa.cloud 169.254.3.93 -p
3922
+ root@kvm01:~# ssh -i /root/.ssh/id_rsa.cloud 169.254.3.93 -p 3922
-#. ESXi Hypervisors
+#. For ESXi Hypervisors
#. Connect to your CloudStack Management Server.
#. ESXi users should SSH to the private IP address of the System VM.
- Format: ssh -i <path-to-private-key> <vm-private-ip> -p 3922
+ Format:
+
+ .. code:: bash
+
+ ssh -i <path-to-private-key> <vm-private-ip> -p 3922
+
+ Example:
+
+ .. code:: bash
+
+ root@management:~# ssh -i ~cloud/.ssh/id_rsa 172.16.0.250 -p 3922
+
+
+Option B: Accessing via the Web Console
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If network access is restricted or the SSH daemon is unresponsive,
administrators can
+access the System VM directly through the CloudStack UI.
+
+#. For any hypervisor, using the default password.
+
+ #. Log in with Root Admin privileges to the **CloudStack UI**.
+
+ #. Click **Infrastructure > System VMs**, and then click the name of a
+ running VM.
+
+ #. Click the **View Console** button (screen icon) in the top right toolbar.
+
+ #. Default Username: ``root``
+
+ #. Default Password: ``password``
+
+#. For any hypervisor, if ``system.vm.random.password`` is enabled
(recommended).
+
+ #. Log in with Root Admin privileges to the **CloudStack UI**.
+
+ #. Click **Infrastructure > System VMs**, and then click the name of a
+ running VM.
+
+ #. Click the **View Console** button (screen icon) in the top right toolbar.
+
+ #. Default Username: ``root``
+
+ #. The decrypted password can be found under the ``system.vm.password``
global parameter.
Review Comment:
This says the password is already decrypted in ``system.vm.password``. Later
in the doc you describe it as stored encrypted and requiring decryption. Please
clarify consistently (e.g., ``system.vm.password`` contains the encrypted
value; you must decrypt it with the management server key to get the usable
password).
```suggestion
#. The encrypted password can be found under the
``system.vm.password`` global parameter and must be decrypted with the
Management Server key to obtain the usable password.
```
##########
source/adminguide/systemvm.rst:
##########
@@ -124,13 +124,13 @@ of memory.
#. Navigate to Configuration, Global Settings:
#. Set the name of the 64-bit Template, KVM64bitTemplate, in the
- *``router.template.kvm``* global parameter.
+ ``router.template.kvm`` global parameter.
If you are using a XenServer 64-bit Template, set the name in the
- *``router.template.xenserver``* global parameter.
+ ``router.template.xenserver`` global parameter.
Review Comment:
Parameter-name markup is inconsistent within this document: elsewhere
parameters are formatted as emphasized literals (e.g.,
*``router.version.check``*), but here ``router.template.kvm`` /
``router.template.xenserver`` are plain literals. Consider using the same style
for consistency (and apply similarly to the VMware line below).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
