github.com/cloud-foundations/dominator@v0.0.0-20221004181915-6e4fee580046/cmd/fleet-manager/README.md (about)

     1  # fleet-manager
     2  SmallStack Fleet Manager.
     3  
     4  The *fleet-manager* daemon manages a fleet of
     5  *[Hypervisors](../hypervisor/README.md)* and the Virtual Machines running on
     6  them. Please read the
     7  [SmallStack design document](https://bit.ly/SmallStack) to understand the
     8  architecture.
     9  
    10  ## Status page
    11  The *fleet-manager* provides a web interface on port `6977` which shows a status
    12  page, links to built-in dashboards and access to performance metrics and logs.
    13  If *fleet-manager* is running on host `myhost` then the URL of the main
    14  status page is `http://myhost:6977/`. An RPC over HTTP interface is also
    15  provided over the same port.
    16  
    17  
    18  ## Startup
    19  *fleet-manager* is started at boot time, usually by one of the provided
    20  [init scripts](../../init.d/). The *fleet-manager* process is baby-sat by the init
    21  script; if the process dies the init script will re-start it. It may be stopped
    22  with the command:
    23  
    24  ```
    25  service fleet-manager stop
    26  ```
    27  
    28  which also kills the baby-sitting init script. It may be started with the
    29  comand:
    30  
    31  ```
    32  service fleet-manager start
    33  ```
    34  
    35  There are many command-line flags which may change the behaviour of
    36  *fleet-manager* but many have defaults which should be adequate for most
    37  deployments. Built-in help is available with the command:
    38  
    39  ```
    40  fleet-manager -h
    41  ```
    42  
    43  ## Security
    44  RPC access is restricted using TLS client authentication. *fleet-manager*
    45  expects a root certificate in the file `/etc/ssl/CA.pem` which it trusts to sign
    46  certificates which grant access to methods. It trusts the root certificate in
    47  the `/etc/ssl/IdentityCA.pem` file to sign identity-only certificates.
    48  
    49  It also requires a certificate and key which grant it the ability to manage
    50  *[Hypervisors](../hypervisor/README.md)*. These should be in the files
    51  `/etc/ssl/fleet-manager/cert.pem` and `/etc/ssl/fleet-manager/key.pem`,
    52  respectively.
    53  
    54  ## Control
    55  The *[vm-control](../vm-control/README.md)* utility may be used to create,
    56  modify and destroy VMs.
    57  
    58  The *[hyper-control](../hyper-control/README.md)* utility is used to perform
    59  administrator tasks on *Hypervisors*.