[cloudstack-documentation] branch master updated: Unmanage VMs documentation (#139)

[an...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

andrijapanic pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/cloudstack-documentation.git


The following commit(s) were added to refs/heads/master by this push:
     new 8532e8d  Unmanage VMs documentation (#139)
8532e8d is described below

commit 8532e8d7a47f2aa17a14bd5c3532c4d4c24fc188
Author: Nicolas Vazquez <ni...@gmail.com>
AuthorDate: Wed Jun 17 12:38:28 2020 -0300

    Unmanage VMs documentation (#139)
    
    * Unmanage VMs documentation
    
    * Apply suggestions from code review
    
    Co-authored-by: Andrija Panic <45...@users.noreply.github.com>
    
    * Update VM ingestion docs
    
    * Refactor forced param description
    
    Co-authored-by: Andrija Panic <45...@users.noreply.github.com>
---
 source/adminguide/virtual_machines.rst             |  5 ++
 .../adminguide/virtual_machines/VM_Ingestion.rst   | 20 +-----
 .../adminguide/virtual_machines/unmanage_vms.rst   | 82 ++++++++++++++++++++++
 3 files changed, 90 insertions(+), 17 deletions(-)

diff --git a/source/adminguide/virtual_machines.rst b/source/adminguide/virtual_machines.rst
index d6c2c3a..fd1bd1a 100644
--- a/source/adminguide/virtual_machines.rst
+++ b/source/adminguide/virtual_machines.rst
@@ -913,6 +913,11 @@ snapshot:
    VM snapshots are deleted automatically when a VM is destroyed. You don't 
    have to manually delete the snapshots in this case.
 
+Unmanaging Virtual Machines
+===========================
+
+.. include:: virtual_machines/unmanage_vms.rst
+
 
 Importing Virtual Machines
 ===========================
diff --git a/source/adminguide/virtual_machines/VM_Ingestion.rst b/source/adminguide/virtual_machines/VM_Ingestion.rst
index 54bf18b..a1eda3e 100644
--- a/source/adminguide/virtual_machines/VM_Ingestion.rst
+++ b/source/adminguide/virtual_machines/VM_Ingestion.rst
@@ -13,22 +13,6 @@
    specific language governing permissions and limitations
    under the License.
 
-About Importing VMs
---------------------
-
-Unmanaged Virtual Machines
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-As of ACS 4.14, CloudStack has the concept of **unmanaged** virtual machines.  These are virtual machines that are on CloudStack
-managed hosts, but that are not in CloudStack's database and therefore CloudStack cannot control (manage) then in any way.  Previously,
-such VMs could exist, but CloudStack did not 'see' them (their existence *would* be reported in logs as unrecognised VMs).
-
-From ACS 4.14 onwards, CloudStack is able to list these VMs via the listUnmanagedInstances API command and then import (also known as ingest)
-those unmanaged VMs via the importUnmanagedInstance API so that they become CloudStack managed guest instances
-
-.. note:: This is currently only available for **vSphere** clusters.
-
-
 Use Cases and General Usage
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -123,12 +107,14 @@ importUnmanagedInstance API
    - **projectid**
    - **templateid**
    - **serviceofferingid**
-   - **diskofferingid** (UUID of disk offering for root disk)
    - **nicnetworklist** (Map for NIC ID and corresponding Network UUID)
    - **nicipaddresslist** (Map for NIC ID and corresponding IP address)
    - **datadiskofferinglist** (Map for data disk ID and corresponding disk offering UUID)
    - **details** (Map for VM details)
    - **migrateallowed** (VM and its volumes are allowed to migrate to different host/storage pool when offering tags conflict with host/storage pool)
+   - **forced** (If true, a VM is imported despite some of its NIC's MAC addresses being already present)
+
+.. note:: The `forced` parameter is false by default and prevents importing a VM which has a NIC containing a MAC address that has been previously assigned by CloudStack. If it is set to true, the NICs with MAC addresses which already exist in the CloudStack database have the existing MAC addresses reassigned to its NICs.
 
 **Response**:
 
diff --git a/source/adminguide/virtual_machines/unmanage_vms.rst b/source/adminguide/virtual_machines/unmanage_vms.rst
new file mode 100644
index 0000000..9cf2c36
--- /dev/null
+++ b/source/adminguide/virtual_machines/unmanage_vms.rst
@@ -0,0 +1,82 @@
+About Unmanaged Virtual Machines
+--------------------------------
+
+As of ACS 4.14, CloudStack has the concept of **unmanaged** virtual machines.  These are virtual machines that are on CloudStack
+managed hosts, but that are not in CloudStack's database and therefore CloudStack cannot control (manage) then in any way.  Previously,
+such VMs could exist, but CloudStack did not 'see' them (their existence *would* be reported in logs as unrecognised VMs).
+
+From ACS 4.14 onwards, CloudStack is able to list these VMs via the listUnmanagedInstances API command and then import (also known as ingest)
+those unmanaged VMs via the importUnmanagedInstance API so that they become CloudStack managed guest instances
+
+From ACS 4.15 onwards, administrators are able to unmanage guest virtual machines.
+
+.. note:: This is currently only available for **vSphere** clusters.
+
+Unmanaging Virtual Machines via API
+-----------------------------------
+
+Administrators are able to unmanage guest virtual machines from CloudStack. Once unmanaged, CloudStack can no longer monitor, control or administer the provisioning and orchestration related operations on a virtual machine.
+
+To unmanage a guest virtual machine, an administrator must invoke the unmanageVirtualMachine API passing the ID of the virtual machine to unmanage. The API has the following preconditions:
+
+- The virtual machine must not be destroyed
+- The virtual machine state must be 'Running’ or ‘Stopped’
+- The virtual machine must be a VMware virtual machine
+
+The API execution will perform the following pre-checks, failing if they are not met:
+
+- There are no volume snapshots associated with any of the virtual machine volumes
+- There is no ISO attached to the virtual machine
+
+.. note:: This is currently only available for **vSphere** clusters.
+
+
+Preserving unmanaged virtual machine NICs
+-----------------------------------------
+
+The zone setting: unmanage.vm.preserve.nics can be used to preserve virtual machine NICs and its MAC addresses after unmanaging them. If set to true, the virtual machine NICs (and their MAC addresses) are preserved when unmanaging it. Otherwise, NICs are removed and MAC addresses can be reassigned.
+
+
+Unmanaging virtual machine actions
+----------------------------------
+
+- Clean up virtual machine NICs and deallocate network resources used such as IP addresses and DHCP entries on virtual routers.
+
+   - If ‘unmanage.vm.preserve.nics’ = ‘false’ then the NICs are deallocated and removed from CloudStack
+
+   - If ‘unmanage.vm.preserve.nics’ = ‘true’ then the NICs remain allocated and are not removed from the database. The NIC’s MAC addresses remain preserved and therefore cannot be assigned to any new NIC.
+
+- Clean up virtual machine volumes in the CloudStack database
+
+- Clean up virtual machine snapshots in the CloudStack database (if any)
+- Revoke host access to any managed volumes attached to the VM (applicable to managed storage only)
+
+- Clean up the virtual machine from the following:
+
+   - Remove the virtual machine from security groups (if any)
+
+   - Remove the virtual machine from instance groups (if any)
+
+   - Remove firewall rules for the virtual machine (if any)
+
+   - Remove port forwarding rules for the virtual machine (if any)
+
+   - Remove load balancing rules for the virtual machine (if any)
+
+   - Disable static NAT (if the virtual machine is assigned to it)
+
+   - Remove the virtual machine from affinity groups (if any)
+
+- Remove VM details from the CloudStack database
+
+- Decrement the account resources count for volumes and virtual machines
+
+- Generate usage events:
+
+   - For volumes destroyed, with type: ‘VOLUME.DELETE’
+
+   - For virtual machine snapshots destroyed (if any), with type: ‘VMSNAPSHOT.DELETE’ and 'VMSNAPSHOT.OFF_PRIMARY'
+   
+   - For virtual machine NICs destroyed: with type: ‘NETWORK.OFFERING.REMOVE’
+   
+   - For the virtual machine being unmanaged: stopped and destroyed usage events (similar to the generated usage events when expunging a virtual machine), with types: ‘VM.STOP’ and ‘VM.DESTROY', unless the VM has been already stopped before being unmanaged and in this case only ‘VM.DESTROY' is generated.