github.com/dctrud/umoci@v0.4.3-0.20191016193643-05a1d37de015/doc/man/umoci-config.1.md (about)

     1  % umoci-config(1) # umoci config - Modifies the configuration of an OCI image
     2  % Aleksa Sarai
     3  % DECEMBER 2016
     4  # NAME
     5  umoci config - Modifies the configuration of an OCI image
     6  
     7  # SYNOPSIS
     8  **umoci config**
     9  **--image**=*image*[:*tag*]
    10  [**--tag**=*new-tag*]
    11  [**--history.comment**=*comment*]
    12  [**--history.created_by**=*created_by*]
    13  [**--history.author**=*author*]
    14  [**--history-created**=*date*]
    15  [**--clear**=*value*]
    16  [**--config.user**=*value*]
    17  [**--config.exposedports**=*value*]
    18  [**--config.env**=*value*]
    19  [**--config.entrypoint**=*value*]
    20  [**--config.cmd**=*value*]
    21  [**--config.volume**=*value*]
    22  [**--config.label**=*value*]
    23  [**--config.workingdir**=*value*]
    24  [**--created**=*value*]
    25  [**--author**=*value*]
    26  [**--architecture**=*value*]
    27  [**--os**=*value*]
    28  [**--manifest.annotation**=*value*]
    29  
    30  # DESCRIPTION
    31  Modify the configuration and manifest data for a particular tagged OCI image.
    32  In addition, a history entry is appended to the tagged OCI image for this
    33  change (with the various **--history.** flags controlling the values used). To
    34  view the history, see **umoci-stat**(1).
    35  
    36  Note that the original image tag (the argument to **--image**) will **not** be
    37  modified unless the target of **umoci-config**(1) is the original image tag.
    38  
    39  # OPTIONS
    40  The global options are defined in **umoci**(1).
    41  
    42  **--image**=*image*[:*tag*]
    43    The source tagged OCI image whose config will be modified. *image* must be
    44    a path to a valid OCI image and *tag* must be a valid tag in the image. If
    45    *tag* is not provided it defaults to "latest".
    46  
    47  **--tag**=*new-tag*
    48    Tag name for the repacked image, if unspecified then the original tag
    49    provided to **--image** will be clobbered.
    50  
    51  **--history.comment**=*comment*
    52    Comment for the history entry corresponding to this modification of the image
    53    configuration. If unspecified, **umoci**(1) will generate an
    54    implementation-dependent value.
    55  
    56  **--history.created_by**=*created_by*
    57    CreatedBy entry for the history entry corresponding to this modification of
    58    the image configuration. If unspecified, **umoci**(1) will generate an
    59    implementation-dependent value.
    60  
    61  **--history.author**=*author*
    62    Author value for the history entry corresponding to this modification of the
    63    image configuration. If unspecified, this value will be the image's author
    64    value **after** any modifications were made by this call of
    65    **umoci-config**(1).
    66  
    67  **--history-created**=*date*
    68    Creation date for the history entry corresponding to this modifications of
    69    the image configuration. This must be an ISO8601 formatted timestamp (see
    70    **date**(1)). If unspecified, the current time is used.
    71  
    72  **--clear**=*value*
    73    Removes all pre-existing entries for a given set or list configuration option
    74    (it will not undo any modification made by this call of **umoci-config**(1)).
    75    The valid values of *value* are:
    76  
    77      * config.labels
    78      * manifest.annotations
    79      * config.exposedports
    80      * config.env
    81      * config.entrypoint
    82      * config.cmd
    83      * config.volume
    84  
    85  The following commands all set their corresponding values in the configuration
    86  or image manifest. For more information see [the OCI image specification][1].
    87  
    88  * **--config.user**=*value*
    89  * **--config.exposedports**=*value*
    90  * **--config.env**=*value*
    91  * **--config.entrypoint**=*value*
    92  * **--config.cmd**=*value*
    93  * **--config.volume**=*value*
    94  * **--config.label**=*value*
    95  * **--config.workingdir**=*value*
    96  * **--created**=*value*
    97  * **--author**=*value*
    98  * **--architecture**=*value*
    99  * **--os**=*value*
   100  * **--manifest.annotation**=*value*
   101  
   102  # EXAMPLE
   103  
   104  The following modifies an OCI image configuration in various ways, and
   105  overwrites the original tag with the new image.
   106  
   107  ```
   108  % umoci config --image image:tag --clear=config.env --config.env="VARIABLE=true" \
   109  	--config.user="user:group" --config.entrypoint=cat --config.cmd=/proc/self/stat \
   110  	--config.label="com.cyphar.umoci=true" --author="Aleksa Sarai <asarai@suse.de>" \
   111  	--os="gnu/hurd" --architecture="lisp" --created="$(date --iso-8601=seconds)"
   112  ```
   113  
   114  # SEE ALSO
   115  **umoci**(1)
   116  
   117  [1]: https://github.com/opencontainers/image-spec