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

     1  # builder-tool
     2  A utility to control the *[imaginator](../imaginator/README.md)* image building service.
     3  
     4  The *builder-tool* utility may be used to build images from manifests, either
     5  locally (for advanced debugging) or by sending a build request to the
     6  *[imaginator](../imaginator/README.md)* image building service.
     7  
     8  ## Usage
     9  *Builder-tool* supports several sub-commands. There are many command-line flags
    10  which provide parameters for these sub-commands. The most commonly used
    11  parameter is `-imaginatorHostname` which specifies which host the *imaginator*
    12  is running on. The `-alwaysShowBuildLog` parameter is also commonly used.
    13  The basic usage pattern is:
    14  
    15  ```
    16  builder-tool [flags...] command [args...]
    17  ```
    18  
    19  Built-in help is available with the command:
    20  
    21  ```
    22  builder-tool -h
    23  ```
    24  
    25  Some of the sub-commands available are:
    26  
    27  - **build-from-manifest**: build an image locally from the specified manifest
    28                             directory and upload a new datestamped image for the
    29                             specified image stream name. The source image will be
    30                             fetched from the *[imageserver](../imageserver/README.md)*
    31  - **build-image**: request the *[imaginator](../imaginator/README.md)* to build
    32                     and upload an image for the specified image stream (this is
    33                     the most commonly-used sub-command)
    34  - **build-raw-from-manifest**: build an image locally from the specified
    35                                 manifest and write a RAW image file which can be
    36                                 copied/uploaded for launching VMs. The source
    37                                 image will be fetched from the *[imageserver](../imageserver/README.md)*
    38  - **build-tree-from-manifest**: build an image file-system tree locally from the
    39                                  specified manifest directory. The root directory
    40                                  for the tree is created and written to stdout.
    41                                  The source image will be fetched from the
    42                                  *[imageserver](../imageserver/README.md)*
    43  - **disable-auto-builds**: disable automatic image building for the period
    44                             specified by `-disableFor`
    45  - **disable-build-requests**: disable automatic image building for the period
    46                                specified by `-disableFor`
    47  - **get-dependencies**: get the dependencies for all the *[imaginator](../imaginator/README.md)*
    48                          image streams and write a JSON representation to stdout
    49  - **get-digraph**: get the image stream dependencies represented as a directed
    50                     graph suitable for passing to the *dot* command from the
    51                     *Graphviz* tools
    52  - **process-manifest**: process a manifest locally in the specified root
    53                          directory containing an already unpacked source image
    54  - **replace-idle-slaves**: replace build slaves which are idle
    55  
    56  ## Security
    57  *[Imaginator](../imaginator/README.md)* restricts RPC access using TLS client
    58  authentication. *Builder-tool* will load certificate and key files from the
    59  `~/.ssl` directory. *Builder-tool* will present these certificates to the
    60  *imaginator*. If one of the certificates is signed by a certificate authority
    61  that the *imaginator* trusts, the *imaginator* will grant access.