Skip to content

component-cli_component-archive_resources_add.md

Latest commit

 

History

History
132 lines (99 loc) · 3.99 KB

component-cli_component-archive_resources_add.md

File metadata and controls

132 lines (99 loc) · 3.99 KB
Raw

component-cli component-archive resources add

Adds a resource to an component archive

Synopsis

add generates resources from a resource template and adds it to the given component descriptor in the component archive. If the resource is already defined (quality by identity) in the component-descriptor it will be overwritten.

The component archive can be specified by the first argument, the flag "--archive" or as env var "COMPONENT_ARCHIVE_PATH". The component archive is expected to be a filesystem archive. If the archive is given as tar please use the export command.

The resource template can be defined by specifying a file with the template with "resource" or it can be given through stdin.

The resource template is a multidoc yaml file so multiple templates can be defined.

---
name: 'myimage'
type: 'ociImage'
relation: 'external'
version: 0.2.0
access:
  type: ociRegistry
  imageReference: eu.gcr.io/gardener-project/component-cli:0.2.0
...
---
name: 'myconfig'
type: 'json'
relation: 'local'
input:
  type: "file"
  path: "some/path"
  mediaType: "application/octet-stream" # optional, defaulted to "application/octet-stream" or "application/gzip" if compress=true 
...
---
name: 'myconfig'
type: 'json'
relation: 'local'
input:
  type: "dir"
  path: /my/path
  compress: true # defaults to false
  includeFiles: # optional; list of shell file patterns
  - "*.txt"
  excludeFiles: # optional; list of shell file patterns
  - "*.txt"
  mediaType: "application/gzip" # optional, defaulted to "application/x-tar" or "application/gzip" if compress=true 
  preserveDir: true # optional, defaulted to false; if true, the top level folder "my/path" is included
  followSymlinks: true # optional, defaulted to false; if true, symlinks are resolved and the content is included in the tar
...

Alternativly the resources can also be defined as list of resources (both methods can also be combined).

---
resources:
- name: 'myimage'
  type: 'ociImage'
  relation: 'external'
  version: 0.2.0
  access:
    type: ociRegistry
    imageReference: eu.gcr.io/gardener-project/component-cli:0.2.0

- name: 'myconfig'
  type: 'json'
  relation: 'local'
  input:
    type: "file"
    path: "some/path"
    mediaType: "application/octet-stream" # optional, defaulted to "application/octet-stream" or "application/gzip" if compress=true

Templating: All yaml/json defined resources can be templated using simple envsubst syntax. Variables are specified after a "--" and follow the syntax "=".

Note: Variable names are case-sensitive.

Example:

 [args] [--flags] -- MY_VAL=test

key:
  subkey: "abc ${MY_VAL}"


component-cli component-archive resources add COMPONENT_ARCHIVE_PATH [RESOURCE_PATH...] [flags]

Options

  -a, --archive string                  path to the component archive directory
      --component-name string           name of the component
      --component-name-mapping string   [OPTIONAL] repository context name mapping (default "urlPath")
      --component-version string        version of the component
  -h, --help                            help for add
      --repo-ctx string                 [OPTIONAL] repository context url for component to upload. The repository url will be automatically added to the repository contexts.

Options inherited from parent commands

      --cli                  logger runs as cli logger. enables cli logging
      --dev                  enable development logging which result in console encoding, enabled stacktrace and enabled caller
      --disable-caller       disable the caller of logs (default true)
      --disable-stacktrace   disable the stacktrace of error logs (default true)
      --disable-timestamp    disable timestamp output (default true)
  -v, --verbosity int        number for the log level verbosity (default 1)

SEE ALSO