@codiac.io/codiac-cli

v1.3.208

Published

a day ago

Local command line interface for managing enterprise assets and environments.

0High
0Medium
0Low

codiac.buildmeister

codiac

Codiac-CLI

Usage

$ npm install -g @codiac.io/codiac-cli
$ codiac COMMAND
running command...
$ codiac (--version|-v)
@codiac.io/codiac-cli/1.3.208 linux-x64 node-v22.15.1
$ codiac --help [COMMAND]
USAGE
  $ codiac COMMAND
...

`codiac asset create`

Creates a new asset in the given enterprise from an image that exists in a container registry.

USAGE
  $ codiac asset create [-h] [-k <value> | -i <value> | -r <value>] [-n <value>] [-c <value>] [-e <value>] [-p
    <value>] [--private -g] [-o] [--allow-http] [--disable-https] [--helm] [--deploy-condition-because <value>
    --deploy-condition <value>] [--take-defaults | [--silent | --echo | --to-script]]

FLAGS
  -c, --code=<value>
      The host name to assign this asset in the domain url.  eg: 'myasset' in 'myasset.your-domain.com' (Optional:
      defaults to the asset name).

  -e, --enterprise=<value>
      The name of the enterprise in which to create this asset. (defaults to the current enterprise context)

  -g, --hasIngress
      Declaration that the asset service is to be accessible from outside the cluster (optional: defaults to false).

  -h, --help
      Show CLI help.

  -i, --image=<value>
      The image name including scope prefix if applicable (eg: '@yourCompany/your-api-image').

  -k, --kit=<value>
      The name of the kit (with library prefix, eg: 'library/kitName') to use to create the asset.  Use '?' to be prompted
      for a kit (Optional: used instead of calling for the image).

  -n, --name=<value>
      The name to give the enterprise asset (Optional: defaults to the image name without the scope prefix).

  -o, --routedWithoutName
      Indicates that this asset will be the base ingress against your DNS. eg: true services yourwebsite.com (as
      root/naked) (optional: defaults to false).

  -p, --port=<value>...
      The default port number (from 0 to 65535) to assign the asset when deployed to a cabinet (optional).  To specify
      port forwarding (betw the service and container), use format: `<service-port>:<container-port>`, eg: `3555:80`

  -r, --registry=<value>
      The container registry in which the image exists (defaults to docker hub).

  --allow-http
      (Advanced) Enable this setting to allow http (ie: non-SSL/TLS) requests in through the ingress controller without
      getting redirected to https.  That is, Setting this to true will prevent the ingress controller from invoking an
      automatic redirect to https on any inbound http requests. (optional: defaults to false).

  --deploy-condition=<value>
      JSONata expression evaluated at deploy time; when falsy the asset is skipped rather than deployed (see
      https://jsonata.org for syntax). Uses the same expression context as config conditions: cabinet, cluster,
      environment, and asset variables are all in scope.

  --deploy-condition-because=<value>
      Human-readable explanation shown in the deploy output when this asset is skipped.

  --disable-https
      (Advanced) (optional: defaults to false) Enable this setting to remove support for https (aka: SSL/TLS) in the
      ingress controller.  Use this setting when tls terminates upstream of the cluster and its ingress controller.
      Setting this flag DOES NOT automatically set the `--allow-http` flag, so be diligent when using it.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --helm
      Indicates that this asset will be base on a Helm chart instead of a container (optional: defaults to false).

  --private
      (for use when hasIngress is also set) Prevents access from the internet.  That is, declares that asset service to
      only be accessible through ingress on internal networks (optional: defaults to false).  Useful for enabling private
      "east-west" (cross-cluster) communications without going out to the internet.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Creates a new asset in the given enterprise from an image that exists in a container registry.

ALIASES
  $ codiac asset new

EXAMPLES
  Create an asset interactively.

    $ codiac asset create

  Create an asset with a deploy condition so it is skipped on AKS clusters (which include metrics-server natively).

    $ codiac asset create -e myEnterprise -n metrics-server --deploy-condition "cluster.provider != 'azure'" \
      --deploy-condition-because 'AKS clusters include metrics-server natively.'

  Create an asset that only deploys to production environments.

    $ codiac asset create -e myEnterprise -n my-api --deploy-condition "environment.name = 'production'"

See code: src/commands/asset/create.ts

`codiac asset edit`

Changes asset attributes.

USAGE
  $ codiac asset edit [-e <value>] [-c <value>] [--deploy-condition-because <value> --deploy-condition <value>]
    [--remove-deploy-condition | ] [--echo | --to-script | [--silent -n <value>]]

FLAGS
  -c, --code=<value>                  The host name to assign this asset in the domain url.  eg: 'myasset' in
                                      'myasset.your-domain.com' (Optional: defaults to the asset name).
  -e, --enterprise=<value>            The name of the enterprise in which this asset resides. (defaults to the current
                                      enterprise context).  NOTE: The enterprise assignment for an asset is immutable
                                      and cannot be modified; this flag is used only for identifying the asset.
  -n, --name=<value>                  The name of the asset to edit.  NOTE: The asset name is immutable and cannot be
                                      modified; this flag is used only for identifying the asset.
  --deploy-condition=<value>          JSONata expression evaluated at deploy time; when falsy the asset is skipped
                                      rather than deployed (see https://jsonata.org for syntax). Uses the same
                                      expression context as config conditions: cabinet, cluster, environment, and asset
                                      variables are all in scope.
  --deploy-condition-because=<value>  Human-readable explanation shown in the deploy output when this asset is skipped.
  --echo                              Echo interaction mode; renders the equivalent non-interactive cli command for
                                      future use before final execution.
  --remove-deploy-condition           Removes any existing deploy condition from this asset so it always deploys.
  --silent                            Non-Interactive mode; executes without any user interaction and fails on any
                                      missing or invalid arguments.
  --to-script                         Toscript interaction mode; renders the equivalent non-interactive cli command
                                      WITHOUT any execution.

DESCRIPTION
  Changes asset attributes.

EXAMPLES
  Edit an asset interactively.

    $ codiac asset edit

  Edit a specific asset.

    $ codiac asset edit -e main -n my-api

  Set a deploy condition so the asset is skipped on AKS clusters (which include metrics-server natively).

    $ codiac asset edit -e myEnterprise -n metrics-server --deploy-condition "cluster.provider != 'azure'" \
      --deploy-condition-because 'AKS clusters include metrics-server natively.' --silent

  Set a deploy condition so the asset only deploys in production.

    $ codiac asset edit -e myEnterprise -n my-api --deploy-condition "environment.name = 'production'" --silent

  Remove a deploy condition so the asset always deploys.

    $ codiac asset edit -e myEnterprise -n my-api --remove-deploy-condition --silent

See code: src/commands/asset/edit.ts

`codiac asset entrypoint`

Sets the command run on container startup (Overrides the ENTRYPOINT set in the image itself, as well as any image elements specified using CMD)).

USAGE
  $ codiac asset entrypoint [-e <value>] [-d <value>] [-c <value>] [-c <value>] [-v <value>] [--echo | --to-script |
    [--silent -a <value>]]

FLAGS
  -a, --asset=<value>          The name of the asset to edit.  NOTE: The asset name is immutable and cannot be modified;
                               this flag is used only for identifying the asset.
  -c, --arg=<value>...         Gets passed to the entryPointCommand.  Often, the entrypointCommand opens a shell,
                               allowing this to be the command to run inside the shell,       eg: `--command="/bin/sh"
                               --arg="-c ls -a"` which yields: `/bin/sh -c ls -a`
  -c, --command=<value>        The command to run.  Not executed within a shell.
  -d, --workdir=<value>        (optional) Folder path within the image from which to execute the command. Overrides the
                               default working directory specified by the container image.
  -e, --enterprise=<value>     The name of the enterprise in which this asset resides. (defaults to the current
                               enterprise context).  NOTE: The enterprise assignment for an asset is immutable and
                               cannot be modified; this flag is used only for identifying the asset.
  -v, --version-range=<value>  (optional) The semantic version rule describing which versions of the asset will get this
                               entrypoint applied.  (eg: Just this one: `1.2.3`, or this one and any future patches:
                               `^1.2.3`, or any on or after this one: `>=1.2.3`, or any before this one `<1.2.3` , or
                               any between inclusive: `1.0.0 - 1.2.3`).  NOTE: Remember to wrap your range spec in
                               quotes if it has any spaces in it.
  --echo                       Echo interaction mode; renders the equivalent non-interactive cli command for future use
                               before final execution.
  --silent                     Non-Interactive mode; executes without any user interaction and fails on any missing or
                               invalid arguments.
  --to-script                  Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                               execution.

DESCRIPTION
  Sets the command run on container startup (Overrides the ENTRYPOINT set in the image itself, as well as any image
  elements specified using CMD)).

ALIASES
  $ codiac asset entrypoint

EXAMPLES
  Interactive

    $ codiac asset entrypoint

  Interactive, preset for the a specific asset.

    $ codiac asset entrypoint -a my-api

  Interactive as above, but when you have more than a single enterprise, and one of them is named `ml`.

    $ codiac asset entrypoint -e ml -a my-worker

  Invoking an executable from within a bash shell (this mock scenario just imports some credentials and workflows and
  once complete, the image shuts down)

    $ codiac asset entrypoint -a my-import --command '/bin/sh' --arg '-c'         --arg 'myexe import:credentials \
      --separate --input=/backup/credentials && myexe import:workflow --separate --input=/backup/workflows'

  Same as above but non-interactive (for use in scripts and pipelines)

    $ codiac asset entrypoint --silent -e ml -a my-import --command '/bin/sh' --arg '-c'         --arg 'myexe \
      import:credentials --separate --input=/backup/credentials && myexe import:workflow --separate \
      --input=/backup/workflows'

`codiac asset entrypoint delete`

Removes an existing override of the image startup command for this asset (restores the original ENTRYPOINT set in the image itself, as well as any image elements specified using CMD)).

USAGE
  $ codiac asset entrypoint delete [-e <value>] [-v <value>] [--echo | --to-script | [--silent -a <value>]]

FLAGS
  -a, --asset=<value>
      The name of the asset to adjust.

  -e, --enterprise=<value>
      The name of the enterprise in which this asset resides (defaults to the current enterprise context).

  -v, --version-range=<value>
      (optional, defaults to the entrypoint assigned to "any" version) Used to identify the entrypoint.  The semantic
      version rule describing which versions of the asset will get this entrypoint applied.  (eg: Just this one: `1.2.3`,
      or this one and any future patches: `^1.2.3`, or any on or after this one: `>=1.2.3`, or any before this one
      `<1.2.3` , or any between inclusive: `1.0.0 - 1.2.3`).  NOTE: Remember to wrap your range spec in quotes if it has
      any spaces in it.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Removes an existing override of the image startup command for this asset (restores the original ENTRYPOINT set in the
  image itself, as well as any image elements specified using CMD)).

EXAMPLES
  Interactive

    $ codiac asset entrypoint delete

  Interactive, preset for the a specific asset.

    $ codiac asset entrypoint delete -a my-api

  Interactive as above, but when you have more than a single enterprise, and one of them is named `ml`.

    $ codiac asset entrypoint delete -e ml -a my-worker

  Non-interactive, removal by specifying the version range with an explicit match

    $ codiac asset entrypoint delete -e ml -a my-worker -v '>=1.2.3' --silent

See code: src/commands/asset/entrypoint/delete.ts

`codiac asset entrypoint set`

Sets the command run on container startup (Overrides the ENTRYPOINT set in the image itself, as well as any image elements specified using CMD)).

USAGE
  $ codiac asset entrypoint set [-e <value>] [-d <value>] [-c <value>] [-c <value>] [-v <value>] [--echo | --to-script |
    [--silent -a <value>]]

FLAGS
  -a, --asset=<value>          The name of the asset to edit.  NOTE: The asset name is immutable and cannot be modified;
                               this flag is used only for identifying the asset.
  -c, --arg=<value>...         Gets passed to the entryPointCommand.  Often, the entrypointCommand opens a shell,
                               allowing this to be the command to run inside the shell,       eg: `--command="/bin/sh"
                               --arg="-c ls -a"` which yields: `/bin/sh -c ls -a`
  -c, --command=<value>        The command to run.  Not executed within a shell.
  -d, --workdir=<value>        (optional) Folder path within the image from which to execute the command. Overrides the
                               default working directory specified by the container image.
  -e, --enterprise=<value>     The name of the enterprise in which this asset resides. (defaults to the current
                               enterprise context).  NOTE: The enterprise assignment for an asset is immutable and
                               cannot be modified; this flag is used only for identifying the asset.
  -v, --version-range=<value>  (optional) The semantic version rule describing which versions of the asset will get this
                               entrypoint applied.  (eg: Just this one: `1.2.3`, or this one and any future patches:
                               `^1.2.3`, or any on or after this one: `>=1.2.3`, or any before this one `<1.2.3` , or
                               any between inclusive: `1.0.0 - 1.2.3`).  NOTE: Remember to wrap your range spec in
                               quotes if it has any spaces in it.
  --echo                       Echo interaction mode; renders the equivalent non-interactive cli command for future use
                               before final execution.
  --silent                     Non-Interactive mode; executes without any user interaction and fails on any missing or
                               invalid arguments.
  --to-script                  Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                               execution.

DESCRIPTION
  Sets the command run on container startup (Overrides the ENTRYPOINT set in the image itself, as well as any image
  elements specified using CMD)).

ALIASES
  $ codiac asset entrypoint

EXAMPLES
  Interactive

    $ codiac asset entrypoint set

  Interactive, preset for the a specific asset.

    $ codiac asset entrypoint set -a my-api

  Interactive as above, but when you have more than a single enterprise, and one of them is named `ml`.

    $ codiac asset entrypoint set -e ml -a my-worker

  Invoking an executable from within a bash shell (this mock scenario just imports some credentials and workflows and
  once complete, the image shuts down)

    $ codiac asset entrypoint set -a my-import --command '/bin/sh' --arg '-c'         --arg 'myexe \
      import:credentials --separate --input=/backup/credentials && myexe import:workflow --separate \
      --input=/backup/workflows'

  Same as above but non-interactive (for use in scripts and pipelines)

    $ codiac asset entrypoint set --silent -e ml -a my-import --command '/bin/sh' --arg '-c'         --arg 'myexe \
      import:credentials --separate --input=/backup/credentials && myexe import:workflow --separate \
      --input=/backup/workflows'

See code: src/commands/asset/entrypoint/set.ts

`codiac asset get [CMD]`

Renders a selected type of content for an asset

USAGE
  $ codiac asset get [CMD] [-h] [-e <value>] [-a <value>] [-n <value>] [-c <value>] [-r <value>] [-t
    logs|term|exec|env|config|status] [--terminal bash|sh] [-f] [-l <value>] [-F <value>] [-T
    annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onpredeploy|permit|probing | ]
    [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  CMD  (requires type=exec) command and its space-separated arguments to run in the target replica.

FLAGS
  -F, --configFile=<value>   (requires type=config) The root pathname to the config file to fetch.
  -T, --configType=<option>  Filters for the settings types that do not land in a config file (such as... env: OS
                             environment variables, footprint: container footprint specs, helm: helm chart settings,
                             label: container meta labels, annotation: container platform key-value pairs).
                             <options: annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onp
                             redeploy|permit|probing>
  -a, --asset=<value>        The name of the asset to view.
  -c, --cabinet=<value>      The name of the cabinet from which the content is to be drawn.
  -e, --enterprise=<value>   The name of the enterprise containing the asset being viewed.
  -f, --logsFollow           (requires type=logs) Follow (aka watch, tail, stream) the output.
  -h, --help                 Show CLI help.
  -l, --logsTail=<value>     [default: 10] (requires type=logs) Lines of recent logs to include in the output.  Enter -1
                             to include the entire log history stored in the container.
  -n, --environment=<value>  The name of the environment in which the cabinet resides.
  -r, --replica=<value>      The name of one of the asset instances currently running in the cabinet. Set to "any" to
                             select the first available replica without prompting for one.
  -t, --type=<option>        The type of content to retrieve.
                             <options: logs|term|exec|env|config|status>
  --echo                     Echo interaction mode; renders the equivalent non-interactive cli command for future use
                             before final execution.
  --silent                   Non-Interactive mode; executes without any user interaction and fails on any missing or
                             invalid arguments.
  --take-defaults            Prevents prompting for confirmation on parameters that were passed in or were set to
                             default values.
  --terminal=<option>        Command used to start the terminal (defaults to "bash")
                             <options: bash|sh>
  --to-script                Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                             execution.

DESCRIPTION
  Renders a selected type of content for an asset

ALIASES
  $ codiac asset monitor
  $ codiac asset mon
  $ codiac asset get

`codiac asset list`

Shows the list of assets in a given enterprise.

USAGE
  $ codiac asset list [-h] [-e <value>] [-o text|tree|json|yaml] [-q <value>] [--silent | --echo | --to-script]

FLAGS
  -e, --enterprise=<value>  The name of the enterprise containing the assets being viewed (required if there are more
                            than one).
  -h, --help                Show CLI help.
  -o, --output=<option>     Format in which to render the results.
                            <options: text|tree|json|yaml>
  -q, --query=<value>       JMESPath expression to filter or reshape the results (see jmespath.org).
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Shows the list of assets in a given enterprise.

EXAMPLES
  Simple listing.

    $ codiac asset list

  List of asset names only.

    $ codiac asset list -q '[].name'

  Multi-property projection.

    $ codiac asset list -q '[].{ name: name, product: product }'

  Filter assets with ingress.

    $ codiac asset list -q "[?hasIngress == 'true']"

  Export as YAML.

    $ codiac asset list -o yaml

  Non-interactive invocation.

    $ codiac asset list -e myEnterprise --silent

  Renders the equivalent silent command without executing.

    $ codiac asset list -e myEnterprise --to-script

See code: src/commands/asset/list.ts

`codiac asset mon [CMD]`

Renders a selected type of content for an asset

USAGE
  $ codiac asset mon [CMD] [-h] [-e <value>] [-a <value>] [-n <value>] [-c <value>] [-r <value>] [-t
    logs|term|exec|env|config|status] [--terminal bash|sh] [-f] [-l <value>] [-F <value>] [-T
    annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onpredeploy|permit|probing | ]
    [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  CMD  (requires type=exec) command and its space-separated arguments to run in the target replica.

FLAGS
  -F, --configFile=<value>   (requires type=config) The root pathname to the config file to fetch.
  -T, --configType=<option>  Filters for the settings types that do not land in a config file (such as... env: OS
                             environment variables, footprint: container footprint specs, helm: helm chart settings,
                             label: container meta labels, annotation: container platform key-value pairs).
                             <options: annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onp
                             redeploy|permit|probing>
  -a, --asset=<value>        The name of the asset to view.
  -c, --cabinet=<value>      The name of the cabinet from which the content is to be drawn.
  -e, --enterprise=<value>   The name of the enterprise containing the asset being viewed.
  -f, --logsFollow           (requires type=logs) Follow (aka watch, tail, stream) the output.
  -h, --help                 Show CLI help.
  -l, --logsTail=<value>     [default: 10] (requires type=logs) Lines of recent logs to include in the output.  Enter -1
                             to include the entire log history stored in the container.
  -n, --environment=<value>  The name of the environment in which the cabinet resides.
  -r, --replica=<value>      The name of one of the asset instances currently running in the cabinet. Set to "any" to
                             select the first available replica without prompting for one.
  -t, --type=<option>        The type of content to retrieve.
                             <options: logs|term|exec|env|config|status>
  --echo                     Echo interaction mode; renders the equivalent non-interactive cli command for future use
                             before final execution.
  --silent                   Non-Interactive mode; executes without any user interaction and fails on any missing or
                             invalid arguments.
  --take-defaults            Prevents prompting for confirmation on parameters that were passed in or were set to
                             default values.
  --terminal=<option>        Command used to start the terminal (defaults to "bash")
                             <options: bash|sh>
  --to-script                Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                             execution.

DESCRIPTION
  Renders a selected type of content for an asset

ALIASES
  $ codiac asset monitor
  $ codiac asset mon
  $ codiac asset get

`codiac asset monitor [CMD]`

Renders a selected type of content for an asset

USAGE
  $ codiac asset monitor [CMD] [-h] [-e <value>] [-a <value>] [-n <value>] [-c <value>] [-r <value>] [-t
    logs|term|exec|env|config|status] [--terminal bash|sh] [-f] [-l <value>] [-F <value>] [-T
    annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onpredeploy|permit|probing | ]
    [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  CMD  (requires type=exec) command and its space-separated arguments to run in the target replica.

FLAGS
  -F, --configFile=<value>   (requires type=config) The root pathname to the config file to fetch.
  -T, --configType=<option>  Filters for the settings types that do not land in a config file (such as... env: OS
                             environment variables, footprint: container footprint specs, helm: helm chart settings,
                             label: container meta labels, annotation: container platform key-value pairs).
                             <options: annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onp
                             redeploy|permit|probing>
  -a, --asset=<value>        The name of the asset to view.
  -c, --cabinet=<value>      The name of the cabinet from which the content is to be drawn.
  -e, --enterprise=<value>   The name of the enterprise containing the asset being viewed.
  -f, --logsFollow           (requires type=logs) Follow (aka watch, tail, stream) the output.
  -h, --help                 Show CLI help.
  -l, --logsTail=<value>     [default: 10] (requires type=logs) Lines of recent logs to include in the output.  Enter -1
                             to include the entire log history stored in the container.
  -n, --environment=<value>  The name of the environment in which the cabinet resides.
  -r, --replica=<value>      The name of one of the asset instances currently running in the cabinet. Set to "any" to
                             select the first available replica without prompting for one.
  -t, --type=<option>        The type of content to retrieve.
                             <options: logs|term|exec|env|config|status>
  --echo                     Echo interaction mode; renders the equivalent non-interactive cli command for future use
                             before final execution.
  --silent                   Non-Interactive mode; executes without any user interaction and fails on any missing or
                             invalid arguments.
  --take-defaults            Prevents prompting for confirmation on parameters that were passed in or were set to
                             default values.
  --terminal=<option>        Command used to start the terminal (defaults to "bash")
                             <options: bash|sh>
  --to-script                Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                             execution.

DESCRIPTION
  Renders a selected type of content for an asset

ALIASES
  $ codiac asset monitor
  $ codiac asset mon
  $ codiac asset get

`codiac asset new`

Creates a new asset in the given enterprise from an image that exists in a container registry.

USAGE
  $ codiac asset new [-h] [-k <value> | -i <value> | -r <value>] [-n <value>] [-c <value>] [-e <value>] [-p
    <value>] [--private -g] [-o] [--allow-http] [--disable-https] [--helm] [--deploy-condition-because <value>
    --deploy-condition <value>] [--take-defaults | [--silent | --echo | --to-script]]

FLAGS
  -c, --code=<value>
      The host name to assign this asset in the domain url.  eg: 'myasset' in 'myasset.your-domain.com' (Optional:
      defaults to the asset name).

  -e, --enterprise=<value>
      The name of the enterprise in which to create this asset. (defaults to the current enterprise context)

  -g, --hasIngress
      Declaration that the asset service is to be accessible from outside the cluster (optional: defaults to false).

  -h, --help
      Show CLI help.

  -i, --image=<value>
      The image name including scope prefix if applicable (eg: '@yourCompany/your-api-image').

  -k, --kit=<value>
      The name of the kit (with library prefix, eg: 'library/kitName') to use to create the asset.  Use '?' to be prompted
      for a kit (Optional: used instead of calling for the image).

  -n, --name=<value>
      The name to give the enterprise asset (Optional: defaults to the image name without the scope prefix).

  -o, --routedWithoutName
      Indicates that this asset will be the base ingress against your DNS. eg: true services yourwebsite.com (as
      root/naked) (optional: defaults to false).

  -p, --port=<value>...
      The default port number (from 0 to 65535) to assign the asset when deployed to a cabinet (optional).  To specify
      port forwarding (betw the service and container), use format: `<service-port>:<container-port>`, eg: `3555:80`

  -r, --registry=<value>
      The container registry in which the image exists (defaults to docker hub).

  --allow-http
      (Advanced) Enable this setting to allow http (ie: non-SSL/TLS) requests in through the ingress controller without
      getting redirected to https.  That is, Setting this to true will prevent the ingress controller from invoking an
      automatic redirect to https on any inbound http requests. (optional: defaults to false).

  --deploy-condition=<value>
      JSONata expression evaluated at deploy time; when falsy the asset is skipped rather than deployed (see
      https://jsonata.org for syntax). Uses the same expression context as config conditions: cabinet, cluster,
      environment, and asset variables are all in scope.

  --deploy-condition-because=<value>
      Human-readable explanation shown in the deploy output when this asset is skipped.

  --disable-https
      (Advanced) (optional: defaults to false) Enable this setting to remove support for https (aka: SSL/TLS) in the
      ingress controller.  Use this setting when tls terminates upstream of the cluster and its ingress controller.
      Setting this flag DOES NOT automatically set the `--allow-http` flag, so be diligent when using it.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --helm
      Indicates that this asset will be base on a Helm chart instead of a container (optional: defaults to false).

  --private
      (for use when hasIngress is also set) Prevents access from the internet.  That is, declares that asset service to
      only be accessible through ingress on internal networks (optional: defaults to false).  Useful for enabling private
      "east-west" (cross-cluster) communications without going out to the internet.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Creates a new asset in the given enterprise from an image that exists in a container registry.

ALIASES
  $ codiac asset new

EXAMPLES
  Create an asset interactively.

    $ codiac asset new

  Create an asset with a deploy condition so it is skipped on AKS clusters (which include metrics-server natively).

    $ codiac asset new -e myEnterprise -n metrics-server --deploy-condition "cluster.provider != 'azure'" \
      --deploy-condition-because 'AKS clusters include metrics-server natively.'

  Create an asset that only deploys to production environments.

    $ codiac asset new -e myEnterprise -n my-api --deploy-condition "environment.name = 'production'"

`codiac asset obliterate`

Performs a full cascading delete of the given asset and all of its related data in Codiac (eg: versions, probes, configs, tags...). NOTE: This command does NOT delete anything from the image registry. NOTE: To obliterate an asset, you must first remove it from all cabinets; this command will not obliterate any asset that is currently deployed.

USAGE
  $ codiac asset obliterate [-e <value>] [--echo | --to-script | [--silent -n <value>]]

FLAGS
  -e, --enterprise=<value>  The name of the enterprise in which to create this asset. (defaults to the current
                            enterprise context)
  -n, --name=<value>        The name of the asset to obliterate.
  --echo                    Echo interaction mode; renders the equivalent non-interactive cli command for future use
                            before final execution.
  --silent                  Non-Interactive mode; executes without any user interaction and fails on any missing or
                            invalid arguments.
  --to-script               Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                            execution.

DESCRIPTION
  Performs a full cascading delete of the given asset and all of its related data in Codiac (eg: versions, probes,
  configs, tags...). NOTE: This command does NOT delete anything from the image registry.  NOTE: To obliterate an asset,
  you must first remove it from all cabinets; this command will not obliterate any asset that is currently deployed.

EXAMPLES
  $ codiac asset obliterate

  $ codiac asset obliterate -n my-api

  $ codiac asset obliterate -e main -n my-api

See code: src/commands/asset/obliterate.ts

`codiac asset probe create [CMD]`

Declares the implementation of a health or readiness probe for an asset.

USAGE
  $ codiac asset probe create [CMD] -u readiness|liveness|startup [-h] [-n <value>] [-a <value>] [-v <value>] [-d
    <value>] [-p <value>] [-t <value>] [--success-threshold <value>] [--failure-threshold <value>] [--predefined <value>
    | --exec | --grpc | --http | --socket] [-x <value>] [--grpcHost <value> ] [--grpcPort <value> ] [--httpScheme
    http|https ] [--httpHost <value> ] [--httpPort <value> ] [--httpPath <value> ] [-r <value> ] [--socketHost <value> ]
    [--socketPort <value> ] [--silent | --echo | --to-script]

ARGUMENTS
  CMD  (requires --exec) command and its space-separated arguments to run in the target replica.

FLAGS
  -a, --asset=<value>          The name of the asset to which this probe is to apply.
  -d, --delay=<value>          The time (in seconds) to wait before the first execution of the probe.
  -h, --help                   Show CLI help.
  -n, --enterprise=<value>     The name of the enterprise to which this probe is to apply.
  -p, --period=<value>         [default: 10] How often (in seconds) to fire the probe.
  -r, --httpHeader=<value>...  (For use only with http) Key value pair (in format x=y) to be used as an http header in
                               an http probe action.
  -t, --timeout=<value>        How long to wait (in seconds) for a probe to respond before declaring it a failed
                               execution (default and min 1 second).
  -u, --usage=<option>         (required) [default: readiness] The diagnostic purpose the probe will serve.
                               <options: readiness|liveness|startup>
  -v, --versions=<value>       Asset version range for which this probe is to be used. (optional: defaults to >=latest)
  -x, --action=<value>         The JSON specification for the probe action itself.  The structure follows the
                               actionType.
  --echo                       Renders the equivalent non-interactive command for future use before executing.
  --exec                       Declares the probe shall be carried out as an executable CLI command. A return code of
                               zero indicates success.  Any nonzero result indicates failure.
  --failure-threshold=<value>  The number of unsuccessful probe executions to allow before determining the pod
                               unhealthy.
  --grpc                       Declares the probe shal

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Codiac-CLI

Usage

codiac asset create

codiac asset edit

codiac asset entrypoint

codiac asset entrypoint delete

codiac asset entrypoint set

codiac asset get [CMD]

codiac asset list

codiac asset mon [CMD]

codiac asset monitor [CMD]

codiac asset new

codiac asset obliterate

codiac asset probe create [CMD]

`codiac asset create`

`codiac asset edit`

`codiac asset entrypoint`

`codiac asset entrypoint delete`

`codiac asset entrypoint set`

`codiac asset get [CMD]`

`codiac asset list`

`codiac asset mon [CMD]`

`codiac asset monitor [CMD]`

`codiac asset new`

`codiac asset obliterate`

`codiac asset probe create [CMD]`