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

     1  # subtool
     2  A utility to control the *[subd](../subd/README.md)* daemon that runs on every
     3  dominated system.
     4  
     5  The *subtool* utility may be used to debug and control a running *subd*.
     6  *Subtool* may be run on any machine and can be used to manipulate various
     7  operating parameters of a running *subd* and perform RPC requests. It is
     8  typically run on a desktop or bastion machine.
     9  
    10  ## Usage
    11  *Subtool* supports several sub-commands. There are many command-line flags which
    12  provide parameters for these sub-commands. The most commonly used parameter is
    13  `-subHostname` which specifies which host the *subd* to control is running on.
    14  The basic usage pattern is:
    15  
    16  ```
    17  subtool [flags...] command [args...]
    18  ```
    19  
    20  Built-in help is available with the command:
    21  
    22  ```
    23  subtool -h
    24  ```
    25  
    26  Some of the sub-commands available are:
    27  
    28  - **boost-cpu-limit**: raise the CPU limit until the next scan cycle (this does
    29                         not change the priority (nice) level)
    30  - **cleanup**: empty the object cache
    31  - **delete**: delete specified pathnames
    32  - **fetch**: tell *subd* to fetch the specified object from the objectserver
    33  - **get-config**: get the current configuration from *subd*
    34  - **get-file**: get a file from *subd*
    35  - **list-missing-objects**: list objects in the specified image that are missing
    36                              on the sub
    37  - **poll**: get the checksumed file-system representation
    38  - **push-file**: push a single file
    39  - **push-image**: push an image directly to the *[subd](../subd/README.md)*,
    40                    bypassing the *[dominator](../dominator/README.md)*
    41  - **push-missing-objects**: push objects in the specified image that are missing
    42                              to the sub
    43  - **restart-service**: restart the specified service
    44  - **set-config**: set the current configuration of *[subd](../subd/README.md)*
    45                    (such as rate limits for scanning the file-system and
    46                    **fetching** objects)
    47  - **show-update-request**: compute and show the update request for the
    48                             specified image
    49  - **wait-for-image**: wait for the sub to be updated to the specified image
    50                        (another entity is responsible for triggering the update)
    51  
    52  Note that sub-commands which change the configuration of
    53  *[subd](../subd/README.md)* may be reverted by the
    54  *[dominator](../dominator/README.md)*. Thus, it may be more appropriate to use
    55  the *[dominator](../dominator/README.md)* to change the configuration of all the
    56  *[subd](../subd/README.md)* instances in the fleet.
    57  
    58  ## Security
    59  *[Subd](../subd/README.md)* restricts RPC access using TLS client
    60  authentication. *Subtool* will load certificate and key files from the
    61  `~/.ssl` directory. *Subtool* will present these certificates to *subd*. If one
    62  of the certificates is signed by a certificate authority that *subd* trusts,
    63  *subd* will grant access.