fleetcommand-agent command reference

Note
 See Run Commands to access the default entry point for the fleetcommand-agent container and launch commands.

fleetcommand-agent is an automation tool that deploys and configures Domino. It supports the following commands.

init

Generates a template configuration file.

Arguments
--file or -f

Write the template to the listed file system path. This must be a host volume mounted to the container.

--full or -F

Include optional and advanced portions of the template. Only use when advanced options are required. Configurations with these arguments are more complex to maintain.

--image-registry

Provide a registry URI to prepend to Domino images. This sets up the template for installation from a private Docker registry. Must be used with --full.

--version

Generate a configuration template for the listed Domino version.

--template or -t

Initialize the configuration with values from a template. This can be used to upgrade the schema.

--preset

Generate a configuration file for target preset. Valid values: [eks, aks, gke, openshift]

Example
docker run --rm -v $(pwd):/install quay.io/domino/fleetcommand-agent:v63.2
init --file /install/domino.yml

run

Install Domino into a cluster specified by a Kubernetes configuration from the KUBECONFIG environment variable. You must pass a valid configuration file to this command.

Note
 This fleetcommand-agent command requires mapping a Kubernetes configuration file into the container or running from inside the Kubernetes cluster with an appropriate service account. Configuration files that rely on third-party utilities (such as awscli for EKS) may not work. See the Install process section for details on installing from within the cluster.
Arguments
--file or -f

File system path to a complete and valid configuration file.

--kubeconfig

Path to a Kubernetes configuration file that contains the cluster and authentication information to use.

--dry

Run the command without making any permanent changes to the target cluster. This outputs all chart changes in the form of a list of newly added charts and a diff for any updated existing charts. Note that the --dry option relies on the Kubernetes secret, credential-store-domino-platform in the domino-system namespace. If any changes have been made to the secrets' schema, use the --local-secrets option along with --dry. This generates temporary secrets and avoids errors. You cannot use this option on a completely fresh Kubernetes cluster onto which Domino has not yet been installed.

--services or -s

Specific services to operate on. Multiple services can be specified in comma-delimited format: -s "service-a,service-b"

--[no-]sync

Force sync on or off. When on, fleetcommand-agent always redeploys all releases. When not specified, the option is automatically enabled when failed releases are detected; otherwise, it defaults to off.

--[no-]atomic

Force atomic mode on or off. When on, automatically rolls back releases on failure. Combining with --no-sync can result in skipping failed releases.

--skip-cleanup

Skip cleanup of temporary files for debugging purposes. Incompatible with --sync and --dry.

--warn-only

Don’t fail on certain validation errors; only warn. This bypasses checks for Mongo upgrade version compatibility and metrics-server presence.

--local-secrets

Cache secrets locally in plain text, within the agent’s container. Useful for dry runs on upgrades, as changes to the live secrets schema might be required to perform a dry run, but a dry run doesn’t update that live secret.

Example
docker run --rm -v $(pwd):/install quay.io/domino/fleetcommand-agent:v63.2 run --file /install/domino.yml

destroy

Remove all resources from the target cluster for a configuration file.

Note
 This fleetcommand-agent command requires mapping a Kubernetes configuration file into the container or running from inside the Kubernetes cluster with an appropriate service account. Configuration files that rely on third-party utilities (such as awscli for EKS) may not work. See the Install process section for details on installing from within the cluster.
Arguments
--file or -f

File system path to a complete and valid configuration file.

--kubeconfig

Path to Kubernetes configuration file that contains the cluster and authentication information to use.

--dry

Run the command without making permanent changes to the target cluster. A dry run checks service account permissions and generates detailed logs about the charts deployed with the configuration.

Example
docker run --rm -v $(pwd):/install quay.io/domino/fleetcommand-agent:v63.2
destroy --file /install/domino.yml

write-values

Write values files.

Arguments
--file or -f

The file system path to a complete and valid configuration file.

--services or -s

Only render templates for specific services. Multiple services can be specified in comma-delimited format: -s "service-a,service-b"

Note
 This also renders dependencies.
--output-dir

The directory where templates are written.

--output-file-template

The filename of the Go text template for generating the output files; the default is {{ .State.BaseName }}/{{ .Release.Name }}.yaml.

--kubeconfig

The path to the Kubernetes configuration file that contains the cluster and authentication information to use.

Example
docker run --rm -v $(pwd):/install quay.io/domino/fleetcommand-agent:v63.2
write-values --file /install/domino.yml --output-dir /install/values

template

Write rendered chart templates.

Arguments
--file or -f

The file system path to a complete and valid configuration file.

--services or -s

Only render templates for specific services. Note: This will also render dependencies. Multiple services can be specified in comma-delimited format: -s "service-a,service-b"

--output-dir

The directory where templates are written.

--output-dir-template

The filename of the Go text template for generating the output files; the default is {{&nbps;.OutputDir&nbps;}}/{{&nbps;.Release.Namespace&nbps;}}/{{&nbps;.Release.Name&nbps;}}.yaml.

--no-validate

Don’t validate charts against cluster.

--skip-cleanup

Don’t clean up temporary files.

--kubeconfig

Path to Kubernetes configuration file that contains the cluster and authentication information to use.

Example
docker run --rm -v $(pwd):/install quay.io/domino/fleetcommand-agent:v63.2
template --file /install/domino.yml --output-dir /install/values

image-overrides

Get all possible image overrides.

Arguments
--version

Generate image overrides for the requested version.

--server

The registry server hostname for images.

--prefix

Repository prefix (the domino in quay.io/domino/nucleus:tag).

Example
docker run --rm -v $(pwd):/install quay.io/domino/fleetcommand-agent:v63.2
image-overrides --version 5.5.1

config schema

Generate the JSON schema for the configuration.

Arguments
--file

The name of the file to which the schema is written.

--schema-version

The version of the schema from which to generate the output.

Example
docker run --rm -v $(pwd):/install quay.io/domino/fleetcommand-agent:v63.2
config schema --file /install/domino-schema.js

config lint

Validate the configuration.

Arguments
--file

The file system path to a complete and valid configuration file.

Example
docker run --rm -v $(pwd):/install quay.io/domino/fleetcommand-agent:v63.2
config lint --file /install/domino.yml