Armory Halyard

hal

A tool for configuring, installing, and updating Spinnaker.

If this is your first time using Halyard to install Spinnaker we recommend that you skim the documentation on www.spinnaker.io/docs for some familiarity with the product. If at any point you get stuck using ‘hal’, every command can be suffixed with ‘–help’ for usage information.

Usage

hal [parameters] [subcommands]

Global Parameters

  • --daemon-endpoint: If supplied, connect to the daemon at this address.
  • --options: Get options for the specified field name.
  • -a, --alpha: Enable alpha halyard features.
  • -c, --color: Enable terminal color output.
  • -d, --debug: Show detailed network traffic with halyard daemon.
  • -h, --help: (Default: false) Display help text about this command.
  • -l, --log: Set the log level of the CLI.
  • -o, --output: Format the CLIs output.
  • -q, --quiet: Show no task information or messages. When set, ANSI formatting will be disabled, and all prompts will be accepted.

Parameters

  • --docs: (Default: false) Print markdown docs for the hal CLI.
  • --print-bash-completion: (Default: false) Print bash command completion. This is used during the installation of Halyard.
  • --ready: (Default: false) Check if Halyard is up and running. Will exit with non-zero return code when it isn’t.
  • --version, -v: (Default: false) Version of Halyard.

Subcommands

  • armory: Armory-specific commands are described here.

hal armory

Armory-specific commands are described here.

Usage

hal armory [subcommands]

Subcommands

  • diagnostics: configure diagnostics reporting
  • dinghy: configure Dinghy pipelines as code
  • init: Runs Armory installer

hal armory diagnostics

configure diagnostics reporting

Usage

hal armory diagnostics [parameters] [subcommands]

Parameters

  • --deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
  • --no-validate: (Default: false) Skip validation.

Subcommands

  • disable: Set diagnostics as disabled
  • edit: Edit diagnostics settings
  • enable: Set diagnostics as enabled

hal armory diagnostics disable

Set diagnostics as disabled

Usage

hal armory diagnostics disable [parameters]

Parameters

  • --deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
  • --no-validate: (Default: false) Skip validation.

hal armory diagnostics edit

Edit diagnostics settings

Usage

hal armory diagnostics edit [parameters]

Parameters

  • --deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
  • --no-validate: (Default: false) Skip validation.
  • --uuid: (Required) UUID of the Armory installation

hal armory diagnostics enable

Set diagnostics as enabled

Usage

hal armory diagnostics enable [parameters]

Parameters

  • --deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
  • --no-validate: (Default: false) Skip validation.

hal armory dinghy

configure Dinghy pipelines as code

Usage

hal armory dinghy [parameters] [subcommands]

Parameters

  • --deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
  • --no-validate: (Default: false) Skip validation.

Subcommands

  • disable: Set Dinghy as disabled
  • edit: Edit Dinghy settings
  • enable: Set Dinghy as enabled

hal armory dinghy disable

Set Dinghy as disabled

Usage

hal armory dinghy disable [parameters]

Parameters

  • --deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
  • --no-validate: (Default: false) Skip validation.

hal armory dinghy edit

Edit Dinghy settings

Usage

hal armory dinghy edit [parameters]

Parameters

  • --autolock-pipelines: (Default: true) Lock pipelines in the UI before overwriting on change.
  • --deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
  • --dinghyfile-name: (Default: dinghyfile) Name of the file in application repositories which contains pipelines
  • --fiat-user: Fiat user to use for Dinghy operations.
  • --github-endpoint: (Default: https://api.github.com) Github API endpoint. Useful if you’re using Github Enterprise.
  • --github-token: (Sensitive data - user will be prompted on standard input) GitHub token.
  • --no-validate: (Default: false) Skip validation.
  • --stash-endpoint: Stash API endpoint.
  • --stash-token: (Sensitive data - user will be prompted on standard input) Stash token.
  • --stash-username: Stash username.
  • --template-org: (Required) SCM organization or namespace where application and template repositories are located.
  • --template-repo: (Required) SCM repository where module templates are located.

hal armory dinghy enable

Set Dinghy as enabled

Usage

hal armory dinghy enable [parameters]

Parameters

  • --deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
  • --no-validate: (Default: false) Skip validation.

hal armory init

Runs Armory installer

Usage

hal armory init [parameters]

Parameters

  • --allow-small: Passed to armory-install. Don’t stop installation if cluster does not have enough resources
  • --deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
  • --edge: Passed to armory-install. Set if you want to run on the latest version
  • --no-diagnostics: Turns off all diagnostics
  • --no-validate: (Default: false) Skip validation.
  • --path: The path to where armory-install is already installed