Common Arguments

Common arguments

A few sets of arguments are common between multiple commands. These arguments are still part of the command itself and must be placed after the command name.

Global arguments

These arguments are available for all commands.

Global arguments:
      --cpu-profile string   Enable CPU profiling and write the result to the given path
      --debug                Enable debug logging
      --no-color             Disable colored output
      --no-update-check      Disable update check on startup

Project arguments

These arguments are available for all commands that are based on a Kluctl project. They control where and how to load the kluctl project and deployment project.

Project arguments:
  Define where and how to load the kluctl project and its components from.

  -a, --arg stringArray                      Template argument in the form name=value
      --cluster string                       DEPRECATED. Specify/Override cluster
      --git-cache-update-interval duration   Specify the time to wait between git cache updates. Defaults to not
                                             wait at all and always updating caches.
      --local-clusters existingdir           DEPRECATED. Local clusters directory. Overrides the project from
                                             .kluctl.yaml
      --local-deployment existingdir         DEPRECATED. Local deployment directory. Overrides the project from
                                             .kluctl.yaml
      --local-sealed-secrets existingdir     DEPRECATED. Local sealed-secrets directory. Overrides the project
                                             from .kluctl.yaml
      --output-metadata string               Specify the output path for the project metadata to be written to.
  -c, --project-config existingfile          Location of the .kluctl.yaml config file. Defaults to
                                             $PROJECT/.kluctl.yaml
  -b, --project-ref string                   Git ref of the kluctl project. Only used when --project-url was given.
  -p, --project-url string                   Git url of the kluctl project. If not specified, the current
                                             directory will be used instead of a remote Git project
  -t, --target string                        Target name to run command for. Target must exist in .kluctl.yaml.
      --timeout duration                     Specify timeout for all operations, including loading of the project,
                                             all external api calls and waiting for readiness. (default 10m0s)

Image arguments

These arguments are available on some target based commands. They control image versions requested by images.get_image(...) calls.

Image arguments:
  Control fixed images and update behaviour.

  -F, --fixed-image stringArray          Pin an image to a given version. Expects
                                         '--fixed-image=image<:namespace:deployment:container>=result'
      --fixed-images-file existingfile   Use .yaml file to pin image versions. See output of list-images
                                         sub-command or read the documentation for details about the output format
      --offline-images                   Omit contacting image registries and do not query for latest image tags.
  -u, --update-images                    This causes kluctl to prefer the latest image found in registries, based
                                         on the 'latest_image' filters provided to 'images.get_image(...)' calls.
                                         Use this flag if you want to update to the latest versions/tags of all
                                         images. '-u' takes precedence over '--fixed-image/--fixed-images-file',
                                         meaning that the latest images are used even if an older image is given
                                         via fixed images.

Inclusion/Exclusion arguments

These arguments are available for some target based commands. They control inclusion/exclusion based on tags and deployment item pathes.

Inclusion/Exclusion arguments:
  Control inclusion/exclusion.

      --exclude-deployment-dir stringArray   Exclude deployment dir. The path must be relative to the root
                                             deployment project. Exclusion has precedence over inclusion, same as
                                             in --exclude-tag
  -E, --exclude-tag stringArray              Exclude deployments with given tag. Exclusion has precedence over
                                             inclusion, meaning that explicitly excluded deployments will always
                                             be excluded even if an inclusion rule would match the same deployment.
      --include-deployment-dir stringArray   Include deployment dir. The path must be relative to the root
                                             deployment project.
  -I, --include-tag stringArray              Include deployments with given tag.
Last modified September 27, 2022: docs: Update commands (789c019)