github.com/Cloud-Foundations/Dominator@v0.3.4/cmd/hypervisor/README.md (about)

     1  # hypervisor
     2  SmallStack Virtual Machine Hypervisor.
     3  
     4  The *hypervisor* daemon manages virtual machines (VMs). Please read the
     5  [SmallStack design document](https://bit.ly/SmallStack) to understand the
     6  architecture.
     7  
     8  ## Status page
     9  The *hypervisor* provides a web interface on port `6976` which shows a status
    10  page, links to built-in dashboards and access to performance metrics and logs.
    11  If *hypervisor* is running on host `myhost` then the URL of the main
    12  status page is `http://myhost:6976/`. An RPC over HTTP interface is also
    13  provided over the same port.
    14  
    15  
    16  ## Startup
    17  *Hypervisor* is started at boot time, usually by one of the provided
    18  [init scripts](../../init.d/). The *hypervisor* process is baby-sat by the init
    19  script; if the process dies the init script will re-start it. It may be stopped
    20  with the command:
    21  
    22  ```
    23  service hypervisor stop
    24  ```
    25  
    26  which also kills the baby-sitting init script. It may be started with the
    27  comand:
    28  
    29  ```
    30  service hypervisor start
    31  ```
    32  
    33  ## Usage
    34  There are many command-line flags which may change the behaviour of
    35  *hypervisor* but many have defaults which should be adequate for most
    36  deployments. Built-in help is available with the command:
    37  
    38  ```
    39  hypervisor -h
    40  ```
    41  
    42  There are some sub-commands available for special maintenance:
    43  
    44  - **check-vms**: check VM configuration and data files for consistency
    45  - **repair-vm-volume-allocations**: repair the number of allocated blocks for
    46                                      VM volumes
    47  - **run**: start the *hypervisor*. This is the same as not providing a
    48             subcommand
    49  - **stop**: stop the *hypervisor* without shutting down VMs. The metadata,
    50              DHCP and TFTP services will stop
    51  - **stop-vms-on-next-stop**: signal the *hypervisor* to cleanly shut down
    52                               VMs on the next **stop**
    53  
    54  ## Security
    55  RPC access is restricted using TLS client authentication. *Hypervisor* expects
    56  a root certificate in the file `/etc/ssl/CA.pem` which it trusts to sign
    57  certificates which grant access to methods. It trusts the root certificate in
    58  the `/etc/ssl/IdentityCA.pem` file to sign identity-only certificates.
    59  
    60  It also requires a certificate and key which grant it the ability to **get**
    61  images and objects from an *[imageserver](../imageserver/README.md)*. These
    62  should be in the files
    63  `/etc/ssl/hypervisor/cert.pem` and `/etc/ssl/hypervisor/key.pem`, respectively.
    64  
    65  ## Control
    66  The *[vm-control](../vm-control/README.md)* utility may be used to create,
    67  modify and destroy VMs.
    68  
    69  The *[hyper-control](../hyper-control/README.md)* utility is used to perform
    70  administrative tasks on the *Hypervisor*.