Spinnaker – Halyard

Docs: Commands

Mon, 01 Jan 0001 00:00:00 +0000

HALYARD IS DEPRECATED

[!IMPORTANT] At this time, halyard is considered deprecated and no longer supported.
This document is kept here and alive for historical purposes. Documentation should all be moved to native configuration files, and for more questions and information please join the spinnaker slack.

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 https://spinnaker.io/reference/halyard/ 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

admin: This is meant for users building and publishing their own Spinnaker images and config.
backup: Backup and restore (remote or local) copies of your halconfig and all required files.
config: Configure, validate, and view your halconfig.
deploy: Manage the deployment of Spinnaker. This includes where it’s deployed, what the infrastructure footprint looks like, what the currently running deployment looks like, etc…
plugins: Show Spinnaker’s configured plugins.
shutdown: Shutdown the halyard daemon.
spin: Manage the lifecycle of spin CLI.
task: This set of commands exposes utilities of dealing with Halyard’s task engine.
version: Get information about the available Spinnaker versions.

hal admin

This is meant for users building and publishing their own Spinnaker images and config.

Usage

hal admin [subcommands]

Subcommands

deprecate: Deprecate config artifacts in your configured halconfig bucket.
publish: Publish config artifacts to your configured halconfig bucket.

hal admin deprecate

Deprecate config artifacts in your configured halconfig bucket.

Usage

hal admin deprecate [subcommands]

Subcommands

version: Deprecate a version of Spinnaker, removing it from the global versions.yml tracking file.

hal admin deprecate version

Deprecate a version of Spinnaker, removing it from the global versions.yml tracking file.

Usage

hal admin deprecate version [parameters]

Parameters

--illegal-reason: If supplied, the version will not only be deprecated, but will no longer be installable by Halyard for the supplied reason
--version: (Required) The version (x.y.z) of Spinnaker to be deprecated.

hal admin publish

Publish config artifacts to your configured halconfig bucket.

Usage

hal admin publish [subcommands]

Subcommands

bom: Publish a Bill of Materials (BOM).
latest (Deprecated) : Publish the latest version of Spinnaker to the global versions.yml tracking file.
latest-halyard: Publish the latest version of Halyard to the global versions.yml tracking file.
latest-spinnaker: Publish the latest version of Spinnaker to the global versions.yml tracking file.
profile: Publish a base halconfig profile for a specific Spinnaker artifact.
version: Publish a version of Spinnaker to the global versions.yml tracking file.

hal admin publish bom

Publish a Bill of Materials (BOM).

Usage

hal admin publish bom [parameters]

Parameters

--bom-path: (Required) The path to the BOM owning the artifact to publish.

hal admin publish latest

Publish the latest version of Spinnaker to the global versions.yml tracking file.

Usage

hal admin publish latest VERSION

hal admin publish latest-halyard

Publish the latest version of Halyard to the global versions.yml tracking file.

Usage

hal admin publish latest-halyard VERSION

hal admin publish latest-spinnaker

Publish the latest version of Spinnaker to the global versions.yml tracking file.

Usage

hal admin publish latest-spinnaker VERSION

hal admin publish profile

Publish a base halconfig profile for a specific Spinnaker artifact.

Usage

hal admin publish profile ARTIFACT-NAME [parameters]

Parameters

ARTIFACT-NAME: The name of the artifact whose profile is being published (e.g. clouddriver).

--bom-path: (Required) The path to the BOM owning the artifact to publish.
--profile-path: (Required) The path to the artifact profile to publish.

hal admin publish version

Publish a version of Spinnaker to the global versions.yml tracking file.

Usage

hal admin publish version [parameters]

Parameters

--alias: (Required) The alias this version of Spinnaker goes by.
--changelog: (Required) A link to this Spinnaker release’s changelog.
--minimum-halyard-version: (Required) Minimum version of halyard required to install this release
--version: (Required) The version (x.y.z) of Spinnaker to be recorded. This must exist as a BOM.

hal backup

This is used to periodically checkpoint your configured Spinnaker installation as well as allow you to store all aspects of your configured Spinnaker installation, to be picked up by an installation of Halyard on another machine.

Usage

hal backup [subcommands]

Subcommands

create: Create a backup of Halyard’s state.
restore: Restore an existing backup.

hal backup create

This will create a tarball of your halconfig directory, being careful to rewrite file paths, so when the tarball is expanded by Halyard on another machine it will still be able to reference any files you have explicitly linked with your halconfig - e.g. –kubeconfig-file for Kubernetes, or –json-path for GCE.

Usage

hal backup create

hal backup restore

Restore an existing backup. This backup does not necessarily have to come from the machine it is being restored on - since all files referenced by your halconfig are included in the halconfig backup. As a result of this, keep in mind that after restoring a backup, all your required files are now in $halconfig/.backup/required-files.

Usage

hal backup restore [parameters]

Parameters

--backup-path: (Required) This is the path to the .tar file created by running hal backup create.

hal config

Configure, validate, and view your halconfig.

Usage

hal config [parameters] [subcommands]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--set-current-deployment: If supplied, set the current active deployment to the supplied value, creating it if need-be.

Subcommands

artifact: Configure, validate, and view the specified artifact provider.
canary: Configure your canary analysis settings for Spinnaker.
ci: Configure, validate, and view the specified Continuous Integration service.
deploy: Display the configured Spinnaker deployment.
edit: Configure top-level, global configuration parameters.
features: Display the state of Spinnaker’s feature flags.
generate: Generate the full Spinnaker config for your current deployment. This does not apply that configuration to your running Spinnaker installation. That either needs to be done manually, or with hal deploy apply.
list: Lists all deployments
metric-stores: Configure Spinnaker’s metric stores. Metrics stores are used to store metrics for the various Spinnaker micro-services. These metrics are not related in any way to canary deployments. The technologies backing both are similar, but metrics stores are places to push metrics regarding Spinnaker metrics, whereas canary metrics stores are used to pull metrics to analyze deployments. This configuration only affects the publishing of metrics against whichever metric stores you enable (it can be more than one).
notification: Display the state of Spinnaker’s notification settings.
provider: Configure, validate, and view the specified provider.
pubsub: Configure, validate, and view the specified pubsub.
repository: Configure, validate, and view the specified repository.
security: Configure Spinnaker’s security. This includes external SSL, authentication mechanisms, and authorization policies.
stats: Show Spinnaker’s stats settings.
storage: Show Spinnaker’s persistent storage configuration.
version: Configure & view the current deployment of Spinnaker’s version.
webhook: Show Spinnaker’s webhook configuration.

hal config artifact

Configure, validate, and view the specified artifact provider.

Usage

hal config artifact [subcommands]

Subcommands

bitbucket: Manage and view Spinnaker configuration for the bitbucket provider
gcs: Manage and view Spinnaker configuration for the gcs provider
github: Manage and view Spinnaker configuration for the github provider
gitlab: Manage and view Spinnaker configuration for the gitlab provider
gitrepo: Manage and view Spinnaker configuration for the gitrepo provider
helm: Manage and view Spinnaker configuration for the helm provider
http: Manage and view Spinnaker configuration for the http provider
maven: Manage and view Spinnaker configuration for the maven provider
oracle: Manage and view Spinnaker configuration for the oracle provider
s3: Manage and view Spinnaker configuration for the s3 provider
templates: Show Spinnaker’s configured artifact templates.

hal config artifact bitbucket

Manage and view Spinnaker configuration for the bitbucket provider

Usage

hal config artifact bitbucket [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the bitbucket artifact provider’s account
disable: Set the bitbucket artifact provider as disabled
enable: Set the bitbucket artifact provider as enabled

hal config artifact bitbucket account

Manage and view Spinnaker configuration for the bitbucket artifact provider’s account

Usage

hal config artifact bitbucket account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the account to operate on.

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

Subcommands

add: Add an artifact account to the bitbucket artifact provider.
delete: Delete a specific bitbucket artifact account by name.
edit: Edit an artifact account in the bitbucket artifact provider.
get: Get the specified account details for the bitbucket provider.
list: List the artifact account names for the bitbucket artifact provider.

hal config artifact bitbucket account add

Add an artifact account to the bitbucket artifact provider.

Usage

hal config artifact bitbucket account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--password: (Sensitive data - user will be prompted on standard input) Bitbucket password
--username: Bitbucket username
--username-password-file: File containing “username:password” to use for Bitbucket authentication

hal config artifact bitbucket account delete

Delete a specific bitbucket artifact account by name.

Usage

hal config artifact bitbucket account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config artifact bitbucket account edit

Edit an artifact account in the bitbucket artifact provider.

Usage

hal config artifact bitbucket account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--password: (Sensitive data - user will be prompted on standard input) Bitbucket password
--username: Bitbucket username
--username-password-file: File containing “username:password” to use for Bitbucket authentication

hal config artifact bitbucket account get

Get the specified account details for the bitbucket provider.

Usage

hal config artifact bitbucket account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config artifact bitbucket account list

List the artifact account names for the bitbucket artifact provider.

Usage

hal config artifact bitbucket account list [parameters]

Parameters

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

hal config artifact bitbucket disable

Set the bitbucket artifact provider as disabled

Usage

hal config artifact bitbucket disable [parameters]

Parameters

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

hal config artifact bitbucket enable

Set the bitbucket artifact provider as enabled

Usage

hal config artifact bitbucket enable [parameters]

Parameters

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

hal config artifact gcs

Manage and view Spinnaker configuration for the gcs provider

Usage

hal config artifact gcs [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the gcs artifact provider’s account
disable: Set the gcs artifact provider as disabled
enable: Set the gcs artifact provider as enabled

hal config artifact gcs account

Manage and view Spinnaker configuration for the gcs artifact provider’s account

Usage

hal config artifact gcs account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the account to operate on.

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

Subcommands

add: Add an artifact account to the gcs artifact provider.
delete: Delete a specific gcs artifact account by name.
edit: Edit an artifact account in the gcs artifact provider.
get: Get the specified account details for the gcs provider.
list: List the artifact account names for the gcs artifact provider.

hal config artifact gcs account add

Add an artifact account to the gcs artifact provider.

Usage

hal config artifact gcs account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--json-path: The path to a JSON service account that Spinnaker will use as credentials. This is only needed if Spinnaker is not deployed on a Google Compute Engine VM, or needs permissions not afforded to the VM it is running on. See https://cloud.google.com/compute/docs/access/service-accounts for more information.
--no-validate: (Default: false) Skip validation.

hal config artifact gcs account delete

Delete a specific gcs artifact account by name.

Usage

hal config artifact gcs account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config artifact gcs account edit

Edit an artifact account in the gcs artifact provider.

Usage

hal config artifact gcs account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--json-path: The path to a JSON service account that Spinnaker will use as credentials. This is only needed if Spinnaker is not deployed on a Google Compute Engine VM, or needs permissions not afforded to the VM it is running on. See https://cloud.google.com/compute/docs/access/service-accounts for more information.
--no-validate: (Default: false) Skip validation.

hal config artifact gcs account get

Get the specified account details for the gcs provider.

Usage

hal config artifact gcs account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config artifact gcs account list

List the artifact account names for the gcs artifact provider.

Usage

hal config artifact gcs account list [parameters]

Parameters

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

hal config artifact gcs disable

Set the gcs artifact provider as disabled

Usage

hal config artifact gcs disable [parameters]

Parameters

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

hal config artifact gcs enable

Set the gcs artifact provider as enabled

Usage

hal config artifact gcs enable [parameters]

Parameters

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

hal config artifact github

Manage and view Spinnaker configuration for the github provider

Usage

hal config artifact github [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the github artifact provider’s account
disable: Set the github artifact provider as disabled
enable: Set the github artifact provider as enabled

hal config artifact github account

Manage and view Spinnaker configuration for the github artifact provider’s account

Usage

hal config artifact github account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the account to operate on.

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

Subcommands

add: Add an artifact account to the github artifact provider.
delete: Delete a specific github artifact account by name.
edit: Edit an artifact account in the github artifact provider.
get: Get the specified account details for the github provider.
list: List the artifact account names for the github artifact provider.

hal config artifact github account add

Add an artifact account to the github artifact provider.

Usage

hal config artifact github account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--password: (Sensitive data - user will be prompted on standard input) GitHub password
--token: (Sensitive data - user will be prompted on standard input) GitHub token
--token-file: File containing a GitHub authentication token
--username: GitHub username
--username-password-file: File containing “username:password” to use for GitHub authentication

hal config artifact github account delete

Delete a specific github artifact account by name.

Usage

hal config artifact github account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config artifact github account edit

Edit an artifact account in the github artifact provider.

Usage

hal config artifact github account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--password: (Sensitive data - user will be prompted on standard input) GitHub password
--token: (Sensitive data - user will be prompted on standard input) GitHub token
--token-file: File containing a GitHub authentication token
--username: GitHub username
--username-password-file: File containing “username:password” to use for GitHub authentication

hal config artifact github account get

Get the specified account details for the github provider.

Usage

hal config artifact github account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config artifact github account list

List the artifact account names for the github artifact provider.

Usage

hal config artifact github account list [parameters]

Parameters

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

hal config artifact github disable

Set the github artifact provider as disabled

Usage

hal config artifact github disable [parameters]

Parameters

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

hal config artifact github enable

Set the github artifact provider as enabled

Usage

hal config artifact github enable [parameters]

Parameters

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

hal config artifact gitlab

Manage and view Spinnaker configuration for the gitlab provider

Usage

hal config artifact gitlab [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the gitlab artifact provider’s account
disable: Set the gitlab artifact provider as disabled
enable: Set the gitlab artifact provider as enabled

hal config artifact gitlab account

Manage and view Spinnaker configuration for the gitlab artifact provider’s account

Usage

hal config artifact gitlab account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the account to operate on.

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

Subcommands

add: Add an artifact account to the gitlab artifact provider.
delete: Delete a specific gitlab artifact account by name.
edit: Edit an artifact account in the gitlab artifact provider.
get: Get the specified account details for the gitlab provider.
list: List the artifact account names for the gitlab artifact provider.

hal config artifact gitlab account add

Add an artifact account to the gitlab artifact provider.

Usage

hal config artifact gitlab account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--token: (Sensitive data - user will be prompted on standard input) Gitlab token
--token-file: File containing a Gitlab authentication token

hal config artifact gitlab account delete

Delete a specific gitlab artifact account by name.

Usage

hal config artifact gitlab account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config artifact gitlab account edit

Edit an artifact account in the gitlab artifact provider.

Usage

hal config artifact gitlab account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--token: (Sensitive data - user will be prompted on standard input) Gitlab token
--token-file: File containing a Gitlab authentication token

hal config artifact gitlab account get

Get the specified account details for the gitlab provider.

Usage

hal config artifact gitlab account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config artifact gitlab account list

List the artifact account names for the gitlab artifact provider.

Usage

hal config artifact gitlab account list [parameters]

Parameters

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

hal config artifact gitlab disable

Set the gitlab artifact provider as disabled

Usage

hal config artifact gitlab disable [parameters]

Parameters

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

hal config artifact gitlab enable

Set the gitlab artifact provider as enabled

Usage

hal config artifact gitlab enable [parameters]

Parameters

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

hal config artifact gitrepo

Manage and view Spinnaker configuration for the gitrepo provider

Usage

hal config artifact gitrepo [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the gitrepo artifact provider’s account
disable: Set the gitrepo artifact provider as disabled
enable: Set the gitrepo artifact provider as enabled

hal config artifact gitrepo account

Manage and view Spinnaker configuration for the gitrepo artifact provider’s account

Usage

hal config artifact gitrepo account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the account to operate on.

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

Subcommands

add: Add an artifact account to the gitrepo artifact provider.
delete: Delete a specific gitrepo artifact account by name.
edit: Edit an artifact account in the gitrepo artifact provider.
get: Get the specified account details for the gitrepo provider.
list: List the artifact account names for the gitrepo artifact provider.

hal config artifact gitrepo account add

Add an artifact account to the gitrepo artifact provider.

Usage

hal config artifact gitrepo account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--password: (Sensitive data - user will be prompted on standard input) Git password
--ssh-known-hosts-file-path: File containing the known and trusted SSH hosts.
--ssh-private-key-file-path: Path to the ssh private key in PEM format
--ssh-private-key-passphrase: (Sensitive data - user will be prompted on standard input) Passphrase for encrypted private key
--ssh-trust-unknown-hosts: Setting this to true allows Spinnaker to authenticate with unknown hosts
--token: (Sensitive data - user will be prompted on standard input) Git token
--token-file: File containing a Git authentication token
--username: Git username
--username-password-file: File containing “username:password” to use for Git authentication

hal config artifact gitrepo account delete

Delete a specific gitrepo artifact account by name.

Usage

hal config artifact gitrepo account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config artifact gitrepo account edit

Edit an artifact account in the gitrepo artifact provider.

Usage

hal config artifact gitrepo account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--password: (Sensitive data - user will be prompted on standard input) Git password
--ssh-known-hosts-file-path: File containing the known and trusted SSH hosts
--ssh-private-key-file-path: Path to the ssh private key in PEM format
--ssh-private-key-passphrase: (Sensitive data - user will be prompted on standard input) Passphrase for encrypted private key
--ssh-trust-unknown-hosts: Setting this to true allows Spinnaker to authenticate with unknown hosts
--token: (Sensitive data - user will be prompted on standard input) Git token
--token-file: File containing a Git authentication token
--username: Git username
--username-password-file: File containing “username:password” to use for Git authentication

hal config artifact gitrepo account get

Get the specified account details for the gitrepo provider.

Usage

hal config artifact gitrepo account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config artifact gitrepo account list

List the artifact account names for the gitrepo artifact provider.

Usage

hal config artifact gitrepo account list [parameters]

Parameters

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

hal config artifact gitrepo disable

Set the gitrepo artifact provider as disabled

Usage

hal config artifact gitrepo disable [parameters]

Parameters

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

hal config artifact gitrepo enable

Set the gitrepo artifact provider as enabled

Usage

hal config artifact gitrepo enable [parameters]

Parameters

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

hal config artifact helm

Manage and view Spinnaker configuration for the helm provider

Usage

hal config artifact helm [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the helm artifact provider’s account
disable: Set the helm artifact provider as disabled
enable: Set the helm artifact provider as enabled

hal config artifact helm account

Manage and view Spinnaker configuration for the helm artifact provider’s account

Usage

hal config artifact helm account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the account to operate on.

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

Subcommands

add: Add an artifact account to the helm artifact provider.
delete: Delete a specific helm artifact account by name.
edit: Edit an artifact account in the helm artifact provider.
get: Get the specified account details for the helm provider.
list: List the artifact account names for the helm artifact provider.

hal config artifact helm account add

Add an artifact account to the helm artifact provider.

Usage

hal config artifact helm account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--password: (Sensitive data - user will be prompted on standard input) Helm chart repository basic auth password
--repository: Helm chart repository
--username: Helm chart repository basic auth username
--username-password-file: File containing “username:password” to use for helm chart repository basic auth

hal config artifact helm account delete

Delete a specific helm artifact account by name.

Usage

hal config artifact helm account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config artifact helm account edit

Edit an artifact account in the helm artifact provider.

Usage

hal config artifact helm account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--password: (Sensitive data - user will be prompted on standard input) Helm chart repository basic auth password
--repository: Helm chart repository
--username: Helm chart repository basic auth username
--username-password-file: File containing “username:password” to use for helm chart repository basic auth

hal config artifact helm account get

Get the specified account details for the helm provider.

Usage

hal config artifact helm account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config artifact helm account list

List the artifact account names for the helm artifact provider.

Usage

hal config artifact helm account list [parameters]

Parameters

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

hal config artifact helm disable

Set the helm artifact provider as disabled

Usage

hal config artifact helm disable [parameters]

Parameters

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

hal config artifact helm enable

Set the helm artifact provider as enabled

Usage

hal config artifact helm enable [parameters]

Parameters

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

hal config artifact http

Manage and view Spinnaker configuration for the http provider

Usage

hal config artifact http [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the http artifact provider’s account
disable: Set the http artifact provider as disabled
enable: Set the http artifact provider as enabled

hal config artifact http account

Manage and view Spinnaker configuration for the http artifact provider’s account

Usage

hal config artifact http account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the account to operate on.

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

Subcommands

add: Add an artifact account to the http artifact provider.
delete: Delete a specific http artifact account by name.
edit: Edit an artifact account in the http artifact provider.
get: Get the specified account details for the http provider.
list: List the artifact account names for the http artifact provider.

hal config artifact http account add

Add an artifact account to the http artifact provider.

Usage

hal config artifact http account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--password: (Sensitive data - user will be prompted on standard input) HTTP basic auth password
--username: HTTP basic auth username
--username-password-file: File containing “username:password” to use for HTTP basic auth

hal config artifact http account delete

Delete a specific http artifact account by name.

Usage

hal config artifact http account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config artifact http account edit

Edit an artifact account in the http artifact provider.

Usage

hal config artifact http account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--password: (Sensitive data - user will be prompted on standard input) Http password
--username: Http username
--username-password-file: File containing “username:password” to use for Http authentication

hal config artifact http account get

Get the specified account details for the http provider.

Usage

hal config artifact http account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config artifact http account list

List the artifact account names for the http artifact provider.

Usage

hal config artifact http account list [parameters]

Parameters

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

hal config artifact http disable

Set the http artifact provider as disabled

Usage

hal config artifact http disable [parameters]

Parameters

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

hal config artifact http enable

Set the http artifact provider as enabled

Usage

hal config artifact http enable [parameters]

Parameters

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

hal config artifact maven

Manage and view Spinnaker configuration for the maven provider

Usage

hal config artifact maven [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the maven artifact provider’s account
disable: Set the maven artifact provider as disabled
enable: Set the maven artifact provider as enabled

hal config artifact maven account

Manage and view Spinnaker configuration for the maven artifact provider’s account

Usage

hal config artifact maven account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the account to operate on.

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

Subcommands

add: Add an artifact account to the maven artifact provider.
delete: Delete a specific maven artifact account by name.
edit: Edit an artifact account in the maven artifact provider.
get: Get the specified account details for the maven provider.
list: List the artifact account names for the maven artifact provider.

hal config artifact maven account add

Add an artifact account to the maven artifact provider.

Usage

hal config artifact maven account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--repository-url: (Required) Full URI for the Maven repository ie. [http://some.host.com/repository/path](http://some.host.com/repository/path)

hal config artifact maven account delete

Delete a specific maven artifact account by name.

Usage

hal config artifact maven account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config artifact maven account edit

Edit an artifact account in the maven artifact provider.

Usage

hal config artifact maven account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--repository-url: Full URI for the Maven repository ie. [http://some.host.com/repository/path](http://some.host.com/repository/path)

hal config artifact maven account get

Get the specified account details for the maven provider.

Usage

hal config artifact maven account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config artifact maven account list

List the artifact account names for the maven artifact provider.

Usage

hal config artifact maven account list [parameters]

Parameters

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

hal config artifact maven disable

Set the maven artifact provider as disabled

Usage

hal config artifact maven disable [parameters]

Parameters

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

hal config artifact maven enable

Set the maven artifact provider as enabled

Usage

hal config artifact maven enable [parameters]

Parameters

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

hal config artifact oracle

Manage and view Spinnaker configuration for the oracle provider

Usage

hal config artifact oracle [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the oracle artifact provider’s account
disable: Set the oracle artifact provider as disabled
enable: Set the oracle artifact provider as enabled

hal config artifact oracle account

Manage and view Spinnaker configuration for the oracle artifact provider’s account

Usage

hal config artifact oracle account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the account to operate on.

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

Subcommands

add: Add an artifact account to the oracle artifact provider.
delete: Delete a specific oracle artifact account by name.
edit: Edit an artifact account in the oracle artifact provider.
get: Get the specified account details for the oracle provider.
list: List the artifact account names for the oracle artifact provider.

hal config artifact oracle account add

Add an artifact account to the oracle artifact provider.

Usage

hal config artifact oracle account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--fingerprint: Fingerprint of the public key
--namespace: The namespace the bucket and objects should be created in
--no-validate: (Default: false) Skip validation.
--private-key-passphrase: (Sensitive data - user will be prompted on standard input) Passphrase used for the private key, if it is encrypted
--region: An Oracle region (e.g., us-phoenix-1)
--ssh-private-key-file-path: Path to the private key in PEM format
--tenancy-id: Provide the OCID of the Oracle Tenancy to use.
--user-id: Provide the OCID of the Oracle User you’re authenticating as

hal config artifact oracle account delete

Delete a specific oracle artifact account by name.

Usage

hal config artifact oracle account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config artifact oracle account edit

Edit an artifact account in the oracle artifact provider.

Usage

hal config artifact oracle account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--fingerprint: Fingerprint of the public key
--namespace: The namespace the bucket and objects should be created in
--no-validate: (Default: false) Skip validation.
--private-key-passphrase: (Sensitive data - user will be prompted on standard input) Passphrase used for the private key, if it is encrypted
--region: An Oracle region (e.g., us-phoenix-1)
--ssh-private-key-file-path: Path to the private key in PEM format
--tenancy-id: Provide the OCID of the Oracle Tenancy to use.
--user-id: Provide the OCID of the Oracle User you’re authenticating as

hal config artifact oracle account get

Get the specified account details for the oracle provider.

Usage

hal config artifact oracle account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config artifact oracle account list

List the artifact account names for the oracle artifact provider.

Usage

hal config artifact oracle account list [parameters]

Parameters

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

hal config artifact oracle disable

Set the oracle artifact provider as disabled

Usage

hal config artifact oracle disable [parameters]

Parameters

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

hal config artifact oracle enable

Set the oracle artifact provider as enabled

Usage

hal config artifact oracle enable [parameters]

Parameters

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

hal config artifact s3

Manage and view Spinnaker configuration for the s3 provider

Usage

hal config artifact s3 [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the s3 artifact provider’s account
disable: Set the s3 artifact provider as disabled
enable: Set the s3 artifact provider as enabled

hal config artifact s3 account

Manage and view Spinnaker configuration for the s3 artifact provider’s account

Usage

hal config artifact s3 account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the account to operate on.

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

Subcommands

add: Add an artifact account to the s3 artifact provider.
delete: Delete a specific s3 artifact account by name.
edit: Edit an artifact account in the s3 artifact provider.
get: Get the specified account details for the s3 provider.
list: List the artifact account names for the s3 artifact provider.

hal config artifact s3 account add

Add an artifact account to the s3 artifact provider.

Usage

hal config artifact s3 account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--api-endpoint: S3 api endpoint; only required when using an S3 clone such as Minio
--api-region: S3 api region; only required when using an S3 clone such as Minio
--aws-access-key-id: Your AWS Access Key ID. If not provided, Halyard/Spinnaker will try to find AWS credentials as described at http://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html#credentials-default
--aws-secret-access-key: (Sensitive data - user will be prompted on standard input) Your AWS Secret Key.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--region: S3 region

hal config artifact s3 account delete

Delete a specific s3 artifact account by name.

Usage

hal config artifact s3 account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config artifact s3 account edit

Edit an artifact account in the s3 artifact provider.

Usage

hal config artifact s3 account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--api-endpoint: S3 api endpoint; only required when using an S3 clone such as Minio
--api-region: S3 api region; only required when using an S3 clone such as Minio
--aws-access-key-id: Your AWS Access Key ID. If not provided, Halyard/Spinnaker will try to find AWS credentials as described at http://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html#credentials-default
--aws-secret-access-key: (Sensitive data - user will be prompted on standard input) Your AWS Secret Key.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--region: S3 region

hal config artifact s3 account get

Get the specified account details for the s3 provider.

Usage

hal config artifact s3 account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config artifact s3 account list

List the artifact account names for the s3 artifact provider.

Usage

hal config artifact s3 account list [parameters]

Parameters

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

hal config artifact s3 disable

Set the s3 artifact provider as disabled

Usage

hal config artifact s3 disable [parameters]

Parameters

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

hal config artifact s3 enable

Set the s3 artifact provider as enabled

Usage

hal config artifact s3 enable [parameters]

Parameters

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

hal config artifact templates

Show Spinnaker’s configured artifact templates.

Usage

hal config artifact templates [parameters] [subcommands]

Parameters

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

Subcommands

add: Add an artifact template
delete: Delete an artifact template
edit: Edit an artifact template
list: List an artifact templates

hal config artifact templates add

Add an artifact template

Usage

hal config artifact templates add TEMPLATE [parameters]

Parameters

TEMPLATE: The name of the artifact template to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--template-path: (Required) The path to the Jinja template to use for artifact extraction

hal config artifact templates delete

Delete an artifact template

Usage

hal config artifact templates delete TEMPLATE [parameters]

Parameters

TEMPLATE: The name of the artifact template to operate on.

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

hal config artifact templates edit

Edit an artifact template

Usage

hal config artifact templates edit TEMPLATE [parameters]

Parameters

TEMPLATE: The name of the artifact template to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--template-path: The path to the Jinja template to use for artifact extraction

hal config artifact templates list

List an artifact templates

Usage

hal config artifact templates list [parameters]

Parameters

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

hal config canary

Configure your canary analysis settings for Spinnaker.

Usage

hal config canary [parameters] [subcommands]

Parameters

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

Subcommands

aws: Configure your canary analysis AWS service integration settings for Spinnaker.
datadog: Configure your canary analysis Datadog service integration settings for Spinnaker.
disable: Set Spinnaker’s canary analysis to disabled.
edit: Edit Spinnaker’s canary analysis settings.
enable: Set Spinnaker’s canary analysis to enabled.
google: Configure your canary analysis Google service integration settings for Spinnaker.
newrelic: Configure your canary analysis New Relic service integration settings for Spinnaker.
prometheus: Configure your canary analysis Prometheus service integration settings for Spinnaker.
signalfx: Configure your canary analysis SignalFx service integration settings for Spinnaker.

hal config canary aws

Configure your canary analysis AWS service integration settings for Spinnaker.

Usage

hal config canary aws [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the AWS service integration’s canary accounts.
disable: Set Spinnaker’s canary analysis AWS service integration to disabled.
edit: Edit Spinnaker’s canary analysis AWS service integration settings.
enable: Set Spinnaker’s canary analysis AWS service integration to enabled.

hal config canary aws account

Manage and view Spinnaker configuration for the AWS service integration’s canary accounts.

Usage

hal config canary aws account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the canary account to operate on.

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

Subcommands

add: Add a canary account to the AWS service integration.
delete: Delete a specific AWS canary account by name.
edit: Edit a canary account in the AWS service integration.
get: Get the specified canary account details for the AWS service integration.
list: List the canary account names for the AWS service integration.

hal config canary aws account add

Add a canary account to the AWS service integration.

Usage

hal config canary aws account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the canary account to operate on.

--access-key-id: The default access key used to communicate with AWS.
--bucket: The name of a storage bucket that your specified account has access to. If you specify a globally unique bucket name that doesn’t exist yet, Kayenta will create that bucket for you.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--endpoint: The endpoint used to reach the service implementing the AWS api. Typical use is with Minio.
--no-validate: (Default: false) Skip validation.
--profile-name: The profile name to use when resolving AWS credentials. Typically found in ~/.aws/credentials (Default: default).
--region: The region to use.
--root-folder: The root folder in the chosen bucket to place all of the canary service’s persistent data in (Default: kayenta).
--secret-access-key: (Sensitive data - user will be prompted on standard input) The secret key used to communicate with AWS.

hal config canary aws account delete

Delete a specific AWS canary account by name.

Usage

hal config canary aws account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the canary account to operate on.

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

hal config canary aws account edit

Edit a canary account in the AWS service integration.

Usage

hal config canary aws account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the canary account to operate on.

--access-key-id: The default access key used to communicate with AWS.
--bucket: The name of a storage bucket that your specified account has access to. If you specify a globally unique bucket name that doesn’t exist yet, Kayenta will create that bucket for you.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--endpoint: The endpoint used to reach the service implementing the AWS api. Typical use is with Minio.
--no-validate: (Default: false) Skip validation.
--profile-name: The profile name to use when resolving AWS credentials. Typically found in ~/.aws/credentials (Default: default).
--region: The region to use.
--root-folder: The root folder in the chosen bucket to place all of the canary service’s persistent data in (Default: kayenta).
--secret-access-key: (Sensitive data - user will be prompted on standard input) The secret key used to communicate with AWS.

hal config canary aws account get

Get the specified canary account details for the AWS service integration.

Usage

hal config canary aws account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the canary account to operate on.

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

hal config canary aws account list

List the canary account names for the AWS service integration.

Usage

hal config canary aws account list [parameters]

Parameters

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

hal config canary aws disable

Set Spinnaker’s canary analysis AWS service integration to disabled.

Usage

hal config canary aws disable [parameters]

Parameters

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

hal config canary aws edit

Edit Spinnaker’s canary analysis AWS service integration settings.

Usage

hal config canary aws edit [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--s3-enabled: Whether or not to enable S3 as a persistent store (Default: false).

hal config canary aws enable

Set Spinnaker’s canary analysis AWS service integration to enabled.

Usage

hal config canary aws enable [parameters]

Parameters

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

hal config canary datadog

Configure your canary analysis Datadog service integration settings for Spinnaker.

Usage

hal config canary datadog [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the Datadog service integration’s canary accounts.
disable: Set Spinnaker’s canary analysis Datadog service integration to disabled.
enable: Set Spinnaker’s canary analysis Datadog service integration to enabled.

hal config canary datadog account

Manage and view Spinnaker configuration for the Datadog service integration’s canary accounts.

Usage

hal config canary datadog account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the canary account to operate on.

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

Subcommands

add: Add a canary account to the Datadog service integration.
delete: Delete a specific Datadog canary account by name.
edit: Edit a canary account in the Datadog service integration.
get: Get the specified canary account details for the Datadog service integration.
list: List the canary account names for the Datadog service integration.

hal config canary datadog account add

Add a canary account to the Datadog service integration.

Usage

hal config canary datadog account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the canary account to operate on.

--api-key: (Required) (Sensitive data - user will be prompted on standard input) Your org’s unique Datadog API key. See https://app.datadoghq.com/account/settings#api .
--application-key: (Required) (Sensitive data - user will be prompted on standard input) Your Datadog application key. See https://app.datadoghq.com/account/settings#api .
--base-url: (Required) The base URL to the Datadog server.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.

hal config canary datadog account delete

Delete a specific Datadog canary account by name.

Usage

hal config canary datadog account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the canary account to operate on.

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

hal config canary datadog account edit

Edit a canary account in the Datadog service integration.

Usage

hal config canary datadog account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the canary account to operate on.

--api-key: (Sensitive data - user will be prompted on standard input) Your org’s unique Datadog API key. See https://app.datadoghq.com/account/settings#api .
--application-key: (Sensitive data - user will be prompted on standard input) Your Datadog application key. See https://app.datadoghq.com/account/settings#api .
--base-url: The base URL to the Datadog server.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.

hal config canary datadog account get

Get the specified canary account details for the Datadog service integration.

Usage

hal config canary datadog account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the canary account to operate on.

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

hal config canary datadog account list

List the canary account names for the Datadog service integration.

Usage

hal config canary datadog account list [parameters]

Parameters

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

hal config canary datadog disable

Set Spinnaker’s canary analysis Datadog service integration to disabled.

Usage

hal config canary datadog disable [parameters]

Parameters

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

hal config canary datadog enable

Set Spinnaker’s canary analysis Datadog service integration to enabled.

Usage

hal config canary datadog enable [parameters]

Parameters

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

hal config canary disable

Set Spinnaker’s canary analysis to disabled.

Usage

hal config canary disable [parameters]

Parameters

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

hal config canary edit

Edit Spinnaker’s canary analysis settings.

Usage

hal config canary edit [parameters]

Parameters

--atlasWebComponentsUrl: Location of web components to use for Atlas metric configuration.
--default-judge: Name of canary judge to use by default (Default: NetflixACAJudge-v1.0).
--default-metrics-account: Name of metrics account to use by default.
--default-metrics-store: Name of metrics store to use by default (e.g. atlas, datadog, prometheus, stackdriver).
--default-storage-account: Name of storage account to use by default.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--redux-logger-enabled: Whether or not to enable redux logging in the canary module in deck (Default: true).
--show-all-configs-enabled: Whether or not to show all canary configs in deck, or just those scoped to the current application (Default: true).
--stages-enabled: Whether or not to enable canary stages in deck (Default: true).
--templates-enabled: Whether or not to enable custom filter templates for canary configs in deck (Default: true).

hal config canary enable

Set Spinnaker’s canary analysis to enabled.

Usage

hal config canary enable [parameters]

Parameters

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

hal config canary google

Configure your canary analysis Google service integration settings for Spinnaker.

Usage

hal config canary google [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the Google service integration’s canary accounts.
disable: Set Spinnaker’s canary analysis Google service integration to disabled.
edit: Edit Spinnaker’s canary analysis Google service integration settings.
enable: Set Spinnaker’s canary analysis Google service integration to enabled.

hal config canary google account

Manage and view Spinnaker configuration for the Google service integration’s canary accounts.

Usage

hal config canary google account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the canary account to operate on.

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

Subcommands

add: Add a canary account to the Google service integration.
delete: Delete a specific Google canary account by name.
edit: Edit a canary account in the Google service integration.
get: Get the specified canary account details for the Google service integration.
list: List the canary account names for the Google service integration.

hal config canary google account add

Add a canary account to the Google service integration.

Usage

hal config canary google account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the canary account to operate on.

--bucket: The name of a storage bucket that your specified account has access to. If you specify a globally unique bucket name that doesn’t exist yet, Kayenta will create that bucket for you.
--bucket-location: This is only required if the bucket you specify doesn’t exist yet. In that case, the bucket will be created in that location. See https://cloud.google.com/storage/docs/managing-buckets#manage-class-location .
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--json-path: The path to a JSON service account that Spinnaker will use as credentials. This is only needed if Spinnaker is not deployed on a Google Compute Engine VM, or needs permissions not afforded to the VM it is running on. See https://cloud.google.com/compute/docs/access/service-accounts for more information.
--no-validate: (Default: false) Skip validation.
--project: (Required) The Google Cloud Platform project the canary service will use to consume GCS and Stackdriver.
--root-folder: The root folder in the chosen bucket to place all of the canary service’s persistent data in (Default: kayenta).

hal config canary google account delete

Delete a specific Google canary account by name.

Usage

hal config canary google account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the canary account to operate on.

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

hal config canary google account edit

Edit a canary account in the Google service integration.

Usage

hal config canary google account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the canary account to operate on.

--bucket: The name of a storage bucket that your specified account has access to. If you specify a globally unique bucket name that doesn’t exist yet, Kayenta will create that bucket for you.
--bucket-location: This is only required if the bucket you specify doesn’t exist yet. In that case, the bucket will be created in that location. See https://cloud.google.com/storage/docs/managing-buckets#manage-class-location .
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--json-path: The path to a JSON service account that Spinnaker will use as credentials. This is only needed if Spinnaker is not deployed on a Google Compute Engine VM, or needs permissions not afforded to the VM it is running on. See https://cloud.google.com/compute/docs/access/service-accounts for more information.
--no-validate: (Default: false) Skip validation.
--project: The Google Cloud Platform project the canary service will use to consume GCS and Stackdriver.
--root-folder: The root folder in the chosen bucket to place all of the canary service’s persistent data in (Default: kayenta).

hal config canary google account get

Get the specified canary account details for the Google service integration.

Usage

hal config canary google account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the canary account to operate on.

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

hal config canary google account list

List the canary account names for the Google service integration.

Usage

hal config canary google account list [parameters]

Parameters

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

hal config canary google disable

Set Spinnaker’s canary analysis Google service integration to disabled.

Usage

hal config canary google disable [parameters]

Parameters

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

hal config canary google edit

Edit Spinnaker’s canary analysis Google service integration settings.

Usage

hal config canary google edit [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--gcs-enabled: Whether or not to enable GCS as a persistent store (Default: false).
--metadata-caching-interval-ms: Number of milliseconds to wait in between caching the names of available metric types (for use in building canary configs; Default: 60000).
--no-validate: (Default: false) Skip validation.
--stackdriver-enabled: Whether or not to enable Stackdriver as a metrics service (Default: false).

hal config canary google enable

Set Spinnaker’s canary analysis Google service integration to enabled.

Usage

hal config canary google enable [parameters]

Parameters

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

hal config canary newrelic

Configure your canary analysis New Relic service integration settings for Spinnaker.

Usage

hal config canary newrelic [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the newrelic service integration’s canary accounts.
disable: Set Spinnaker’s canary analysis newrelic service integration to disabled.
enable: Set Spinnaker’s canary analysis newrelic service integration to enabled.

hal config canary newrelic account

Manage and view Spinnaker configuration for the newrelic service integration’s canary accounts.

Usage

hal config canary newrelic account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the canary account to operate on.

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

Subcommands

add: Add a canary account to the NewRelic service integration.
delete: Delete a specific newrelic canary account by name.
edit: Edit a canary account in the newrelic service integration.
get: Get the specified canary account details for the newrelic service integration.
list: List the canary account names for the newrelic service integration.

hal config canary newrelic account add

Add a canary account to the NewRelic service integration.

Usage

hal config canary newrelic account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the canary account to operate on.

--api-key: (Required) (Sensitive data - user will be prompted on standard input) Your account’s unique New Relic Insights API key. See https://docs.newrelic.com/docs/insights/insights-api/get-data/query-insights-event-data-api .
--application-key: (Required) Your New Relic account id. See https://docs.newrelic.com/docs/accounts/install-new-relic/account-setup/account-id .
--base-url: (Required) The base URL to the New Relic Insights server.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.

hal config canary newrelic account delete

Delete a specific newrelic canary account by name.

Usage

hal config canary newrelic account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the canary account to operate on.

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

hal config canary newrelic account edit

Edit a canary account in the newrelic service integration.

Usage

hal config canary newrelic account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the canary account to operate on.

--api-key: (Sensitive data - user will be prompted on standard input) Your account’s unique New Relic Insights API key. See https://docs.newrelic.com/docs/insights/insights-api/get-data/query-insights-event-data-api .
--application-key: Your New Relic account id. See https://docs.newrelic.com/docs/accounts/install-new-relic/account-setup/account-id .
--base-url: The base URL to the New Relic Insights server.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.

hal config canary newrelic account get

Get the specified canary account details for the newrelic service integration.

Usage

hal config canary newrelic account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the canary account to operate on.

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

hal config canary newrelic account list

List the canary account names for the newrelic service integration.

Usage

hal config canary newrelic account list [parameters]

Parameters

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

hal config canary newrelic disable

Set Spinnaker’s canary analysis newrelic service integration to disabled.

Usage

hal config canary newrelic disable [parameters]

Parameters

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

hal config canary newrelic enable

Set Spinnaker’s canary analysis newrelic service integration to enabled.

Usage

hal config canary newrelic enable [parameters]

Parameters

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

hal config canary prometheus

Configure your canary analysis Prometheus service integration settings for Spinnaker.

Usage

hal config canary prometheus [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the Prometheus service integration’s canary accounts.
disable: Set Spinnaker’s canary analysis Prometheus service integration to disabled.
edit: Edit Spinnaker’s canary analysis Prometheus service integration settings.
enable: Set Spinnaker’s canary analysis Prometheus service integration to enabled.

hal config canary prometheus account

Manage and view Spinnaker configuration for the Prometheus service integration’s canary accounts.

Usage

hal config canary prometheus account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the canary account to operate on.

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

Subcommands

add: Add a canary account to the Prometheus service integration.
delete: Delete a specific Prometheus canary account by name.
edit: Edit a canary account in the Prometheus service integration.
get: Get the specified canary account details for the Prometheus service integration.
list: List the canary account names for the Prometheus service integration.

hal config canary prometheus account add

Add a canary account to the Prometheus service integration.

Usage

hal config canary prometheus account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the canary account to operate on.

--base-url: (Required) The base URL to the Prometheus server.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--password: (Sensitive data - user will be prompted on standard input) A basic auth password.
--username: A basic auth username.
--username-password-file: The path to a file containing “username:password”.

hal config canary prometheus account delete

Delete a specific Prometheus canary account by name.

Usage

hal config canary prometheus account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the canary account to operate on.

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

hal config canary prometheus account edit

Edit a canary account in the Prometheus service integration.

Usage

hal config canary prometheus account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the canary account to operate on.

--base-url: The base URL to the Prometheus server.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--password: (Sensitive data - user will be prompted on standard input) A basic auth password.
--username: A basic auth username.
--username-password-file: The path to a file containing “username:password”.

hal config canary prometheus account get

Get the specified canary account details for the Prometheus service integration.

Usage

hal config canary prometheus account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the canary account to operate on.

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

hal config canary prometheus account list

List the canary account names for the Prometheus service integration.

Usage

hal config canary prometheus account list [parameters]

Parameters

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

hal config canary prometheus disable

Set Spinnaker’s canary analysis Prometheus service integration to disabled.

Usage

hal config canary prometheus disable [parameters]

Parameters

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

hal config canary prometheus edit

Edit Spinnaker’s canary analysis Prometheus service integration settings.

Usage

hal config canary prometheus edit [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--metadata-caching-interval-ms: Number of milliseconds to wait in between caching the names of available metric types (for use in building canary configs; Default: 60000).
--no-validate: (Default: false) Skip validation.

hal config canary prometheus enable

Set Spinnaker’s canary analysis Prometheus service integration to enabled.

Usage

hal config canary prometheus enable [parameters]

Parameters

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

hal config canary signalfx

Configure your canary analysis SignalFx service integration settings for Spinnaker.

Usage

hal config canary signalfx [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the Signalfx service integration’s canary accounts.
disable: Set Spinnaker’s canary analysis Signalfx service integration to disabled.
enable: Set Spinnaker’s canary analysis Signalfx service integration to enabled.

hal config canary signalfx account

Manage and view Spinnaker configuration for the Signalfx service integration’s canary accounts.

Usage

hal config canary signalfx account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the canary account to operate on.

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

Subcommands

add: Add a canary account to the Signalfx service integration.
delete: Delete a specific Signalfx canary account by name.
edit: Edit a canary account in the Signalfx service integration.
get: Get the specified canary account details for the Signalfx service integration.
list: List the canary account names for the Signalfx service integration.

hal config canary signalfx account add

Add a canary account to the Signalfx service integration.

Usage

hal config canary signalfx account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the canary account to operate on.

--access-token: (Required) (Sensitive data - user will be prompted on standard input) The SignalFx access token.
--base-url: The base URL to the SignalFx server. Defaults to https://stream.signalfx.com
--default-location-key: Location key is used to filter by deployment region. If omitted requests must supply the _location_key if it is needed.
--default-scope-key: Scope key is used to distinguish between base and canary deployments. If omitted every request must supply the _scope_key param in extended scope params
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.

hal config canary signalfx account delete

Delete a specific Signalfx canary account by name.

Usage

hal config canary signalfx account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the canary account to operate on.

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

hal config canary signalfx account edit

Edit a canary account in the Signalfx service integration.

Usage

hal config canary signalfx account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the canary account to operate on.

--access-token: (Sensitive data - user will be prompted on standard input) The SignalFx access token.
--base-url: The base URL to the SignalFx server. Defaults to https://stream.signalfx.com
--default-location-key: Location key is used to filter by deployment region. If omitted requests must supply the _location_key if it is needed.
--default-scope-key: Scope key is used to distinguish between base and canary deployments. If omitted every request must supply the _scope_key param in extended scope params
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.

hal config canary signalfx account get

Get the specified canary account details for the Signalfx service integration.

Usage

hal config canary signalfx account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the canary account to operate on.

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

hal config canary signalfx account list

List the canary account names for the Signalfx service integration.

Usage

hal config canary signalfx account list [parameters]

Parameters

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

hal config canary signalfx disable

Set Spinnaker’s canary analysis Signalfx service integration to disabled.

Usage

hal config canary signalfx disable [parameters]

Parameters

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

hal config canary signalfx enable

Set Spinnaker’s canary analysis Signalfx service integration to enabled.

Usage

hal config canary signalfx enable [parameters]

Parameters

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

hal config ci

Configure, validate, and view the specified Continuous Integration service.

Usage

hal config ci [subcommands]

Subcommands

codebuild: Manage and view Spinnaker configuration for AWS CodeBuild
concourse: Manage and view Spinnaker configuration for the concourse ci
gcb: Manage and view Spinnaker configuration for Google Cloud Build
jenkins: Manage and view Spinnaker configuration for the jenkins ci
travis: Manage and view Spinnaker configuration for the travis ci
wercker: Manage and view Spinnaker configuration for the wercker ci

hal config ci codebuild

Manage and view Spinnaker configuration for AWS CodeBuild

Usage

hal config ci codebuild [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for AWS CodeBuild service account.
disable: Set the codebuild ci as disabled
edit: Set CI provider-wide properties for AWS CodeBuild
enable: Set the codebuild ci as enabled

hal config ci codebuild account

Manage and view Spinnaker configuration for AWS CodeBuild service account.

Usage

hal config ci codebuild account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the account to operate on.

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

Subcommands

add: Add a AWS CodeBuild account.
delete: Delete a AWS CodeBuild account.
edit: Edit a AWS CodeBuild account.
get: Get the account details for AWS CodeBuild.
list: List the AWS CodeBuild accounts.

hal config ci codebuild account add

Add a AWS CodeBuild account.

Usage

hal config ci codebuild account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--account-id: The AWS account ID that will be used to trigger CodeBuild build.
--assume-role: If set, Halyard will configure a credentials provider that uses AWS Security Token Service to assume the specified role.

Example: “user/spinnaker” or “role/spinnakerManaged”

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--region: (Required) The AWS region in which your CodeBuild projects live.

hal config ci codebuild account delete

Delete a AWS CodeBuild account.

Usage

hal config ci codebuild account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config ci codebuild account edit

Edit a AWS CodeBuild account.

Usage

hal config ci codebuild account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--account-id: The AWS account ID that will be used to trigger CodeBuild build.
--assume-role: If set, Halyard will configure a credentials provider that uses AWS Security Token Service to assume the specified role.

Example: “user/spinnaker” or “role/spinnakerManaged”

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--region: The AWS region in which your CodeBuild projects live.

hal config ci codebuild account get

Get the account details for AWS CodeBuild.

Usage

hal config ci codebuild account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config ci codebuild account list

List the AWS CodeBuild accounts.

Usage

hal config ci codebuild account list [parameters]

Parameters

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

hal config ci codebuild disable

Set the codebuild ci as disabled

Usage

hal config ci codebuild disable [parameters]

Parameters

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

hal config ci codebuild edit

Set CI provider-wide properties for AWS CodeBuild

Usage

hal config ci codebuild edit [parameters]

Parameters

--access-key-id: Your AWS Access Key ID. If not provided, Halyard/Spinnaker will try to find AWS credentials as described at http://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html#credentials-default
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--secret-access-key: (Sensitive data - user will be prompted on standard input) Your AWS Secret Key.

hal config ci codebuild enable

Set the codebuild ci as enabled

Usage

hal config ci codebuild enable [parameters]

Parameters

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

hal config ci concourse

Manage and view Spinnaker configuration for the concourse ci

Usage

hal config ci concourse [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 the concourse ci as disabled
enable: Set the concourse ci as enabled
master: Manage and view Spinnaker configuration for the concourse Continuous Integration services’s master

hal config ci concourse disable

Set the concourse ci as disabled

Usage

hal config ci concourse disable [parameters]

Parameters

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

hal config ci concourse enable

Set the concourse ci as enabled

Usage

hal config ci concourse enable [parameters]

Parameters

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

hal config ci concourse master

Manage and view Spinnaker configuration for the concourse Continuous Integration services’s master

Usage

hal config ci concourse master MASTER [parameters] [subcommands]

Parameters

MASTER: The name of the master to operate on.

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

Subcommands

add: Add a master for the concourse Continuous Integration service.
delete: Delete a specific concourse master by name.
edit: Edit a master for the concourse Continuous Integration service.
get: Get the specified master details for concourse.
list: List the master names for concourse.

hal config ci concourse master add

Add a master for the concourse Continuous Integration service.

Usage

hal config ci concourse master add MASTER [parameters]

Parameters

MASTER: The name of the master to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--password: (Required) (Sensitive data - user will be prompted on standard input) The password of the concourse user to authenticate as.
--read-permissions: (Default: []) A user must have at least one of these roles in order to view this build master or use it as a trigger source.
--url: (Required) The url your concourse search is reachable at.
--username: (Required) The username of the concourse user to authenticate as.
--write-permissions: (Default: []) A user must have at least one of these roles in order to be able to run jobs on this build master.

hal config ci concourse master delete

Delete a specific concourse master by name.

Usage

hal config ci concourse master delete MASTER [parameters]

Parameters

MASTER: The name of the master to operate on.

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

hal config ci concourse master edit

Edit a master for the concourse Continuous Integration service.

Usage

hal config ci concourse master edit MASTER [parameters]

Parameters

MASTER: The name of the master to operate on.

--add-read-permission: Add this permission to the list of read permissions.
--add-write-permission: Add this permission to the list of write permissions.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--password: (Sensitive data - user will be prompted on standard input) The password of the concourse user to authenticate as.
--read-permissions: A user must have at least one of these roles in order to view this build master or use it as a trigger source.
--remove-read-permission: Remove this permission from the list of read permissions.
--remove-write-permission: Remove this permission from the list of write permissions.
--url: The url your concourse search is reachable at.
--username: The username of the concourse user to authenticate as.
--write-permissions: A user must have at least one of these roles in order to be able to run jobs on this build master.

hal config ci concourse master get

Get the specified master details for concourse.

Usage

hal config ci concourse master get MASTER [parameters]

Parameters

MASTER: The name of the master to operate on.

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

hal config ci concourse master list

List the master names for concourse.

Usage

hal config ci concourse master list [parameters]

Parameters

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

hal config ci gcb

Manage and view Spinnaker configuration for Google Cloud Build

Usage

hal config ci gcb [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the Google Cloud Build service account.
disable: Set the gcb ci as disabled
enable: Set the gcb ci as enabled

hal config ci gcb account

Manage and view Spinnaker configuration for the Google Cloud Build service account.

Usage

hal config ci gcb account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the account to operate on.

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

Subcommands

add: Add a Google Cloud Build account.
delete: Delete a Google Cloud Build account.
edit: Edit a Google Cloud Build account.
list: List the Google Cloud Build accounts.

hal config ci gcb account add

Add a Google Cloud Build account.

Usage

hal config ci gcb account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--json-key: The path to a JSON service account that Spinnaker will use as credentials.
--no-validate: (Default: false) Skip validation.
--project: (Required) The name of the GCP project in which to trigger and monitor builds.
--subscription-name: The name of the PubSub subscription on which to listen for build changes.

hal config ci gcb account delete

Delete a Google Cloud Build account.

Usage

hal config ci gcb account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config ci gcb account edit

Edit a Google Cloud Build account.

Usage

hal config ci gcb account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--json-key: The path to a JSON service account that Spinnaker will use as credentials.
--no-validate: (Default: false) Skip validation.
--project: The name of the GCP project in which to trigger and monitor builds.
--subscription-name: The name of the PubSub subscription on which to listen for build changes.

hal config ci gcb account list

List the Google Cloud Build accounts.

Usage

hal config ci gcb account list [parameters]

Parameters

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

hal config ci gcb disable

Set the gcb ci as disabled

Usage

hal config ci gcb disable [parameters]

Parameters

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

hal config ci gcb enable

Set the gcb ci as enabled

Usage

hal config ci gcb enable [parameters]

Parameters

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

hal config ci jenkins

Manage and view Spinnaker configuration for the jenkins ci

Usage

hal config ci jenkins [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 the jenkins ci as disabled
enable: Set the jenkins ci as enabled
master: Manage and view Spinnaker configuration for the jenkins Continuous Integration services’s master

hal config ci jenkins disable

Set the jenkins ci as disabled

Usage

hal config ci jenkins disable [parameters]

Parameters

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

hal config ci jenkins enable

Set the jenkins ci as enabled

Usage

hal config ci jenkins enable [parameters]

Parameters

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

hal config ci jenkins master

Manage and view Spinnaker configuration for the jenkins Continuous Integration services’s master

Usage

hal config ci jenkins master MASTER [parameters] [subcommands]

Parameters

MASTER: The name of the master to operate on.

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

Subcommands

add: Add a master for the jenkins Continuous Integration service.
delete: Delete a specific jenkins master by name.
edit: Edit a master for the jenkins Continuous Integration service.
get: Get the specified master details for jenkins.
list: List the master names for jenkins.

hal config ci jenkins master add

Add a master for the jenkins Continuous Integration service.

Usage

hal config ci jenkins master add MASTER [parameters]

Parameters

MASTER: The name of the master to operate on.

--address: (Required) The address your jenkins master is reachable at.
--csrf: Whether or not to negotiate CSRF tokens when calling Jenkins.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--password: (Sensitive data - user will be prompted on standard input) The password of the jenkins user to authenticate as.
--read-permissions: (Default: []) A user must have at least one of these roles in order to view this build master or use it as a trigger source.
--username: The username of the jenkins user to authenticate as.
--write-permissions: (Default: []) A user must have at least one of these roles in order to be able to run jobs on this build master.

hal config ci jenkins master delete

Delete a specific jenkins master by name.

Usage

hal config ci jenkins master delete MASTER [parameters]

Parameters

MASTER: The name of the master to operate on.

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

hal config ci jenkins master edit

Edit a master for the jenkins Continuous Integration service.

Usage

hal config ci jenkins master edit MASTER [parameters]

Parameters

MASTER: The name of the master to operate on.

--add-read-permission: Add this permission to the list of read permissions.
--add-write-permission: Add this permission to the list of write permissions.
--address: The address your jenkins master is reachable at.
--csrf: Whether or not to negotiate CSRF tokens when calling Jenkins.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--password: (Sensitive data - user will be prompted on standard input) The password of the jenkins user to authenticate as.
--read-permissions: A user must have at least one of these roles in order to view this build master or use it as a trigger source.
--remove-read-permission: Remove this permission from the list of read permissions.
--remove-write-permission: Remove this permission from the list of write permissions.
--username: The username of the jenkins user to authenticate as.
--write-permissions: A user must have at least one of these roles in order to be able to run jobs on this build master.

hal config ci jenkins master get

Get the specified master details for jenkins.

Usage

hal config ci jenkins master get MASTER [parameters]

Parameters

MASTER: The name of the master to operate on.

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

hal config ci jenkins master list

List the master names for jenkins.

Usage

hal config ci jenkins master list [parameters]

Parameters

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

hal config ci travis

Manage and view Spinnaker configuration for the travis ci

Usage

hal config ci travis [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 the travis ci as disabled
enable: Set the travis ci as enabled
master: Manage and view Spinnaker configuration for the travis Continuous Integration services’s master

hal config ci travis disable

Set the travis ci as disabled

Usage

hal config ci travis disable [parameters]

Parameters

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

hal config ci travis enable

Set the travis ci as enabled

Usage

hal config ci travis enable [parameters]

Parameters

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

hal config ci travis master

Manage and view Spinnaker configuration for the travis Continuous Integration services’s master

Usage

hal config ci travis master MASTER [parameters] [subcommands]

Parameters

MASTER: The name of the master to operate on.

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

Subcommands

add: Add a master for the travis Continuous Integration service.
delete: Delete a specific travis master by name.
edit: Edit a master for the travis Continuous Integration service.
get: Get the specified master details for travis.
list: List the master names for travis.

hal config ci travis master add

Add a master for the travis Continuous Integration service.

Usage

hal config ci travis master add MASTER [parameters]

Parameters

MASTER: The name of the master to operate on.

--address: (Required) The address of the travis API ( https://api.travis-ci.org ).
--base-url: (Required) The base URL to the travis UI ( https://travis-ci.org ).
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--github-token: (Sensitive data - user will be prompted on standard input) The github token to authentiacte against travis with.
--no-validate: (Default: false) Skip validation.
--number-of-repositories: How many repositories the travis integration should fetch from the api each time the poller runs. Should be set a bit higher than the expected maximum number of repositories built within the poll interval.
--read-permissions: (Default: []) A user must have at least one of these roles in order to view this build master or use it as a trigger source.
--write-permissions: (Default: []) A user must have at least one of these roles in order to be able to run jobs on this build master.

hal config ci travis master delete

Delete a specific travis master by name.

Usage

hal config ci travis master delete MASTER [parameters]

Parameters

MASTER: The name of the master to operate on.

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

hal config ci travis master edit

Edit a master for the travis Continuous Integration service.

Usage

hal config ci travis master edit MASTER [parameters]

Parameters

MASTER: The name of the master to operate on.

--add-read-permission: Add this permission to the list of read permissions.
--add-write-permission: Add this permission to the list of write permissions.
--address: The address of the travis API ( https://api.travis-ci.org ).
--base-url: The base URL to the travis UI ( https://travis-ci.org ).
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--github-token: (Sensitive data - user will be prompted on standard input) The github token to authentiacte against travis with.
--no-validate: (Default: false) Skip validation.
--number-of-repositories: How many repositories the travis integration should fetch from the api each time the poller runs. Should be set a bit higher than the expected maximum number of repositories built within the poll interval.
--read-permissions: A user must have at least one of these roles in order to view this build master or use it as a trigger source.
--remove-read-permission: Remove this permission from the list of read permissions.
--remove-write-permission: Remove this permission from the list of write permissions.
--write-permissions: A user must have at least one of these roles in order to be able to run jobs on this build master.

hal config ci travis master get

Get the specified master details for travis.

Usage

hal config ci travis master get MASTER [parameters]

Parameters

MASTER: The name of the master to operate on.

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

hal config ci travis master list

List the master names for travis.

Usage

hal config ci travis master list [parameters]

Parameters

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

hal config ci wercker

Manage and view Spinnaker configuration for the wercker ci

Usage

hal config ci wercker [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 the wercker ci as disabled
enable: Set the wercker ci as enabled
master: Manage and view Spinnaker configuration for the wercker Continuous Integration services’s master

hal config ci wercker disable

Set the wercker ci as disabled

Usage

hal config ci wercker disable [parameters]

Parameters

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

hal config ci wercker enable

Set the wercker ci as enabled

Usage

hal config ci wercker enable [parameters]

Parameters

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

hal config ci wercker master

Manage and view Spinnaker configuration for the wercker Continuous Integration services’s master

Usage

hal config ci wercker master MASTER [parameters] [subcommands]

Parameters

MASTER: The name of the master to operate on.

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

Subcommands

add: Add a master for the wercker Continuous Integration service.
delete: Delete a specific wercker master by name.
edit: Edit a master for the wercker Continuous Integration service.
get: Get the specified master details for wercker.
list: List the master names for wercker.

hal config ci wercker master add

Add a master for the wercker Continuous Integration service.

Usage

hal config ci wercker master add MASTER [parameters]

Parameters

MASTER: The name of the master to operate on.

--address: (Required) The address your Wercker master is reachable at.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--read-permissions: (Default: []) A user must have at least one of these roles in order to view this build master or use it as a trigger source.
--token: (Sensitive data - user will be prompted on standard input) The personal token of the Wercker user to authenticate as.
--user: The username of the Wercker user to authenticate as.
--write-permissions: (Default: []) A user must have at least one of these roles in order to be able to run jobs on this build master.

hal config ci wercker master delete

Delete a specific wercker master by name.

Usage

hal config ci wercker master delete MASTER [parameters]

Parameters

MASTER: The name of the master to operate on.

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

hal config ci wercker master edit

Edit a master for the wercker Continuous Integration service.

Usage

hal config ci wercker master edit MASTER [parameters]

Parameters

MASTER: The name of the master to operate on.

--add-read-permission: Add this permission to the list of read permissions.
--add-write-permission: Add this permission to the list of write permissions.
--address: The address your Wercker master is reachable at.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--read-permissions: A user must have at least one of these roles in order to view this build master or use it as a trigger source.
--remove-read-permission: Remove this permission from the list of read permissions.
--remove-write-permission: Remove this permission from the list of write permissions.
--token: (Sensitive data - user will be prompted on standard input) The personal token of the Wercker user to authenticate as.
--user: The username of the Wercker user to authenticate as.
--write-permissions: A user must have at least one of these roles in order to be able to run jobs on this build master.

hal config ci wercker master get

Get the specified master details for wercker.

Usage

hal config ci wercker master get MASTER [parameters]

Parameters

MASTER: The name of the master to operate on.

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

hal config ci wercker master list

List the master names for wercker.

Usage

hal config ci wercker master list [parameters]

Parameters

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

hal config deploy

Display the configured Spinnaker deployment.

Usage

hal config deploy [parameters] [subcommands]

Parameters

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

Subcommands

component-sizing: Configure, validate, and view the component sizings for the Spinnaker services.
edit: Edit Spinnaker’s deployment footprint and configuration.
ha: Configure, validate, and view the specified high availability Spinnaker service configuration.

hal config deploy component-sizing

Configure, validate, and view the component sizings for the Spinnaker services.

Usage

hal config deploy component-sizing [subcommands]

Subcommands

clouddriver: Manage and view Spinnaker component sizing configuration for clouddriver
clouddriver-bootstrap: Manage and view Spinnaker component sizing configuration for clouddriver-bootstrap
clouddriver-caching: Manage and view Spinnaker component sizing configuration for clouddriver-caching
clouddriver-ro: Manage and view Spinnaker component sizing configuration for clouddriver-ro
clouddriver-ro-deck: Manage and view Spinnaker component sizing configuration for clouddriver-ro-deck
clouddriver-rw: Manage and view Spinnaker component sizing configuration for clouddriver-rw
consul-client: Manage and view Spinnaker component sizing configuration for consul-client
consul-server: Manage and view Spinnaker component sizing configuration for consul-server
deck: Manage and view Spinnaker component sizing configuration for deck
echo: Manage and view Spinnaker component sizing configuration for echo
echo-scheduler: Manage and view Spinnaker component sizing configuration for echo-scheduler
echo-worker: Manage and view Spinnaker component sizing configuration for echo-worker
fiat: Manage and view Spinnaker component sizing configuration for fiat
front50: Manage and view Spinnaker component sizing configuration for front50
gate: Manage and view Spinnaker component sizing configuration for gate
igor: Manage and view Spinnaker component sizing configuration for igor
kayenta: Manage and view Spinnaker component sizing configuration for kayenta
monitoring-daemon: Manage and view Spinnaker component sizing configuration for monitoring-daemon
orca: Manage and view Spinnaker component sizing configuration for orca
orca-bootstrap: Manage and view Spinnaker component sizing configuration for orca-bootstrap
redis: Manage and view Spinnaker component sizing configuration for redis
redis-bootstrap: Manage and view Spinnaker component sizing configuration for redis-bootstrap
rosco: Manage and view Spinnaker component sizing configuration for rosco
vault-client: Manage and view Spinnaker component sizing configuration for vault-client
vault-server: Manage and view Spinnaker component sizing configuration for vault-server

hal config deploy component-sizing clouddriver

Manage and view Spinnaker component sizing configuration for clouddriver

Usage

hal config deploy component-sizing clouddriver [parameters] [subcommands]

Parameters

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

Subcommands

delete: Delete the custom component sizings for service clouddriver
edit: Edit the component sizing for service clouddriver, such as the number of replicas and the resources limits.

hal config deploy component-sizing clouddriver delete

Delete the custom component sizings for service clouddriver

Usage

hal config deploy component-sizing clouddriver delete [parameters]

Parameters

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

hal config deploy component-sizing clouddriver edit

Edit the component sizing for service clouddriver, such as the number of replicas and the resources limits.

Usage

hal config deploy component-sizing clouddriver edit [parameters]

Parameters

--container-limits-cpu: Sets the cpu limit for the container running the spinnaker service. Example: 1.
--container-limits-memory: Sets the memory limit for the container running the spinnaker service. Example: 1Gi.
--container-requests-cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
--container-requests-memory: Sets the memory request for the container running the spinnaker service. Example: 512Mi.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pod-limits-cpu: Sets the cpu limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1.
--pod-limits-memory: Sets the memory limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1Gi.
--pod-requests-cpu: Sets the cpu request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 250m.
--pod-requests-memory: Sets the memory request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 512Mi.
--replicas: (Default: 1) Set the number of replicas (pods) to be created for this service.

hal config deploy component-sizing clouddriver-bootstrap

Manage and view Spinnaker component sizing configuration for clouddriver-bootstrap

Usage

hal config deploy component-sizing clouddriver-bootstrap [parameters] [subcommands]

Parameters

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

Subcommands

delete: Delete the custom component sizings for service clouddriver-bootstrap
edit: Edit the component sizing for service clouddriver-bootstrap, such as the number of replicas and the resources limits.

hal config deploy component-sizing clouddriver-bootstrap delete

Delete the custom component sizings for service clouddriver-bootstrap

Usage

hal config deploy component-sizing clouddriver-bootstrap delete [parameters]

Parameters

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

hal config deploy component-sizing clouddriver-bootstrap edit

Edit the component sizing for service clouddriver-bootstrap, such as the number of replicas and the resources limits.

Usage

hal config deploy component-sizing clouddriver-bootstrap edit [parameters]

Parameters

--container-limits-cpu: Sets the cpu limit for the container running the spinnaker service. Example: 1.
--container-limits-memory: Sets the memory limit for the container running the spinnaker service. Example: 1Gi.
--container-requests-cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
--container-requests-memory: Sets the memory request for the container running the spinnaker service. Example: 512Mi.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pod-limits-cpu: Sets the cpu limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1.
--pod-limits-memory: Sets the memory limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1Gi.
--pod-requests-cpu: Sets the cpu request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 250m.
--pod-requests-memory: Sets the memory request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 512Mi.
--replicas: (Default: 1) Set the number of replicas (pods) to be created for this service.

hal config deploy component-sizing clouddriver-caching

Manage and view Spinnaker component sizing configuration for clouddriver-caching

Usage

hal config deploy component-sizing clouddriver-caching [parameters] [subcommands]

Parameters

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

Subcommands

delete: Delete the custom component sizings for service clouddriver-caching
edit: Edit the component sizing for service clouddriver-caching, such as the number of replicas and the resources limits.

hal config deploy component-sizing clouddriver-caching delete

Delete the custom component sizings for service clouddriver-caching

Usage

hal config deploy component-sizing clouddriver-caching delete [parameters]

Parameters

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

hal config deploy component-sizing clouddriver-caching edit

Edit the component sizing for service clouddriver-caching, such as the number of replicas and the resources limits.

Usage

hal config deploy component-sizing clouddriver-caching edit [parameters]

Parameters

--container-limits-cpu: Sets the cpu limit for the container running the spinnaker service. Example: 1.
--container-limits-memory: Sets the memory limit for the container running the spinnaker service. Example: 1Gi.
--container-requests-cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
--container-requests-memory: Sets the memory request for the container running the spinnaker service. Example: 512Mi.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pod-limits-cpu: Sets the cpu limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1.
--pod-limits-memory: Sets the memory limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1Gi.
--pod-requests-cpu: Sets the cpu request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 250m.
--pod-requests-memory: Sets the memory request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 512Mi.
--replicas: (Default: 1) Set the number of replicas (pods) to be created for this service.

hal config deploy component-sizing clouddriver-ro

Manage and view Spinnaker component sizing configuration for clouddriver-ro

Usage

hal config deploy component-sizing clouddriver-ro [parameters] [subcommands]

Parameters

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

Subcommands

delete: Delete the custom component sizings for service clouddriver-ro
edit: Edit the component sizing for service clouddriver-ro, such as the number of replicas and the resources limits.

hal config deploy component-sizing clouddriver-ro delete

Delete the custom component sizings for service clouddriver-ro

Usage

hal config deploy component-sizing clouddriver-ro delete [parameters]

Parameters

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

hal config deploy component-sizing clouddriver-ro edit

Edit the component sizing for service clouddriver-ro, such as the number of replicas and the resources limits.

Usage

hal config deploy component-sizing clouddriver-ro edit [parameters]

Parameters

--container-limits-cpu: Sets the cpu limit for the container running the spinnaker service. Example: 1.
--container-limits-memory: Sets the memory limit for the container running the spinnaker service. Example: 1Gi.
--container-requests-cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
--container-requests-memory: Sets the memory request for the container running the spinnaker service. Example: 512Mi.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pod-limits-cpu: Sets the cpu limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1.
--pod-limits-memory: Sets the memory limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1Gi.
--pod-requests-cpu: Sets the cpu request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 250m.
--pod-requests-memory: Sets the memory request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 512Mi.
--replicas: (Default: 1) Set the number of replicas (pods) to be created for this service.

hal config deploy component-sizing clouddriver-ro-deck

Manage and view Spinnaker component sizing configuration for clouddriver-ro-deck

Usage

hal config deploy component-sizing clouddriver-ro-deck [parameters] [subcommands]

Parameters

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

Subcommands

delete: Delete the custom component sizings for service clouddriver-ro-deck
edit: Edit the component sizing for service clouddriver-ro-deck, such as the number of replicas and the resources limits.

hal config deploy component-sizing clouddriver-ro-deck delete

Delete the custom component sizings for service clouddriver-ro-deck

Usage

hal config deploy component-sizing clouddriver-ro-deck delete [parameters]

Parameters

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

hal config deploy component-sizing clouddriver-ro-deck edit

Edit the component sizing for service clouddriver-ro-deck, such as the number of replicas and the resources limits.

Usage

hal config deploy component-sizing clouddriver-ro-deck edit [parameters]

Parameters

--container-limits-cpu: Sets the cpu limit for the container running the spinnaker service. Example: 1.
--container-limits-memory: Sets the memory limit for the container running the spinnaker service. Example: 1Gi.
--container-requests-cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
--container-requests-memory: Sets the memory request for the container running the spinnaker service. Example: 512Mi.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pod-limits-cpu: Sets the cpu limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1.
--pod-limits-memory: Sets the memory limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1Gi.
--pod-requests-cpu: Sets the cpu request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 250m.
--pod-requests-memory: Sets the memory request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 512Mi.
--replicas: (Default: 1) Set the number of replicas (pods) to be created for this service.

hal config deploy component-sizing clouddriver-rw

Manage and view Spinnaker component sizing configuration for clouddriver-rw

Usage

hal config deploy component-sizing clouddriver-rw [parameters] [subcommands]

Parameters

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

Subcommands

delete: Delete the custom component sizings for service clouddriver-rw
edit: Edit the component sizing for service clouddriver-rw, such as the number of replicas and the resources limits.

hal config deploy component-sizing clouddriver-rw delete

Delete the custom component sizings for service clouddriver-rw

Usage

hal config deploy component-sizing clouddriver-rw delete [parameters]

Parameters

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

hal config deploy component-sizing clouddriver-rw edit

Edit the component sizing for service clouddriver-rw, such as the number of replicas and the resources limits.

Usage

hal config deploy component-sizing clouddriver-rw edit [parameters]

Parameters

--container-limits-cpu: Sets the cpu limit for the container running the spinnaker service. Example: 1.
--container-limits-memory: Sets the memory limit for the container running the spinnaker service. Example: 1Gi.
--container-requests-cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
--container-requests-memory: Sets the memory request for the container running the spinnaker service. Example: 512Mi.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pod-limits-cpu: Sets the cpu limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1.
--pod-limits-memory: Sets the memory limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1Gi.
--pod-requests-cpu: Sets the cpu request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 250m.
--pod-requests-memory: Sets the memory request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 512Mi.
--replicas: (Default: 1) Set the number of replicas (pods) to be created for this service.

hal config deploy component-sizing consul-client

Manage and view Spinnaker component sizing configuration for consul-client

Usage

hal config deploy component-sizing consul-client [parameters] [subcommands]

Parameters

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

Subcommands

delete: Delete the custom component sizings for service consul-client
edit: Edit the component sizing for service consul-client, such as the number of replicas and the resources limits.

hal config deploy component-sizing consul-client delete

Delete the custom component sizings for service consul-client

Usage

hal config deploy component-sizing consul-client delete [parameters]

Parameters

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

hal config deploy component-sizing consul-client edit

Edit the component sizing for service consul-client, such as the number of replicas and the resources limits.

Usage

hal config deploy component-sizing consul-client edit [parameters]

Parameters

--container-limits-cpu: Sets the cpu limit for the container running the spinnaker service. Example: 1.
--container-limits-memory: Sets the memory limit for the container running the spinnaker service. Example: 1Gi.
--container-requests-cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
--container-requests-memory: Sets the memory request for the container running the spinnaker service. Example: 512Mi.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pod-limits-cpu: Sets the cpu limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1.
--pod-limits-memory: Sets the memory limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1Gi.
--pod-requests-cpu: Sets the cpu request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 250m.
--pod-requests-memory: Sets the memory request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 512Mi.
--replicas: (Default: 1) Set the number of replicas (pods) to be created for this service.

hal config deploy component-sizing consul-server

Manage and view Spinnaker component sizing configuration for consul-server

Usage

hal config deploy component-sizing consul-server [parameters] [subcommands]

Parameters

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

Subcommands

delete: Delete the custom component sizings for service consul-server
edit: Edit the component sizing for service consul-server, such as the number of replicas and the resources limits.

hal config deploy component-sizing consul-server delete

Delete the custom component sizings for service consul-server

Usage

hal config deploy component-sizing consul-server delete [parameters]

Parameters

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

hal config deploy component-sizing consul-server edit

Edit the component sizing for service consul-server, such as the number of replicas and the resources limits.

Usage

hal config deploy component-sizing consul-server edit [parameters]

Parameters

--container-limits-cpu: Sets the cpu limit for the container running the spinnaker service. Example: 1.
--container-limits-memory: Sets the memory limit for the container running the spinnaker service. Example: 1Gi.
--container-requests-cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
--container-requests-memory: Sets the memory request for the container running the spinnaker service. Example: 512Mi.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pod-limits-cpu: Sets the cpu limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1.
--pod-limits-memory: Sets the memory limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1Gi.
--pod-requests-cpu: Sets the cpu request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 250m.
--pod-requests-memory: Sets the memory request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 512Mi.
--replicas: (Default: 1) Set the number of replicas (pods) to be created for this service.

hal config deploy component-sizing deck

Manage and view Spinnaker component sizing configuration for deck

Usage

hal config deploy component-sizing deck [parameters] [subcommands]

Parameters

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

Subcommands

delete: Delete the custom component sizings for service deck
edit: Edit the component sizing for service deck, such as the number of replicas and the resources limits.

hal config deploy component-sizing deck delete

Delete the custom component sizings for service deck

Usage

hal config deploy component-sizing deck delete [parameters]

Parameters

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

hal config deploy component-sizing deck edit

Edit the component sizing for service deck, such as the number of replicas and the resources limits.

Usage

hal config deploy component-sizing deck edit [parameters]

Parameters

--container-limits-cpu: Sets the cpu limit for the container running the spinnaker service. Example: 1.
--container-limits-memory: Sets the memory limit for the container running the spinnaker service. Example: 1Gi.
--container-requests-cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
--container-requests-memory: Sets the memory request for the container running the spinnaker service. Example: 512Mi.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pod-limits-cpu: Sets the cpu limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1.
--pod-limits-memory: Sets the memory limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1Gi.
--pod-requests-cpu: Sets the cpu request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 250m.
--pod-requests-memory: Sets the memory request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 512Mi.
--replicas: (Default: 1) Set the number of replicas (pods) to be created for this service.

hal config deploy component-sizing echo

Manage and view Spinnaker component sizing configuration for echo

Usage

hal config deploy component-sizing echo [parameters] [subcommands]

Parameters

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

Subcommands

delete: Delete the custom component sizings for service echo
edit: Edit the component sizing for service echo, such as the number of replicas and the resources limits.

hal config deploy component-sizing echo delete

Delete the custom component sizings for service echo

Usage

hal config deploy component-sizing echo delete [parameters]

Parameters

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

hal config deploy component-sizing echo edit

Edit the component sizing for service echo, such as the number of replicas and the resources limits.

Usage

hal config deploy component-sizing echo edit [parameters]

Parameters

--container-limits-cpu: Sets the cpu limit for the container running the spinnaker service. Example: 1.
--container-limits-memory: Sets the memory limit for the container running the spinnaker service. Example: 1Gi.
--container-requests-cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
--container-requests-memory: Sets the memory request for the container running the spinnaker service. Example: 512Mi.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pod-limits-cpu: Sets the cpu limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1.
--pod-limits-memory: Sets the memory limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1Gi.
--pod-requests-cpu: Sets the cpu request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 250m.
--pod-requests-memory: Sets the memory request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 512Mi.
--replicas: (Default: 1) Set the number of replicas (pods) to be created for this service.

hal config deploy component-sizing echo-scheduler

Manage and view Spinnaker component sizing configuration for echo-scheduler

Usage

hal config deploy component-sizing echo-scheduler [parameters] [subcommands]

Parameters

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

Subcommands

delete: Delete the custom component sizings for service echo-scheduler
edit: Edit the component sizing for service echo-scheduler, such as the number of replicas and the resources limits.

hal config deploy component-sizing echo-scheduler delete

Delete the custom component sizings for service echo-scheduler

Usage

hal config deploy component-sizing echo-scheduler delete [parameters]

Parameters

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

hal config deploy component-sizing echo-scheduler edit

Edit the component sizing for service echo-scheduler, such as the number of replicas and the resources limits.

Usage

hal config deploy component-sizing echo-scheduler edit [parameters]

Parameters

--container-limits-cpu: Sets the cpu limit for the container running the spinnaker service. Example: 1.
--container-limits-memory: Sets the memory limit for the container running the spinnaker service. Example: 1Gi.
--container-requests-cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
--container-requests-memory: Sets the memory request for the container running the spinnaker service. Example: 512Mi.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pod-limits-cpu: Sets the cpu limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1.
--pod-limits-memory: Sets the memory limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1Gi.
--pod-requests-cpu: Sets the cpu request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 250m.
--pod-requests-memory: Sets the memory request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 512Mi.
--replicas: (Default: 1) Set the number of replicas (pods) to be created for this service.

hal config deploy component-sizing echo-worker

Manage and view Spinnaker component sizing configuration for echo-worker

Usage

hal config deploy component-sizing echo-worker [parameters] [subcommands]

Parameters

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

Subcommands

delete: Delete the custom component sizings for service echo-worker
edit: Edit the component sizing for service echo-worker, such as the number of replicas and the resources limits.

hal config deploy component-sizing echo-worker delete

Delete the custom component sizings for service echo-worker

Usage

hal config deploy component-sizing echo-worker delete [parameters]

Parameters

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

hal config deploy component-sizing echo-worker edit

Edit the component sizing for service echo-worker, such as the number of replicas and the resources limits.

Usage

hal config deploy component-sizing echo-worker edit [parameters]

Parameters

--container-limits-cpu: Sets the cpu limit for the container running the spinnaker service. Example: 1.
--container-limits-memory: Sets the memory limit for the container running the spinnaker service. Example: 1Gi.
--container-requests-cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
--container-requests-memory: Sets the memory request for the container running the spinnaker service. Example: 512Mi.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pod-limits-cpu: Sets the cpu limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1.
--pod-limits-memory: Sets the memory limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1Gi.
--pod-requests-cpu: Sets the cpu request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 250m.
--pod-requests-memory: Sets the memory request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 512Mi.
--replicas: (Default: 1) Set the number of replicas (pods) to be created for this service.

hal config deploy component-sizing fiat

Manage and view Spinnaker component sizing configuration for fiat

Usage

hal config deploy component-sizing fiat [parameters] [subcommands]

Parameters

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

Subcommands

delete: Delete the custom component sizings for service fiat
edit: Edit the component sizing for service fiat, such as the number of replicas and the resources limits.

hal config deploy component-sizing fiat delete

Delete the custom component sizings for service fiat

Usage

hal config deploy component-sizing fiat delete [parameters]

Parameters

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

hal config deploy component-sizing fiat edit

Edit the component sizing for service fiat, such as the number of replicas and the resources limits.

Usage

hal config deploy component-sizing fiat edit [parameters]

Parameters

--container-limits-cpu: Sets the cpu limit for the container running the spinnaker service. Example: 1.
--container-limits-memory: Sets the memory limit for the container running the spinnaker service. Example: 1Gi.
--container-requests-cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
--container-requests-memory: Sets the memory request for the container running the spinnaker service. Example: 512Mi.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pod-limits-cpu: Sets the cpu limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1.
--pod-limits-memory: Sets the memory limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1Gi.
--pod-requests-cpu: Sets the cpu request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 250m.
--pod-requests-memory: Sets the memory request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 512Mi.
--replicas: (Default: 1) Set the number of replicas (pods) to be created for this service.

hal config deploy component-sizing front50

Manage and view Spinnaker component sizing configuration for front50

Usage

hal config deploy component-sizing front50 [parameters] [subcommands]

Parameters

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

Subcommands

delete: Delete the custom component sizings for service front50
edit: Edit the component sizing for service front50, such as the number of replicas and the resources limits.

hal config deploy component-sizing front50 delete

Delete the custom component sizings for service front50

Usage

hal config deploy component-sizing front50 delete [parameters]

Parameters

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

hal config deploy component-sizing front50 edit

Edit the component sizing for service front50, such as the number of replicas and the resources limits.

Usage

hal config deploy component-sizing front50 edit [parameters]

Parameters

--container-limits-cpu: Sets the cpu limit for the container running the spinnaker service. Example: 1.
--container-limits-memory: Sets the memory limit for the container running the spinnaker service. Example: 1Gi.
--container-requests-cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
--container-requests-memory: Sets the memory request for the container running the spinnaker service. Example: 512Mi.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pod-limits-cpu: Sets the cpu limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1.
--pod-limits-memory: Sets the memory limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1Gi.
--pod-requests-cpu: Sets the cpu request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 250m.
--pod-requests-memory: Sets the memory request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 512Mi.
--replicas: (Default: 1) Set the number of replicas (pods) to be created for this service.

hal config deploy component-sizing gate

Manage and view Spinnaker component sizing configuration for gate

Usage

hal config deploy component-sizing gate [parameters] [subcommands]

Parameters

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

Subcommands

delete: Delete the custom component sizings for service gate
edit: Edit the component sizing for service gate, such as the number of replicas and the resources limits.

hal config deploy component-sizing gate delete

Delete the custom component sizings for service gate

Usage

hal config deploy component-sizing gate delete [parameters]

Parameters

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

hal config deploy component-sizing gate edit

Edit the component sizing for service gate, such as the number of replicas and the resources limits.

Usage

hal config deploy component-sizing gate edit [parameters]

Parameters

--container-limits-cpu: Sets the cpu limit for the container running the spinnaker service. Example: 1.
--container-limits-memory: Sets the memory limit for the container running the spinnaker service. Example: 1Gi.
--container-requests-cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
--container-requests-memory: Sets the memory request for the container running the spinnaker service. Example: 512Mi.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pod-limits-cpu: Sets the cpu limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1.
--pod-limits-memory: Sets the memory limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1Gi.
--pod-requests-cpu: Sets the cpu request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 250m.
--pod-requests-memory: Sets the memory request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 512Mi.
--replicas: (Default: 1) Set the number of replicas (pods) to be created for this service.

hal config deploy component-sizing igor

Manage and view Spinnaker component sizing configuration for igor

Usage

hal config deploy component-sizing igor [parameters] [subcommands]

Parameters

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

Subcommands

delete: Delete the custom component sizings for service igor
edit: Edit the component sizing for service igor, such as the number of replicas and the resources limits.

hal config deploy component-sizing igor delete

Delete the custom component sizings for service igor

Usage

hal config deploy component-sizing igor delete [parameters]

Parameters

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

hal config deploy component-sizing igor edit

Edit the component sizing for service igor, such as the number of replicas and the resources limits.

Usage

hal config deploy component-sizing igor edit [parameters]

Parameters

--container-limits-cpu: Sets the cpu limit for the container running the spinnaker service. Example: 1.
--container-limits-memory: Sets the memory limit for the container running the spinnaker service. Example: 1Gi.
--container-requests-cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
--container-requests-memory: Sets the memory request for the container running the spinnaker service. Example: 512Mi.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pod-limits-cpu: Sets the cpu limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1.
--pod-limits-memory: Sets the memory limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1Gi.
--pod-requests-cpu: Sets the cpu request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 250m.
--pod-requests-memory: Sets the memory request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 512Mi.
--replicas: (Default: 1) Set the number of replicas (pods) to be created for this service.

hal config deploy component-sizing kayenta

Manage and view Spinnaker component sizing configuration for kayenta

Usage

hal config deploy component-sizing kayenta [parameters] [subcommands]

Parameters

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

Subcommands

delete: Delete the custom component sizings for service kayenta
edit: Edit the component sizing for service kayenta, such as the number of replicas and the resources limits.

hal config deploy component-sizing kayenta delete

Delete the custom component sizings for service kayenta

Usage

hal config deploy component-sizing kayenta delete [parameters]

Parameters

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

hal config deploy component-sizing kayenta edit

Edit the component sizing for service kayenta, such as the number of replicas and the resources limits.

Usage

hal config deploy component-sizing kayenta edit [parameters]

Parameters

--container-limits-cpu: Sets the cpu limit for the container running the spinnaker service. Example: 1.
--container-limits-memory: Sets the memory limit for the container running the spinnaker service. Example: 1Gi.
--container-requests-cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
--container-requests-memory: Sets the memory request for the container running the spinnaker service. Example: 512Mi.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pod-limits-cpu: Sets the cpu limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1.
--pod-limits-memory: Sets the memory limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1Gi.
--pod-requests-cpu: Sets the cpu request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 250m.
--pod-requests-memory: Sets the memory request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 512Mi.
--replicas: (Default: 1) Set the number of replicas (pods) to be created for this service.

hal config deploy component-sizing monitoring-daemon

Manage and view Spinnaker component sizing configuration for monitoring-daemon

Usage

hal config deploy component-sizing monitoring-daemon [parameters] [subcommands]

Parameters

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

Subcommands

delete: Delete the custom component sizings for service monitoring-daemon
edit: Edit the component sizing for service monitoring-daemon, such as the number of replicas and the resources limits.

hal config deploy component-sizing monitoring-daemon delete

Delete the custom component sizings for service monitoring-daemon

Usage

hal config deploy component-sizing monitoring-daemon delete [parameters]

Parameters

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

hal config deploy component-sizing monitoring-daemon edit

Edit the component sizing for service monitoring-daemon, such as the number of replicas and the resources limits.

Usage

hal config deploy component-sizing monitoring-daemon edit [parameters]

Parameters

--container-limits-cpu: Sets the cpu limit for the container running the spinnaker service. Example: 1.
--container-limits-memory: Sets the memory limit for the container running the spinnaker service. Example: 1Gi.
--container-requests-cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
--container-requests-memory: Sets the memory request for the container running the spinnaker service. Example: 512Mi.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pod-limits-cpu: Sets the cpu limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1.
--pod-limits-memory: Sets the memory limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1Gi.
--pod-requests-cpu: Sets the cpu request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 250m.
--pod-requests-memory: Sets the memory request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 512Mi.
--replicas: (Default: 1) Set the number of replicas (pods) to be created for this service.

hal config deploy component-sizing orca

Manage and view Spinnaker component sizing configuration for orca

Usage

hal config deploy component-sizing orca [parameters] [subcommands]

Parameters

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

Subcommands

delete: Delete the custom component sizings for service orca
edit: Edit the component sizing for service orca, such as the number of replicas and the resources limits.

hal config deploy component-sizing orca delete

Delete the custom component sizings for service orca

Usage

hal config deploy component-sizing orca delete [parameters]

Parameters

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

hal config deploy component-sizing orca edit

Edit the component sizing for service orca, such as the number of replicas and the resources limits.

Usage

hal config deploy component-sizing orca edit [parameters]

Parameters

--container-limits-cpu: Sets the cpu limit for the container running the spinnaker service. Example: 1.
--container-limits-memory: Sets the memory limit for the container running the spinnaker service. Example: 1Gi.
--container-requests-cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
--container-requests-memory: Sets the memory request for the container running the spinnaker service. Example: 512Mi.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pod-limits-cpu: Sets the cpu limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1.
--pod-limits-memory: Sets the memory limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1Gi.
--pod-requests-cpu: Sets the cpu request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 250m.
--pod-requests-memory: Sets the memory request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 512Mi.
--replicas: (Default: 1) Set the number of replicas (pods) to be created for this service.

hal config deploy component-sizing orca-bootstrap

Manage and view Spinnaker component sizing configuration for orca-bootstrap

Usage

hal config deploy component-sizing orca-bootstrap [parameters] [subcommands]

Parameters

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

Subcommands

delete: Delete the custom component sizings for service orca-bootstrap
edit: Edit the component sizing for service orca-bootstrap, such as the number of replicas and the resources limits.

hal config deploy component-sizing orca-bootstrap delete

Delete the custom component sizings for service orca-bootstrap

Usage

hal config deploy component-sizing orca-bootstrap delete [parameters]

Parameters

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

hal config deploy component-sizing orca-bootstrap edit

Edit the component sizing for service orca-bootstrap, such as the number of replicas and the resources limits.

Usage

hal config deploy component-sizing orca-bootstrap edit [parameters]

Parameters

--container-limits-cpu: Sets the cpu limit for the container running the spinnaker service. Example: 1.
--container-limits-memory: Sets the memory limit for the container running the spinnaker service. Example: 1Gi.
--container-requests-cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
--container-requests-memory: Sets the memory request for the container running the spinnaker service. Example: 512Mi.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pod-limits-cpu: Sets the cpu limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1.
--pod-limits-memory: Sets the memory limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1Gi.
--pod-requests-cpu: Sets the cpu request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 250m.
--pod-requests-memory: Sets the memory request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 512Mi.
--replicas: (Default: 1) Set the number of replicas (pods) to be created for this service.

hal config deploy component-sizing redis

Manage and view Spinnaker component sizing configuration for redis

Usage

hal config deploy component-sizing redis [parameters] [subcommands]

Parameters

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

Subcommands

delete: Delete the custom component sizings for service redis
edit: Edit the component sizing for service redis, such as the number of replicas and the resources limits.

hal config deploy component-sizing redis delete

Delete the custom component sizings for service redis

Usage

hal config deploy component-sizing redis delete [parameters]

Parameters

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

hal config deploy component-sizing redis edit

Edit the component sizing for service redis, such as the number of replicas and the resources limits.

Usage

hal config deploy component-sizing redis edit [parameters]

Parameters

--container-limits-cpu: Sets the cpu limit for the container running the spinnaker service. Example: 1.
--container-limits-memory: Sets the memory limit for the container running the spinnaker service. Example: 1Gi.
--container-requests-cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
--container-requests-memory: Sets the memory request for the container running the spinnaker service. Example: 512Mi.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pod-limits-cpu: Sets the cpu limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1.
--pod-limits-memory: Sets the memory limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1Gi.
--pod-requests-cpu: Sets the cpu request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 250m.
--pod-requests-memory: Sets the memory request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 512Mi.
--replicas: (Default: 1) Set the number of replicas (pods) to be created for this service.

hal config deploy component-sizing redis-bootstrap

Manage and view Spinnaker component sizing configuration for redis-bootstrap

Usage

hal config deploy component-sizing redis-bootstrap [parameters] [subcommands]

Parameters

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

Subcommands

delete: Delete the custom component sizings for service redis-bootstrap
edit: Edit the component sizing for service redis-bootstrap, such as the number of replicas and the resources limits.

hal config deploy component-sizing redis-bootstrap delete

Delete the custom component sizings for service redis-bootstrap

Usage

hal config deploy component-sizing redis-bootstrap delete [parameters]

Parameters

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

hal config deploy component-sizing redis-bootstrap edit

Edit the component sizing for service redis-bootstrap, such as the number of replicas and the resources limits.

Usage

hal config deploy component-sizing redis-bootstrap edit [parameters]

Parameters

--container-limits-cpu: Sets the cpu limit for the container running the spinnaker service. Example: 1.
--container-limits-memory: Sets the memory limit for the container running the spinnaker service. Example: 1Gi.
--container-requests-cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
--container-requests-memory: Sets the memory request for the container running the spinnaker service. Example: 512Mi.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pod-limits-cpu: Sets the cpu limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1.
--pod-limits-memory: Sets the memory limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1Gi.
--pod-requests-cpu: Sets the cpu request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 250m.
--pod-requests-memory: Sets the memory request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 512Mi.
--replicas: (Default: 1) Set the number of replicas (pods) to be created for this service.

hal config deploy component-sizing rosco

Manage and view Spinnaker component sizing configuration for rosco

Usage

hal config deploy component-sizing rosco [parameters] [subcommands]

Parameters

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

Subcommands

delete: Delete the custom component sizings for service rosco
edit: Edit the component sizing for service rosco, such as the number of replicas and the resources limits.

hal config deploy component-sizing rosco delete

Delete the custom component sizings for service rosco

Usage

hal config deploy component-sizing rosco delete [parameters]

Parameters

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

hal config deploy component-sizing rosco edit

Edit the component sizing for service rosco, such as the number of replicas and the resources limits.

Usage

hal config deploy component-sizing rosco edit [parameters]

Parameters

--container-limits-cpu: Sets the cpu limit for the container running the spinnaker service. Example: 1.
--container-limits-memory: Sets the memory limit for the container running the spinnaker service. Example: 1Gi.
--container-requests-cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
--container-requests-memory: Sets the memory request for the container running the spinnaker service. Example: 512Mi.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pod-limits-cpu: Sets the cpu limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1.
--pod-limits-memory: Sets the memory limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1Gi.
--pod-requests-cpu: Sets the cpu request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 250m.
--pod-requests-memory: Sets the memory request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 512Mi.
--replicas: (Default: 1) Set the number of replicas (pods) to be created for this service.

hal config deploy component-sizing vault-client

Manage and view Spinnaker component sizing configuration for vault-client

Usage

hal config deploy component-sizing vault-client [parameters] [subcommands]

Parameters

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

Subcommands

delete: Delete the custom component sizings for service vault-client
edit: Edit the component sizing for service vault-client, such as the number of replicas and the resources limits.

hal config deploy component-sizing vault-client delete

Delete the custom component sizings for service vault-client

Usage

hal config deploy component-sizing vault-client delete [parameters]

Parameters

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

hal config deploy component-sizing vault-client edit

Edit the component sizing for service vault-client, such as the number of replicas and the resources limits.

Usage

hal config deploy component-sizing vault-client edit [parameters]

Parameters

--container-limits-cpu: Sets the cpu limit for the container running the spinnaker service. Example: 1.
--container-limits-memory: Sets the memory limit for the container running the spinnaker service. Example: 1Gi.
--container-requests-cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
--container-requests-memory: Sets the memory request for the container running the spinnaker service. Example: 512Mi.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pod-limits-cpu: Sets the cpu limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1.
--pod-limits-memory: Sets the memory limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1Gi.
--pod-requests-cpu: Sets the cpu request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 250m.
--pod-requests-memory: Sets the memory request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 512Mi.
--replicas: (Default: 1) Set the number of replicas (pods) to be created for this service.

hal config deploy component-sizing vault-server

Manage and view Spinnaker component sizing configuration for vault-server

Usage

hal config deploy component-sizing vault-server [parameters] [subcommands]

Parameters

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

Subcommands

delete: Delete the custom component sizings for service vault-server
edit: Edit the component sizing for service vault-server, such as the number of replicas and the resources limits.

hal config deploy component-sizing vault-server delete

Delete the custom component sizings for service vault-server

Usage

hal config deploy component-sizing vault-server delete [parameters]

Parameters

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

hal config deploy component-sizing vault-server edit

Edit the component sizing for service vault-server, such as the number of replicas and the resources limits.

Usage

hal config deploy component-sizing vault-server edit [parameters]

Parameters

--container-limits-cpu: Sets the cpu limit for the container running the spinnaker service. Example: 1.
--container-limits-memory: Sets the memory limit for the container running the spinnaker service. Example: 1Gi.
--container-requests-cpu: Sets the cpu request for the container running the spinnaker service. Example: 250m.
--container-requests-memory: Sets the memory request for the container running the spinnaker service. Example: 512Mi.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pod-limits-cpu: Sets the cpu limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1.
--pod-limits-memory: Sets the memory limit for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 1Gi.
--pod-requests-cpu: Sets the cpu request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 250m.
--pod-requests-memory: Sets the memory request for the container running the spinnaker service, as well as any sidecar containers (e.g. the monitoring daemon). Example: 512Mi.
--replicas: (Default: 1) Set the number of replicas (pods) to be created for this service.

hal config deploy edit

Edit Spinnaker’s deployment footprint and configuration.

Usage

hal config deploy edit [parameters]

Parameters

--account-name: The Spinnaker account that Spinnaker will be deployed to, assuming you are running a deployment of Spinnaker that requires an active cloud provider.
--bootstrap-only: A bootstrap-only account is the account in which Spinnaker itself is deployed. When true, this account will not be included the accounts managed by Spinnaker.
--consul-address: The address of a running Consul cluster. See https://www.consul.io/ . This is only required when Spinnaker is being deployed in non-Kubernetes clustered configuration.
--consul-enabled: Whether or not to use Consul as a service discovery mechanism to deploy Spinnaker.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--git-origin-user: This is the git user your github fork exists under.
--git-upstream-user: This is the upstream git user you are configuring to pull changes from & push PRs to.
--image-variant: The container image variant type to use when deploying a distributed installation of Spinnaker. slim: Based on an Alpine image ubuntu: Based on Canonical’s ubuntu:bionic image. java8: A variant of slim that uses the Java 8 runtime ubuntu-java8: A variant of ubuntu that uses the Java 8 runtime Default value: slim
--liveness-probe-enabled: When true, enable Kubernetes liveness probes on Spinnaker services deployed in a Distributed installation. See docs for more information: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/
--liveness-probe-initial-delay-seconds: The number of seconds to wait before performing the first liveness probe. Should be set to the longest service startup time. See docs for more information: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/
--location: This is the location spinnaker will be deployed to. When deploying to Kubernetes, use this flag to specify the namespace to deploy to (defaults to ‘spinnaker’)
--no-validate: (Default: false) Skip validation.
--type: Distributed: Deploy Spinnaker with one server group per microservice, and a single shared Redis. LocalDebian: Download and run the Spinnaker debians on the machine running the Daemon. LocalGit: Download and run the Spinnaker git repos on the machine running the Daemon.
--update-versions: When set to “false”, any local version of Spinnaker components will be used instead of attempting to update. This does not work for distributed installations of Spinnaker, where no local version exists.
--vault-address: The address of a running Vault datastore. See https://www.vaultproject.io/ . This is only required when Spinnaker is being deployed in non-Kubernetes clustered configuration.
--vault-enabled: Whether or not to use Vault as a secret storage mechanism to deploy Spinnaker.

hal config deploy ha

Configure, validate, and view the specified high availability Spinnaker service configuration.

Usage

hal config deploy ha [subcommands]

Subcommands

clouddriver: Manage and view Spinnaker configuration for the clouddriver high availability service
echo: Manage and view Spinnaker configuration for the echo high availability service

hal config deploy ha clouddriver

Manage and view Spinnaker configuration for the clouddriver high availability service Manage and view Spinnaker configuration for the clouddriver high availability service. When clouddriver high availability is enabled, Halyard will deploy clouddriver as three separate services in order to increase availability: clouddriver-rw, clouddriver-ro, and clouddriver-caching. The clouddriver-rw service handles mutation operations sent via orca. The clouddriver-ro service handles read queries and does not perform write operations to redis. The clouddriver-caching service handles the periodic caching of cloud provider data, and is isolated from the rest of Spinnaker. The three services are configured to use the shared redis provisioned by Halyard, by default. To achieve more scale, a redis master endpoint and a redis slave endpoint can be supplied. The clouddriver-rw and clouddriver-caching services will use the redis master and the clouddriver-ro service will use the redis slave.

Usage

hal config deploy ha clouddriver [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 the clouddriver high availability service as disabled
edit: Edit the clouddriver high availability service
enable: Set the clouddriver high availability service as enabled

hal config deploy ha clouddriver disable

Set the clouddriver high availability service as disabled

Usage

hal config deploy ha clouddriver disable [parameters]

Parameters

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

hal config deploy ha clouddriver edit

Edit the clouddriver high availability service

Usage

hal config deploy ha clouddriver edit [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--redis-master-endpoint: Set external Redis endpoint for clouddriver-rw and clouddriver-caching. The Redis URI schema is described here: https://www.iana.org/assignments/uri-schemes/prov/redis . clouddriver-rw and clouddriver-caching are configured to use the shared Redis, by default.
--redis-slave-deck-endpoint: Set external Redis endpoint for clouddriver-ro-deck. The Redis URI schema is described here: https://www.iana.org/assignments/uri-schemes/prov/redis . clouddriver-ro-deck is configured to use the shared Redis, by default.
--redis-slave-endpoint: Set external Redis endpoint for clouddriver-ro. The Redis URI schema is described here: https://www.iana.org/assignments/uri-schemes/prov/redis . clouddriver-ro is configured to use the shared Redis, by default.

hal config deploy ha clouddriver enable

Set the clouddriver high availability service as enabled

Usage

hal config deploy ha clouddriver enable [parameters]

Parameters

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

hal config deploy ha echo

Manage and view Spinnaker configuration for the echo high availability service Manage and view Spinnaker configuration for the echo high availability service. When echo high availability is enabled, Halyard will deploy echo as two separate services in order to increase availability: echo-scheduler and echo-worker. The echo-scheduler service only handles Spinnaker cron-jobs and is isolated from the rest of Spinnaker. The echo-worker handles everything else.

Usage

hal config deploy ha echo [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 the echo high availability service as disabled
enable: Set the echo high availability service as enabled

hal config deploy ha echo disable

Set the echo high availability service as disabled

Usage

hal config deploy ha echo disable [parameters]

Parameters

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

hal config deploy ha echo enable

Set the echo high availability service as enabled

Usage

hal config deploy ha echo enable [parameters]

Parameters

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

hal config edit

Configure top-level, global configuration parameters. The properties edited here affect all Spinnaker subcomponents.

Usage

hal config edit [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--timezone: The timezone your Spinnaker instance runs in. This affects what the UI will display as well as how CRON triggers are run.

hal config features

Display the state of Spinnaker’s feature flags.

Usage

hal config features [parameters] [subcommands]

Parameters

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

Subcommands

edit: Enable and disable Spinnaker feature flags.

hal config features edit

Enable and disable Spinnaker feature flags.

Usage

hal config features edit [parameters]

Parameters

--artifacts: Enable artifact support. Read more at https://spinnaker.io/reference/artifacts/
--artifacts-rewrite: Enable new artifact support. Read more at https://www.spinnaker.io/reference/artifacts-with-artifactsrewrite/
--chaos: Enable Chaos Monkey support. For this to work, you’ll need a running Chaos Monkey deployment. Currently, Halyard doesn’t configure Chaos Monkey for you; read more instructions here https://github.com/Netflix/chaosmonkey/wiki .
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--gremlin: Enable Gremlin fault-injection support.
--managed-pipeline-templates-v2-ui: Enable managed pipeline templates v2 UI support.
--mine-canary: Enable canary support. For this to work, you’ll need a canary judge configured. Currently, Halyard does not configure canary judge for you.
--no-validate: (Default: false) Skip validation.
--pipeline-templates: Enable pipeline template support. Read more at https://github.com/spinnaker/dcd-spec .

hal config generate

Generate the full Spinnaker config for your current deployment. This does not apply that configuration to your running Spinnaker installation. That either needs to be done manually, or with hal deploy apply.

Usage

hal config generate [parameters]

Parameters

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

hal config list

Lists all deployments

Usage

hal config list [parameters]

Parameters

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

hal config metric-stores

Configure Spinnaker’s metric stores. Metrics stores are used to store metrics for the various Spinnaker micro-services. These metrics are not related in any way to canary deployments. The technologies backing both are similar, but metrics stores are places to push metrics regarding Spinnaker metrics, whereas canary metrics stores are used to pull metrics to analyze deployments. This configuration only affects the publishing of metrics against whichever metric stores you enable (it can be more than one).

Usage

hal config metric-stores [parameters] [subcommands]

Parameters

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

Subcommands

datadog: Configure your datadog metric store.
edit: Configure global metric stores properties.
newrelic: Configure your newrelic metric store.
prometheus: Configure your prometheus metric store.
stackdriver: Configure your stackdriver metric store.

hal config metric-stores datadog

Configure your datadog metric store.

Usage

hal config metric-stores datadog [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 the datadog method as disabled
edit: Edit the datadog metric store.
enable: Set the datadog method as enabled

hal config metric-stores datadog disable

Set the datadog method as disabled

Usage

hal config metric-stores datadog disable [parameters]

Parameters

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

hal config metric-stores datadog edit

Edit the datadog metric store.

Usage

hal config metric-stores datadog edit [parameters]

Parameters

--add-tag: Add this tag to the list of Datadog tags.
--api-key: Your datadog API key.
--app-key: Your datadog app key. This is only required if you want Spinnaker to push pre-configured Spinnaker dashboards to your Datadog account.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--remove-tag: Remove this tag from the list of Datadog tags.
--tags: (Default: []) Your datadog custom tags. Please delimit the KVP with colons i.e. –tags app:test env:dev

hal config metric-stores datadog enable

Set the datadog method as enabled

Usage

hal config metric-stores datadog enable [parameters]

Parameters

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

hal config metric-stores edit

Configure global metric stores properties.

Usage

hal config metric-stores edit [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--period: (Required) Set the polling period for the monitoring daemon.

hal config metric-stores newrelic

Configure your newrelic metric store.

Usage

hal config metric-stores newrelic [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 the newrelic method as disabled
edit: Edit the newrelic metric store.
enable: Set the newrelic method as enabled

hal config metric-stores newrelic disable

Set the newrelic method as disabled

Usage

hal config metric-stores newrelic disable [parameters]

Parameters

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

hal config metric-stores newrelic edit

Edit the newrelic metric store.

Usage

hal config metric-stores newrelic edit [parameters]

Parameters

--add-tag: Add this tag to the list of tags. Use the format key:value i.e. –add-tag app:test
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--host: The URL to post metric data to. In almost all cases, this is set correctly by default and should not be used.
--insert-key: Your New Relic Insights insert key
--no-validate: (Default: false) Skip validation.
--remove-tag: Remove this tag from the list of tags. Use the name of the tag you want to remove i.e. –remove-tag app
--tags: (Default: []) Your custom tags. Please delimit the KVP with colons i.e. –tags app:test env:dev

hal config metric-stores newrelic enable

Set the newrelic method as enabled

Usage

hal config metric-stores newrelic enable [parameters]

Parameters

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

hal config metric-stores prometheus

Configure your prometheus metric store.

Usage

hal config metric-stores prometheus [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 the prometheus method as disabled
edit: Edit the prometheus metric store.
enable: Set the prometheus method as enabled

hal config metric-stores prometheus disable

Set the prometheus method as disabled

Usage

hal config metric-stores prometheus disable [parameters]

Parameters

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

hal config metric-stores prometheus edit

Edit the prometheus metric store.

Usage

hal config metric-stores prometheus edit [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--push-gateway: The endpoint the monitoring Daemon should push metrics to. If you have configured Prometheus to automatically discover all your Spinnaker services and pull metrics from them this is not required.

hal config metric-stores prometheus enable

Set the prometheus method as enabled

Usage

hal config metric-stores prometheus enable [parameters]

Parameters

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

hal config metric-stores stackdriver

Configure your stackdriver metric store.

Usage

hal config metric-stores stackdriver [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 the stackdriver method as disabled
edit: Edit the stackdriver metric store.
enable: Set the stackdriver method as enabled

hal config metric-stores stackdriver disable

Set the stackdriver method as disabled

Usage

hal config metric-stores stackdriver disable [parameters]

Parameters

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

hal config metric-stores stackdriver edit

Edit the stackdriver metric store.

Usage

hal config metric-stores stackdriver edit [parameters]

Parameters

--credentials-path: A path to a Google JSON service account that has permission to publish metrics.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--project: The project Spinnaker’s metrics should be published to.
--zone: The zone Spinnaker’s metrics should be associated with.

hal config metric-stores stackdriver enable

Set the stackdriver method as enabled

Usage

hal config metric-stores stackdriver enable [parameters]

Parameters

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

hal config notification

Display the state of Spinnaker’s notification settings.

Usage

hal config notification [parameters] [subcommands]

Parameters

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

Subcommands

github-status: Manage and view Spinnaker configuration for the github-status notification
pubsub: Configure, validate, and view the specified pubsub.
slack: Manage and view Spinnaker configuration for the slack notification
twilio: Manage and view Spinnaker configuration for the twilio notification

hal config notification github-status

Manage and view Spinnaker configuration for the github-status notification

Usage

hal config notification github-status [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 the github-status notification as disabled
edit: Edit the github-status notification type
enable: Set the github-status notification as enabled

hal config notification github-status disable

Set the github-status notification as disabled

Usage

hal config notification github-status disable [parameters]

Parameters

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

hal config notification github-status edit

Edit the github-status notification type

Usage

hal config notification github-status edit [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--token: (Sensitive data - user will be prompted on standard input) Your github account token.

hal config notification github-status enable

Set the github-status notification as enabled

Usage

hal config notification github-status enable [parameters]

Parameters

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

hal config notification pubsub

Configure, validate, and view the specified pubsub.

Usage

hal config notification pubsub [subcommands]

Subcommands

google: Manage and view Spinnaker configuration for the google pubsub

hal config notification pubsub google

Manage and view Spinnaker configuration for the google pubsub

Usage

hal config notification pubsub google [parameters] [subcommands]

Parameters

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

Subcommands

add: Add a publisher of type google
delete: Delete a specific google publisher by name.
disable: Set the google pubsub as disabled
edit: Edit an publisher in the google pubsub.
enable: Set the google pubsub as enabled
get: Get the specified publisher details for the google pubsub.
list: List the publisher names for the google pubsub.

hal config notification pubsub google add

Add a publisher of type google

Usage

hal config notification pubsub google add PUBLISHER [parameters]

Parameters

PUBLISHER: The name of the publishers to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--json-path: The path to a JSON service account that Spinnaker will use as credentials. This is only needed if Spinnaker is not deployed on a Google Compute Engine VM, or needs permissions not afforded to the VM it is running on. See https://cloud.google.com/compute/docs/access/service-accounts for more information.
--no-validate: (Default: false) Skip validation.
--project: The name of the GCP project your subscription lives in.
--topic-name: The name of the topic to publish to. This identifier does not include the name of the project, and must already be configured for Spinnaker to work.

hal config notification pubsub google delete

Delete a specific google publisher by name.

Usage

hal config notification pubsub google delete PUBLISHER [parameters]

Parameters

PUBLISHER: The name of the publishers to operate on.

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

hal config notification pubsub google disable

Set the google pubsub as disabled

Usage

hal config notification pubsub google disable [parameters]

Parameters

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

hal config notification pubsub google edit

Edit an publisher in the google pubsub.

Usage

hal config notification pubsub google edit PUBLISHER [parameters]

Parameters

PUBLISHER: The name of the publishers to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--json-path: The path to a JSON service account that Spinnaker will use as credentials. This is only needed if Spinnaker is not deployed on a Google Compute Engine VM, or needs permissions not afforded to the VM it is running on. See https://cloud.google.com/compute/docs/access/service-accounts for more information.
--no-validate: (Default: false) Skip validation.
--project: The name of the GCP project your subscription lives in.
--topic-name: The name of the topic to publish to. This identifier does not include the name of the project, and must already be configured for Spinnaker to work.

hal config notification pubsub google enable

Set the google pubsub as enabled

Usage

hal config notification pubsub google enable [parameters]

Parameters

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

hal config notification pubsub google get

Get the specified publisher details for the google pubsub.

Usage

hal config notification pubsub google get PUBLISHER [parameters]

Parameters

PUBLISHER: The name of the publishers to operate on.

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

hal config notification pubsub google list

List the publisher names for the google pubsub.

Usage

hal config notification pubsub google list [parameters]

Parameters

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

hal config notification slack

Manage and view Spinnaker configuration for the slack notification

Usage

hal config notification slack [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 the slack notification as disabled
edit: Edit the slack notification type
enable: Set the slack notification as enabled

hal config notification slack disable

Set the slack notification as disabled

Usage

hal config notification slack disable [parameters]

Parameters

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

hal config notification slack edit

Edit the slack notification type

Usage

hal config notification slack edit [parameters]

Parameters

--base-url: Slack endpoint. Optional, only set if using a compatible API.
--bot-name: The name of your slack bot.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--force-use-incoming-webhook: Force usage of incoming webhooks endpoint for slack. Optional, only set if using a compatible API.
--no-validate: (Default: false) Skip validation.
--token: (Sensitive data - user will be prompted on standard input) Your slack bot token.

hal config notification slack enable

Set the slack notification as enabled

Usage

hal config notification slack enable [parameters]

Parameters

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

hal config notification twilio

Manage and view Spinnaker configuration for the twilio notification

Usage

hal config notification twilio [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 the twilio notification as disabled
edit: Edit the twilio notification type
enable: Set the twilio notification as enabled

hal config notification twilio disable

Set the twilio notification as disabled

Usage

hal config notification twilio disable [parameters]

Parameters

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

hal config notification twilio edit

Edit the twilio notification type

Usage

hal config notification twilio edit [parameters]

Parameters

--account: Your Twilio account SID.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--from: The phone number from which the SMS will be sent (i.e. +1234-567-8910).
--no-validate: (Default: false) Skip validation.
--token: (Sensitive data - user will be prompted on standard input) Your Twilio auth token.

hal config notification twilio enable

Set the twilio notification as enabled

Usage

hal config notification twilio enable [parameters]

Parameters

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

hal config provider

Configure, validate, and view the specified provider.

Usage

hal config provider [subcommands]

Subcommands

appengine: Manage and view Spinnaker configuration for the appengine provider
aws: Manage and view Spinnaker configuration for the aws provider
azure: Manage and view Spinnaker configuration for the azure provider
cloudfoundry: Manage and view Spinnaker configuration for the cloudfoundry provider
dcos: Manage and view Spinnaker configuration for the dcos provider
docker-registry: Manage and view Spinnaker configuration for the dockerRegistry provider
ecs: Manage and view Spinnaker configuration for the ecs provider
google: Manage and view Spinnaker configuration for the google provider
huaweicloud: Manage and view Spinnaker configuration for the huaweicloud provider
kubernetes: Manage and view Spinnaker configuration for the kubernetes provider
oracle: Manage and view Spinnaker configuration for the oracle provider
tencentcloud: Manage and view Spinnaker configuration for the tencentcloud provider

hal config provider appengine

The App Engine provider is used to deploy resources to any number of App Engine applications. To get started with App Engine, visit https://cloud.google.com/appengine/docs/ . For more information on how to configure individual accounts, please read the documentation under hal config provider appengine account -h.

Usage

hal config provider appengine [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the appengine provider’s account
disable: Set the appengine provider as disabled
edit: Edit Spinnaker’s app engine configuration.
enable: Set the appengine provider as enabled

hal config provider appengine account

An account in the App Engine provider refers to a single App Engine application. Spinnaker assumes that your App Engine application already exists. You can create an application in your Google Cloud Platform project by running gcloud app create --region <region>.

Usage

hal config provider appengine account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the account to operate on.

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

Subcommands

add: Add an account to the appengine provider.
delete: Delete a specific appengine account by name.
edit: Edit an account in the appengine provider.
get: Get the specified account details for the appengine provider.
list: List the account names for the appengine provider.

hal config provider appengine account add

Add an account to the appengine provider.

Usage

hal config provider appengine account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--caching-interval-seconds: The interval in seconds at which Spinnaker will poll for updates in your AppEngine clusters.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--gcloud-release-track: The gcloud release track (ALPHA, BETA, or STABLE) that Spinnaker will use when deploying to App Engine.
--git-https-password: (Sensitive data - user will be prompted on standard input) A password to be used when connecting with a remote git repository server over HTTPS.
--git-https-username: A username to be used when connecting with a remote git repository server over HTTPS.
--github-oauth-access-token: (Sensitive data - user will be prompted on standard input) An OAuth token provided by Github for connecting to a git repository over HTTPS. See https://help.github.com/articles/creating-an-access-token-for-command-line-use for more information.
--json-path: The path to a JSON service account that Spinnaker will use as credentials. This is only needed if Spinnaker is not deployed on a Google Compute Engine VM, or needs permissions not afforded to the VM it is running on. See https://cloud.google.com/compute/docs/access/service-accounts for more information.
--local-repository-directory: (Default: /var/tmp/clouddriver) A local directory to be used to stage source files for App Engine deployments within Spinnaker’s Clouddriver microservice.
--no-validate: (Default: false) Skip validation.
--omit-services: A list of regular expressions. Any service matching one of these regexes will be ignored by Spinnaker.
--omit-versions: A list of regular expressions. Any version matching one of these regexes will be ignored by Spinnaker.
--project: (Required) The Google Cloud Platform project this Spinnaker account will manage.
--read-permissions: (Default: []) A user must have at least one of these roles in order to view this account’s cloud resources.
--required-group-membership: (Default: []) A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--services: A list of regular expressions. Any service matching one of these regexes will be indexed by Spinnaker.
--ssh-known-hosts-file-path: The path to a known_hosts file to be used when connecting with a remote git repository over SSH.
--ssh-private-key-file-path: The path to an SSH private key to be used when connecting with a remote git repository over SSH.
--ssh-private-key-passphrase: (Sensitive data - user will be prompted on standard input) The passphrase to an SSH private key to be used when connecting with a remote git repository over SSH.
--ssh-trust-unknown-hosts: (Default: false) Enabling this flag will allow Spinnaker to connect with a remote git repository over SSH without verifying the server’s IP address against a known_hosts file.
--versions: A list of regular expressions. Any version matching one of these regexes will be indexed by Spinnaker.
--write-permissions: (Default: []) A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider appengine account delete

Delete a specific appengine account by name.

Usage

hal config provider appengine account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider appengine account edit

Edit an account in the appengine provider.

Usage

hal config provider appengine account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--add-read-permission: Add this permission to the list of read permissions.
--add-required-group-membership: Add this group to the list of required group memberships.
--add-write-permission: Add this permission to the list of write permissions.
--caching-interval-seconds: The interval in seconds at which Spinnaker will poll for updates in your AppEngine clusters.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--gcloud-release-track: The gcloud release track (ALPHA, BETA, or STABLE) that Spinnaker will use when deploying to App Engine.
--git-https-password: (Sensitive data - user will be prompted on standard input) A password to be used when connecting with a remote git repository server over HTTPS.
--git-https-username: A username to be used when connecting with a remote git repository server over HTTPS.
--github-oauth-access-token: (Sensitive data - user will be prompted on standard input) An OAuth token provided by Github for connecting to a git repository over HTTPS. See https://help.github.com/articles/creating-an-access-token-for-command-line-use for more information.
--json-path: The path to a JSON service account that Spinnaker will use as credentials. This is only needed if Spinnaker is not deployed on a Google Compute Engine VM, or needs permissions not afforded to the VM it is running on. See https://cloud.google.com/compute/docs/access/service-accounts for more information.
--local-repository-directory: A local directory to be used to stage source files for App Engine deployments within Spinnaker’s Clouddriver microservice.
--no-validate: (Default: false) Skip validation.
--omit-services: A list of regular expressions. Any service matching one of these regexes will be ignored by Spinnaker.
--omit-versions: A list of regular expressions. Any version matching one of these regexes will be ignored by Spinnaker.
--project: The Google Cloud Platform project this Spinnaker account will manage.
--read-permissions: A user must have at least one of these roles in order to view this account’s cloud resources.
--remove-read-permission: Remove this permission from the list of read permissions.
--remove-required-group-membership: Remove this group from the list of required group memberships.
--remove-write-permission: Remove this permission to from list of write permissions.
--required-group-membership: A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--services: A list of regular expressions. Any service matching one of these regexes will be indexed by Spinnaker.
--ssh-known-hosts-file-path: The path to a known_hosts file to be used when connecting with a remote git repository over SSH.
--ssh-private-key-file-path: The path to an SSH private key to be used when connecting with a remote git repository over SSH.
--ssh-private-key-passphrase: (Sensitive data - user will be prompted on standard input) The passphrase to an SSH private key to be used when connecting with a remote git repository over SSH.
--ssh-trust-unknown-hosts: Enabling this flag will allow Spinnaker to connect with a remote git repository over SSH without verifying the server’s IP address against a known_hosts file.
--versions: A list of regular expressions. Any version matching one of these regexes will be indexed by Spinnaker.
--write-permissions: A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider appengine account get

Get the specified account details for the appengine provider.

Usage

hal config provider appengine account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider appengine account list

List the account names for the appengine provider.

Usage

hal config provider appengine account list [parameters]

Parameters

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

hal config provider appengine disable

Set the appengine provider as disabled

Usage

hal config provider appengine disable [parameters]

Parameters

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

hal config provider appengine edit

Edit Spinnaker’s app engine configuration.

Usage

hal config provider appengine edit [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--gcloudPath: The path to the gcloud executable on the machine running clouddriver.
--no-validate: (Default: false) Skip validation.

hal config provider appengine enable

Set the appengine provider as enabled

Usage

hal config provider appengine enable [parameters]

Parameters

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

hal config provider aws

Manage and view Spinnaker configuration for the aws provider

Usage

hal config provider aws [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the aws provider’s account
bakery: Manage and view Spinnaker configuration for the aws provider’s image bakery configuration.
disable: Set the aws provider as disabled
edit: Set provider-wide properties for the AWS provider
enable: Set the aws provider as enabled
features: Manage and view Spinnaker configuration for the aws features configuration.

hal config provider aws account

Manage and view Spinnaker configuration for the aws provider’s account

Usage

hal config provider aws account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the account to operate on.

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

Subcommands

add: Add an account to the aws provider.
delete: Delete a specific aws account by name.
edit: Edit an account in the aws provider.
get: Get the specified account details for the aws provider.
list: List the account names for the aws provider.

hal config provider aws account add

Add an account to the aws provider.

Usage

hal config provider aws account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--account-id: (Required) Your AWS account ID to manage. See http://docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html for more information.
--assume-role: (Required) If set, Halyard will configure a credentials provider that uses AWS Security Token Service to assume the specified role.

Example: “user/spinnaker” or “role/spinnakerManaged”

--default-key-pair: Provide the name of the AWS key-pair to use. See http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html for more information.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--discovery: The endpoint your Eureka discovery system is reachable at. See https://github.com/Netflix/eureka for more information.

Example: http://{{region}}.eureka.url.to.use:8080/eureka-server/v2

Using {{region}} will make Spinnaker use AWS regions in the hostname to access discovery so that you can have discovery for multiple regions.

--edda: The endpoint Edda is reachable at. Edda is not a hard dependency of Spinnaker, but is helpful for reducing the request volume against AWS. See https://github.com/Netflix/edda for more information.
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--launching-lifecycle-hook-default-result: (Default: ABANDON) Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON.
--launching-lifecycle-hook-heartbeat-timeout-seconds: (Default: 3600) Set the heartbeat timeout for the lifecycle hook. Instances can " + “remain in a wait state for a finite period of time. The default is one hour (3600 seconds).
--launching-lifecycle-hook-notification-target-arn: The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic.
--launching-lifecycle-hook-role-arn: The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.
--no-validate: (Default: false) Skip validation.
--read-permissions: (Default: []) A user must have at least one of these roles in order to view this account’s cloud resources.
--regions: (Default: []) The AWS regions this Spinnaker account will manage.
--required-group-membership: (Default: []) A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--terminating-lifecycle-hook-default-result: (Default: ABANDON) Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON.
--terminating-lifecycle-hook-heartbeat-timeout-seconds: (Default: 3600) Set the heartbeat timeout for the lifecycle hook. Instances can " + “remain in a wait state for a finite period of time. The default is one hour (3600 seconds).
--terminating-lifecycle-hook-notification-target-arn: The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic.
--terminating-lifecycle-hook-role-arn: The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.
--write-permissions: (Default: []) A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider aws account delete

Delete a specific aws account by name.

Usage

hal config provider aws account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider aws account edit

Edit an account in the aws provider.

Usage

hal config provider aws account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--account-id: Your AWS account ID to manage. See http://docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html for more information.
--add-read-permission: Add this permission to the list of read permissions.
--add-region: Add this region to the list of managed regions.
--add-required-group-membership: Add this group to the list of required group memberships.
--add-write-permission: Add this permission to the list of write permissions.
--assume-role: If set, Halyard will configure a credentials provider that uses AWS Security Token Service to assume the specified role.

Example: “user/spinnaker” or “role/spinnakerManaged”

--default-key-pair: Provide the name of the AWS key-pair to use. See http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html for more information.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--discovery: The endpoint your Eureka discovery system is reachable at. See https://github.com/Netflix/eureka for more information.

Example: http://{{region}}.eureka.url.to.use:8080/eureka-server/v2

Using {{region}} will make Spinnaker use AWS regions in the hostname to access discovery so that you can have discovery for multiple regions.

--edda: The endpoint Edda is reachable at. Edda is not a hard dependency of Spinnaker, but is helpful for reducing the request volume against AWS. See https://github.com/Netflix/edda for more information.
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--launching-lifecycle-hook-default-result: (Default: ABANDON) Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON.
--launching-lifecycle-hook-heartbeat-timeout-seconds: (Default: 3600) Set the heartbeat timeout for the lifecycle hook. Instances can " + “remain in a wait state for a finite period of time. The default is one hour (3600 seconds).
--launching-lifecycle-hook-notification-target-arn: The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic.
--launching-lifecycle-hook-role-arn: The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.
--no-validate: (Default: false) Skip validation.
--read-permissions: A user must have at least one of these roles in order to view this account’s cloud resources.
--regions: The AWS regions this Spinnaker account will manage.
--remove-read-permission: Remove this permission from the list of read permissions.
--remove-region: Remove this region from the list of managed regions.
--remove-required-group-membership: Remove this group from the list of required group memberships.
--remove-write-permission: Remove this permission to from list of write permissions.
--required-group-membership: A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--terminating-lifecycle-hook-default-result: (Default: ABANDON) Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON.
--terminating-lifecycle-hook-heartbeat-timeout-seconds: (Default: 3600) Set the heartbeat timeout for the lifecycle hook. Instances can " + “remain in a wait state for a finite period of time. The default is one hour (3600 seconds).
--terminating-lifecycle-hook-notification-target-arn: The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic.
--terminating-lifecycle-hook-role-arn: The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.
--write-permissions: A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider aws account get

Get the specified account details for the aws provider.

Usage

hal config provider aws account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider aws account list

List the account names for the aws provider.

Usage

hal config provider aws account list [parameters]

Parameters

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

hal config provider aws bakery

Manage and view Spinnaker configuration for the aws provider’s image bakery configuration.

Usage

hal config provider aws bakery [parameters] [subcommands]

Parameters

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

Subcommands

edit: Edit the aws provider’s bakery default options.

hal config provider aws bakery edit

Edit the aws provider’s bakery default options.

Usage

hal config provider aws bakery edit [parameters]

Parameters

--aws-access-key: The default access key used to communicate with AWS.
--aws-associate-public-ip-address: If using a non-default VPC, public IP addresses are not provided by default. If this is enabled, your new instance will get a Public IP.
--aws-secret-key: (Sensitive data - user will be prompted on standard input) The secret key used to communicate with AWS.
--aws-subnet-id: If using VPC, the default ID of the subnet, such as subnet-12345def, where Packer will launch the EC2 instance. This field is required if you are using a non-default VPC.
--aws-vpc-id: If launching into a VPC subnet, Packer needs the VPC ID in order to create a temporary security group within the VPC. Requires subnet_id to be set. If this default value is left blank, Packer will try to get the VPC ID from the subnet_id.
--default-virtualization-type: The default type of virtualization for the AMI you are building. This option must match the supported virtualization type of source_ami. Can be pv or hvm.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--template-file: This is the name of the packer template that will be used to bake images from this base image. The template file must be found in this list https://github.com/spinnaker/rosco/tree/master/rosco-web/config/packer , or supplied as described here: https://spinnaker.io/setup/bakery/

hal config provider aws disable

Set the aws provider as disabled

Usage

hal config provider aws disable [parameters]

Parameters

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

hal config provider aws edit

The AWS provider requires a central “Managing Account” to authenticate on behalf of other AWS accounts, or act as your sole, credential-based account. Since this configuration, as well as some defaults, span all AWS accounts, it is generally required to edit the AWS provider using this command.

Usage

hal config provider aws edit [parameters]

Parameters

--access-key-id: Your AWS Access Key ID. If not provided, Halyard/Spinnaker will try to find AWS credentials as described at http://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html#credentials-default . Note that if you are baking AMI’s via Rosco, you may also need to set the access key on the AWS bakery default options.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--secret-access-key: (Sensitive data - user will be prompted on standard input) Your AWS Secret Key.. Note that if you are baking AMI’s via Rosco, you may also need to set the secret key on the AWS bakery default options.

hal config provider aws enable

Set the aws provider as enabled

Usage

hal config provider aws enable [parameters]

Parameters

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

hal config provider aws features

Manage and view Spinnaker configuration for the aws features configuration.

Usage

hal config provider aws features [parameters] [subcommands]

Parameters

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

Subcommands

edit: Edit features for AWS provider

hal config provider aws features edit

Edit features for AWS provider

Usage

hal config provider aws features edit [parameters]

Parameters

--cloud-formation: (Required) Enable CloudFormation support for AWS.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.

hal config provider azure

Manage and view Spinnaker configuration for the azure provider

Usage

hal config provider azure [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the azure provider’s account
bakery: Manage and view Spinnaker configuration for the azure provider’s image bakery configuration.
disable: Set the azure provider as disabled
enable: Set the azure provider as enabled

hal config provider azure account

Manage and view Spinnaker configuration for the azure provider’s account

Usage

hal config provider azure account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the account to operate on.

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

Subcommands

add: Add an account to the azure provider.
delete: Delete a specific azure account by name.
edit: Edit an account in the azure provider.
get: Get the specified account details for the azure provider.
list: List the account names for the azure provider.

hal config provider azure account add

Add an account to the azure provider.

Usage

hal config provider azure account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--app-key: (Required) (Sensitive data - user will be prompted on standard input) The appKey (password) of your service principal.
--client-id: (Required) The clientId (also called appId) of your service principal.
--default-key-vault: (Required) The name of a KeyVault that contains the user name, password, and ssh public key used to create VMs
--default-resource-group: (Required) The default resource group to contain any non-application specific resources.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--no-validate: (Default: false) Skip validation.
--object-id: The objectId of your service principal. This is only required if using Packer to bake Windows images.
--packer-resource-group: The resource group to use if baking images with Packer.
--packer-storage-account: The storage account to use if baking images with Packer.
--read-permissions: (Default: []) A user must have at least one of these roles in order to view this account’s cloud resources.
--regions: (Default: [westus, eastus]) The Azure regions this Spinnaker account will manage.
--required-group-membership: (Default: []) A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--subscription-id: (Required) The subscriptionId that your service principal is assigned to.
--tenant-id: (Required) The tenantId that your service principal is assigned to.
--useSshPublicKey: (Default: true) Whether to use SSH public key to provision the linux vm. The default value is true which means using the ssh public key. Setting it to false means using the password instead.
--write-permissions: (Default: []) A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider azure account delete

Delete a specific azure account by name.

Usage

hal config provider azure account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider azure account edit

Edit an account in the azure provider.

Usage

hal config provider azure account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--add-read-permission: Add this permission to the list of read permissions.
--add-required-group-membership: Add this group to the list of required group memberships.
--add-write-permission: Add this permission to the list of write permissions.
--app-key: (Sensitive data - user will be prompted on standard input) The appKey (password) of your service principal.
--client-id: The clientId (also called appId) of your service principal.
--default-key-vault: The name of a KeyVault that contains the user name, password, and ssh public key used to create VMs
--default-resource-group: The default resource group to contain any non-application specific resources.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--no-validate: (Default: false) Skip validation.
--object-id: The objectId of your service principal. This is only required if using Packer to bake Windows images.
--packer-resource-group: The resource group to use if baking images with Packer.
--packer-storage-account: The storage account to use if baking images with Packer.
--read-permissions: A user must have at least one of these roles in order to view this account’s cloud resources.
--regions: The Azure regions this Spinnaker account will manage.
--remove-read-permission: Remove this permission from the list of read permissions.
--remove-required-group-membership: Remove this group from the list of required group memberships.
--remove-write-permission: Remove this permission to from list of write permissions.
--required-group-membership: A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--subscription-id: The subscriptionId that your service principal is assigned to.
--tenant-id: The tenantId that your service principal is assigned to.
--useSshPublicKey: Whether to use SSH public key to provision the linux vm. The default value is true which means using the ssh public key. Setting it to false means using the password instead.
--write-permissions: A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider azure account get

Get the specified account details for the azure provider.

Usage

hal config provider azure account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider azure account list

List the account names for the azure provider.

Usage

hal config provider azure account list [parameters]

Parameters

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

hal config provider azure bakery

Manage and view Spinnaker configuration for the azure provider’s image bakery configuration.

Usage

hal config provider azure bakery [parameters] [subcommands]

Parameters

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

Subcommands

base-image: Manage and view Spinnaker configuration for the azure provider’s base image.
edit: Edit the azure provider’s bakery default options.

hal config provider azure bakery base-image

Manage and view Spinnaker configuration for the azure provider’s base image.

Usage

hal config provider azure bakery base-image [parameters] [subcommands]

Parameters

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

Subcommands

add: Add a base image for the azure provider’s bakery.
delete: Delete a specific azure base image by name.
edit: Edit a base image for the azure provider’s bakery.
get: Get the specified base image details for the azure provider.
list: List the base image names for the azure provider.

hal config provider azure bakery base-image add

Add a base image for the azure provider’s bakery.

Usage

hal config provider azure bakery base-image add BASE-IMAGE [parameters]

Parameters

BASE-IMAGE: The name of the base image to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--detailed-description: A long description to help human operators identify the image.
--image-version: The version of your base image. This defaults to ’latest’ if not specified.
--no-validate: (Default: false) Skip validation.
--offer: (Required) The offer for your base image. See https://aka.ms/azspinimage to get a list of images.
--package-type: This is used to help Spinnaker’s bakery download the build artifacts you supply it with. For example, specifying ‘deb’ indicates that your artifacts will need to be fetched from a debian repository.
--publisher: (Required) The Publisher name for your base image. See https://aka.ms/azspinimage to get a list of images.
--short-description: A short description to help human operators identify the image.
--sku: (Required) The SKU for your base image. See https://aka.ms/azspinimage to get a list of images.
--template-file: This is the name of the packer template that will be used to bake images from this base image. The template file must be found in this list https://github.com/spinnaker/rosco/tree/master/rosco-web/config/packer , or supplied as described here: https://spinnaker.io/setup/bakery/

hal config provider azure bakery base-image delete

Delete a specific azure base image by name.

Usage

hal config provider azure bakery base-image delete BASE-IMAGE [parameters]

Parameters

BASE-IMAGE: The name of the base image to operate on.

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

hal config provider azure bakery base-image edit

Edit a base image for the azure provider’s bakery.

Usage

hal config provider azure bakery base-image edit BASE-IMAGE [parameters]

Parameters

BASE-IMAGE: The name of the base image to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--detailed-description: A long description to help human operators identify the image.
--id: This is the identifier used by your cloud to find this base image.
--image-version: The version of your base image. This defaults to ’latest’ if not specified.
--no-validate: (Default: false) Skip validation.
--offer: The offer for your base image. See https://aka.ms/azspinimage to get a list of images.
--package-type: This is used to help Spinnaker’s bakery download the build artifacts you supply it with. For example, specifying ‘deb’ indicates that your artifacts will need to be fetched from a debian repository.
--publisher: The Publisher name for your base image. See https://aka.ms/azspinimage to get a list of images.
--short-description: A short description to help human operators identify the image.
--sku: The SKU for your base image. See https://aka.ms/azspinimage to get a list of images.
--template-file: This is the name of the packer template that will be used to bake images from this base image. The template file must be found in this list https://github.com/spinnaker/rosco/tree/master/rosco-web/config/packer , or supplied as described here: https://spinnaker.io/setup/bakery/

hal config provider azure bakery base-image get

Get the specified base image details for the azure provider.

Usage

hal config provider azure bakery base-image get BASE-IMAGE [parameters]

Parameters

BASE-IMAGE: The name of the base image to operate on.

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

hal config provider azure bakery base-image list

List the base image names for the azure provider.

Usage

hal config provider azure bakery base-image list [parameters]

Parameters

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

hal config provider azure bakery edit

Edit the azure provider’s bakery default options.

Usage

hal config provider azure bakery edit [parameters]

Parameters

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

hal config provider azure disable

Set the azure provider as disabled

Usage

hal config provider azure disable [parameters]

Parameters

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

hal config provider azure enable

Set the azure provider as enabled

Usage

hal config provider azure enable [parameters]

Parameters

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

hal config provider cloudfoundry

Manage and view Spinnaker configuration for the cloudfoundry provider

Usage

hal config provider cloudfoundry [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the cloudfoundry provider’s account
disable: Set the cloudfoundry provider as disabled
enable: Set the cloudfoundry provider as enabled

hal config provider cloudfoundry account

Manage and view Spinnaker configuration for the cloudfoundry provider’s account

Usage

hal config provider cloudfoundry account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the account to operate on.

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

Subcommands

add: Add an account to the cloudfoundry provider.
delete: Delete a specific cloudfoundry account by name.
edit: Edit an account in the cloudfoundry provider.
get: Get the specified account details for the cloudfoundry provider.
list: List the account names for the cloudfoundry provider.

hal config provider cloudfoundry account add

Add an account to the cloudfoundry provider.

Usage

hal config provider cloudfoundry account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--api-host, --api: (Required) Host of the CloudFoundry Foundation API endpoint ie. api.sys.somesystem.com
--apps-manager-url, --apps-manager-uri, --appsManagerUri: HTTP(S) URL of the Apps Manager application for the CloudFoundry Foundation ie. [https://apps.sys.somesystem.com](https://apps.sys.somesystem.com)
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--metrics-url, --metrics-uri, --metricsUri: HTTP(S) URL of the metrics application for the CloudFoundry Foundation ie. [https://metrics.sys.somesystem.com](https://metrics.sys.somesystem.com)
--no-validate: (Default: false) Skip validation.
--password: (Required) Password for the account to use on for this CloudFoundry Foundation
--read-permissions: (Default: []) A user must have at least one of these roles in order to view this account’s cloud resources.
--required-group-membership: (Default: []) A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--skip-ssl-validation: (Default: false) Skip SSL server certificate validation of the API endpoint
--user: (Required) User name for the account to use on for this CloudFoundry Foundation
--write-permissions: (Default: []) A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider cloudfoundry account delete

Delete a specific cloudfoundry account by name.

Usage

hal config provider cloudfoundry account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider cloudfoundry account edit

Edit an account in the cloudfoundry provider.

Usage

hal config provider cloudfoundry account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--add-read-permission: Add this permission to the list of read permissions.
--add-required-group-membership: Add this group to the list of required group memberships.
--add-write-permission: Add this permission to the list of write permissions.
--api-host, --api: Host of the CloudFoundry Foundation API endpoint ie. api.sys.somesystem.com
--apps-manager-url, --apps-manager-uri, --appsManagerUri: HTTP(S) URL of the Apps Manager application for the CloudFoundry Foundation ie. [https://apps.sys.somesystem.com](https://apps.sys.somesystem.com)
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--metrics-url, --metrics-uri, --metricsUri: HTTP(S) URL of the metrics application for the CloudFoundry Foundation ie. [https://metrics.sys.somesystem.com](https://metrics.sys.somesystem.com)
--no-validate: (Default: false) Skip validation.
--password: Password for the account to use on for this CloudFoundry Foundation
--read-permissions: A user must have at least one of these roles in order to view this account’s cloud resources.
--remove-read-permission: Remove this permission from the list of read permissions.
--remove-required-group-membership: Remove this group from the list of required group memberships.
--remove-write-permission: Remove this permission to from list of write permissions.
--required-group-membership: A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--skip-ssl-validation: (Default: false) Skip SSL server certificate validation of the API endpoint
--user: User name for the account to use on for this CloudFoundry Foundation
--write-permissions: A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider cloudfoundry account get

Get the specified account details for the cloudfoundry provider.

Usage

hal config provider cloudfoundry account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider cloudfoundry account list

List the account names for the cloudfoundry provider.

Usage

hal config provider cloudfoundry account list [parameters]

Parameters

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

hal config provider cloudfoundry disable

Set the cloudfoundry provider as disabled

Usage

hal config provider cloudfoundry disable [parameters]

Parameters

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

hal config provider cloudfoundry enable

Set the cloudfoundry provider as enabled

Usage

hal config provider cloudfoundry enable [parameters]

Parameters

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

hal config provider cloudrun

The Cloud Run provider is used to deploy resources to any number of Cloud Run applications. To get started with Cloud Run, visit https://cloud.google.com/run/docs/ . For more information on how to configure individual accounts, please read the documentation under hal config provider cloudrun account -h.

Usage

hal config provider cloudrun [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the cloudrun provider’s account
disable: Set the cloudrun provider as disabled
edit: Edit Spinnaker’s cloud run configuration.
enable: Set the cloudrun provider as enabled

hal config provider cloudrun account

An account in the Cloud Run provider refers to a single Cloud Run application. Spinnaker assumes that your Cloud Run application already exists. You can create an application in your Google Cloud Platform project by running gcloud app create --region <region>.

Usage

hal config provider cloudrun account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the account to operate on.

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

Subcommands

add: Add an account to the cloudrun provider.
delete: Delete a specific cloudrun account by name.
edit: Edit an account in the cloudrun provider.
get: Get the specified account details for the cloudrun provider.
list: List the account names for the cloudrun provider.

hal config provider cloudrun account add

Add an account to the cloudrun provider.

Usage

hal config provider cloudrun account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--caching-interval-seconds: The interval in seconds at which Spinnaker will poll for updates in your CloudRun clusters.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--gcloud-release-track: The gcloud release track (ALPHA, BETA, or STABLE) that Spinnaker will use when deploying to Cloud Run.
--json-path: The path to a JSON service account that Spinnaker will use as credentials. This is only needed if Spinnaker is not deployed on a Google Compute Engine VM, or needs permissions not afforded to the VM it is running on. See https://cloud.google.com/compute/docs/access/service-accounts for more information.
--local-repository-directory: (Default: /var/tmp/clouddriver) A local directory to be used to stage source files for Cloud Run deployments within Spinnaker’s Clouddriver microservice.
--no-validate: (Default: false) Skip validation.
--omit-services: A list of regular expressions. Any service matching one of these regexes will be ignored by Spinnaker.
--omit-versions: A list of regular expressions. Any version matching one of these regexes will be ignored by Spinnaker.
--project: (Required) The Google Cloud Platform project this Spinnaker account will manage.
--read-permissions: (Default: []) A user must have at least one of these roles in order to view this account’s cloud resources.
--required-group-membership: (Default: []) A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--services: A list of regular expressions. Any service matching one of these regexes will be indexed by Spinnaker.
--ssh-known-hosts-file-path: The path to a known_hosts file to be used when connecting with a remote git repository over SSH.
--ssh-private-key-file-path: The path to an SSH private key to be used when connecting with a remote git repository over SSH.
--ssh-private-key-passphrase: (Sensitive data - user will be prompted on standard input) The passphrase to an SSH private key to be used when connecting with a remote git repository over SSH.
--ssh-trust-unknown-hosts: (Default: false) Enabling this flag will allow Spinnaker to connect with a remote git repository over SSH without verifying the server’s IP address against a known_hosts file.
--versions: A list of regular expressions. Any version matching one of these regexes will be indexed by Spinnaker.
--write-permissions: (Default: []) A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider cloudrun account delete

Delete a specific cloudrun account by name.

Usage

hal config provider cloudrun account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider cloudrun account edit

Edit an account in the cloudrun provider.

Usage

hal config provider cloudrun account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--add-read-permission: Add this permission to the list of read permissions.
--add-required-group-membership: Add this group to the list of required group memberships.
--add-write-permission: Add this permission to the list of write permissions.
--caching-interval-seconds: The interval in seconds at which Spinnaker will poll for updates in your CloudRun clusters.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--gcloud-release-track: The gcloud release track (ALPHA, BETA, or STABLE) that Spinnaker will use when deploying to Cloud Run.
--json-path: The path to a JSON service account that Spinnaker will use as credentials. This is only needed if Spinnaker is not deployed on a Google Compute Engine VM, or needs permissions not afforded to the VM it is running on. See https://cloud.google.com/compute/docs/access/service-accounts for more information.
--local-repository-directory: A local directory to be used to stage source files for Cloud Run deployments within Spinnaker’s Clouddriver microservice.
--no-validate: (Default: false) Skip validation.
--omit-services: A list of regular expressions. Any service matching one of these regexes will be ignored by Spinnaker.
--omit-versions: A list of regular expressions. Any version matching one of these regexes will be ignored by Spinnaker.
--project: The Google Cloud Platform project this Spinnaker account will manage.
--read-permissions: A user must have at least one of these roles in order to view this account’s cloud resources.
--remove-read-permission: Remove this permission from the list of read permissions.
--remove-required-group-membership: Remove this group from the list of required group memberships.
--remove-write-permission: Remove this permission to from list of write permissions.
--required-group-membership: A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--services: A list of regular expressions. Any service matching one of these regexes will be indexed by Spinnaker.
--ssh-known-hosts-file-path: The path to a known_hosts file to be used when connecting with a remote git repository over SSH.
--ssh-private-key-file-path: The path to an SSH private key to be used when connecting with a remote git repository over SSH.
--ssh-private-key-passphrase: (Sensitive data - user will be prompted on standard input) The passphrase to an SSH private key to be used when connecting with a remote git repository over SSH.
--ssh-trust-unknown-hosts: Enabling this flag will allow Spinnaker to connect with a remote git repository over SSH without verifying the server’s IP address against a known_hosts file.
--versions: A list of regular expressions. Any version matching one of these regexes will be indexed by Spinnaker.
--write-permissions: A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider cloudrun account get

Get the specified account details for the cloudrun provider.

Usage

hal config provider cloudrun account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider cloudrun account list

List the account names for the cloudrun provider.

Usage

hal config provider cloudrun account list [parameters]

Parameters

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

hal config provider cloudrun disable

Set the cloudrun provider as disabled

Usage

hal config provider cloudrun disable [parameters]

Parameters

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

hal config provider cloudrun edit

Edit Spinnaker’s cloud run configuration.

Usage

hal config provider cloudrun edit [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--gcloudPath: The path to the gcloud executable on the machine running clouddriver.
--no-validate: (Default: false) Skip validation.

hal config provider cloudrun enable

Set the cloudrun provider as enabled

Usage

hal config provider cloudrun enable [parameters]

Parameters

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

hal config provider dcos

Manage and view Spinnaker configuration for the dcos provider

Usage

hal config provider dcos [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the dcos provider’s account
cluster: Manage and view Spinnaker configuration for the dcos provider’s cluster
disable: Set the dcos provider as disabled
enable: Set the dcos provider as enabled

hal config provider dcos account

Manage and view Spinnaker configuration for the dcos provider’s account

Usage

hal config provider dcos account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the account to operate on.

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

Subcommands

add: Add an account to the dcos provider.
delete: Delete a specific dcos account by name.
edit: Edit an account in the dcos provider.
get: Get the specified account details for the dcos provider.
list: List the account names for the dcos provider.

hal config provider dcos account add

Add an account to the dcos provider.

Usage

hal config provider dcos account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--cluster: (Required) Reference to the name of the cluster from the set of clusters defined for this provider
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--docker-registries: (Default: []) (Required) Provide the list of docker registries to use with this DC/OS account
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--no-validate: (Default: false) Skip validation.
--password: Password for a user account
--read-permissions: (Default: []) A user must have at least one of these roles in order to view this account’s cloud resources.
--required-group-membership: (Default: []) A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--service-key-file: Path to a file containing the secret key for service account authentication
--uid: (Required) User or service account identifier
--write-permissions: (Default: []) A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider dcos account delete

Delete a specific dcos account by name.

Usage

hal config provider dcos account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider dcos account edit

Edit an account in the dcos provider.

Usage

hal config provider dcos account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--add-docker-registry: Add this docker registry to the list of docker registries to use as a source of images.
--add-read-permission: Add this permission to the list of read permissions.
--add-required-group-membership: Add this group to the list of required group memberships.
--add-write-permission: Add this permission to the list of write permissions.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--docker-registries: (Default: []) Provide the list of docker registries to use with this DC/OS account
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--no-validate: (Default: false) Skip validation.
--read-permissions: A user must have at least one of these roles in order to view this account’s cloud resources.
--remove-credential: (Default: []) Provide the cluster name and uid of credentials to remove: –remove-credential my-cluster my-user
--remove-docker-registry: Remove this docker registry from the list of docker registries to use as a source of images.
--remove-read-permission: Remove this permission from the list of read permissions.
--remove-required-group-membership: Remove this group from the list of required group memberships.
--remove-write-permission: Remove this permission to from list of write permissions.
--required-group-membership: A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--update-service-credential: (Default: []) A DC/OS cluster service account credential in 3 parts: cluster-name uid serviceKey
--update-user-credential: (Default: []) A DC/OS cluster user credential in 3 parts: cluster-name uid password
--write-permissions: A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider dcos account get

Get the specified account details for the dcos provider.

Usage

hal config provider dcos account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider dcos account list

List the account names for the dcos provider.

Usage

hal config provider dcos account list [parameters]

Parameters

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

hal config provider dcos cluster

Manage and view Spinnaker configuration for the dcos provider’s cluster

Usage

hal config provider dcos cluster CLUSTER [parameters] [subcommands]

Parameters

CLUSTER: The name of the cluster to operate on.

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

Subcommands

add: Manage and view Spinnaker configuration for the dcos provider’s cluster
delete: Delete a specific dcos cluster by name.
edit: Manage and view Spinnaker configuration for the dcos provider’s cluster
get: Get the specified cluster details for the dcos provider.
list: List the cluster names for the dcos provider.

hal config provider dcos cluster add

Manage and view Spinnaker configuration for the dcos provider’s cluster

Usage

hal config provider dcos cluster add CLUSTER [parameters]

Parameters

CLUSTER: The name of the cluster to operate on.

--ca-cert-file: Root certificate file to trust for connections to the cluster
--dcos-url: (Required) URL of the endpoint for the DC/OS cluster’s admin router.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--lb-account-secret: Name of the secret to use for allowing marathon-lb to authenticate with the cluster. Only necessary for clusters with strict or permissive security.
--lb-image: Marathon-lb image to use when creating a load balancer with Spinnaker
--no-validate: (Default: false) Skip validation.
--skip-tls-verify: Set this flag to disable verification of certificates from the cluster (insecure)

hal config provider dcos cluster delete

Delete a specific dcos cluster by name.

Usage

hal config provider dcos cluster delete CLUSTER [parameters]

Parameters

CLUSTER: The name of the cluster to operate on.

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

hal config provider dcos cluster edit

Manage and view Spinnaker configuration for the dcos provider’s cluster

Usage

hal config provider dcos cluster edit CLUSTER [parameters]

Parameters

CLUSTER: The name of the cluster to operate on.

--ca-cert-file: Root certificate file to trust for connections to the cluster
--dcos-url: URL of the endpoint for the DC/OS cluster’s admin router.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--lb-account-secret: Name of the secret to use for allowing marathon-lb to authenticate with the cluster. Only necessary for clusters with strict or permissive security.
--lb-image: Marathon-lb image to use when creating a load balancer with Spinnaker
--no-validate: (Default: false) Skip validation.
--remove-ca-cert-file: (Default: false) Remove the CA certificate file for this cluster
--remove-lb: (Default: false) Remove the load balancer attributes for this cluster
--set-skip-tls-verify: Set this flag to disable verification of certificates from the cluster (insecure)

hal config provider dcos cluster get

Get the specified cluster details for the dcos provider.

Usage

hal config provider dcos cluster get CLUSTER [parameters]

Parameters

CLUSTER: The name of the cluster to operate on.

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

hal config provider dcos cluster list

List the cluster names for the dcos provider.

Usage

hal config provider dcos cluster list CLUSTER [parameters]

Parameters

CLUSTER: The name of the cluster to operate on.

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

hal config provider dcos disable

Set the dcos provider as disabled

Usage

hal config provider dcos disable [parameters]

Parameters

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

hal config provider dcos enable

Set the dcos provider as enabled

Usage

hal config provider dcos enable [parameters]

Parameters

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

hal config provider docker-registry

Manage and view Spinnaker configuration for the dockerRegistry provider

Usage

hal config provider docker-registry [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the dockerRegistry provider’s account
disable: Set the dockerRegistry provider as disabled
enable: Set the dockerRegistry provider as enabled

hal config provider docker-registry account

Manage and view Spinnaker configuration for the dockerRegistry provider’s account

Usage

hal config provider docker-registry account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the account to operate on.

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

Subcommands

add: Add an account to the dockerRegistry provider.
delete: Delete a specific dockerRegistry account by name.
edit: Edit an account in the dockerRegistry provider.
get: Get the specified account details for the dockerRegistry provider.
list: List the account names for the dockerRegistry provider.

hal config provider docker-registry account add

Add an account to the dockerRegistry provider.

Usage

hal config provider docker-registry account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--address: (Default: gcr.io) (Required) The registry address you want to pull and deploy images from. For example:

index.docker.io - DockerHub quay.io - Quay gcr.io - Google Container Registry (GCR) [us|eu|asia].gcr.io - Regional GCR localhost - Locally deployed registry

--cache-interval-seconds: (Default: 30) How many seconds elapse between polling your docker registry. Certain registries are sensitive to over-polling, and larger intervals (e.g. 10 minutes = 600 seconds) are desirable if you’re seeing rate limiting.
--cache-threads: (Default: 1) How many threads to cache all provided repos on. Really only useful if you have a ton of repos.
--client-timeout-millis: (Default: 60000) Timeout time in milliseconds for this repository.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--email: (Default: fake.email@spinnaker.io) Your docker registry email (often this only needs to be well-formed, rather than be a real address)
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--insecure-registry: (Default: false) Treat the docker registry as insecure (don’t validate the ssl cert).
--no-validate: (Default: false) Skip validation.
--paginate-size: (Default: 100) Paginate size for the docker repository _catalog endpoint.
--password: (Sensitive data - user will be prompted on standard input) Your docker registry password
--password-command: Command to retrieve docker token/password, commands must be available in environment
--password-file: The path to a file containing your docker password in plaintext (not a docker/config.json file)
--read-permissions: (Default: []) A user must have at least one of these roles in order to view this account’s cloud resources.
--repositories: (Default: []) An optional list of repositories to cache images from. If not provided, Spinnaker will attempt to read accessible repositories from the registries _catalog endpoint
--required-group-membership: (Default: []) A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--sort-tags-by-date: (Default: false) Sort tags by creation date. Not recommended for use with large registries; sorting performance scales poorly due to limitations of the Docker V2 API.
--track-digests: (Default: false) Track digest changes. This is not recommended as it consumes a high QPM, and most registries are flaky.
--username: Your docker registry username
--write-permissions: (Default: []) A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider docker-registry account delete

Delete a specific dockerRegistry account by name.

Usage

hal config provider docker-registry account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider docker-registry account edit

Edit an account in the dockerRegistry provider.

Usage

hal config provider docker-registry account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--add-read-permission: Add this permission to the list of read permissions.
--add-repository: Add this repository to the list of repositories to cache images from.
--add-required-group-membership: Add this group to the list of required group memberships.
--add-write-permission: Add this permission to the list of write permissions.
--address: The registry address you want to pull and deploy images from. For example:

index.docker.io - DockerHub quay.io - Quay gcr.io - Google Container Registry (GCR) [us|eu|asia].gcr.io - Regional GCR localhost - Locally deployed registry

--cache-interval-seconds: How many seconds elapse between polling your docker registry. Certain registries are sensitive to over-polling, and larger intervals (e.g. 10 minutes = 600 seconds) are desirable if you’re seeing rate limiting.
--cache-threads: How many threads to cache all provided repos on. Really only useful if you have a ton of repos.
--client-timeout-millis: Timeout time in milliseconds for this repository.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--email: Your docker registry email (often this only needs to be well-formed, rather than be a real address)
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--insecure-registry: Treat the docker registry as insecure (don’t validate the ssl cert).
--no-validate: (Default: false) Skip validation.
--paginate-size: Paginate size for the docker repository _catalog endpoint.
--password: (Sensitive data - user will be prompted on standard input) Your docker registry password
--password-command: Command to retrieve docker token/password, commands must be available in environment
--password-file: The path to a file containing your docker password in plaintext (not a docker/config.json file)
--read-permissions: A user must have at least one of these roles in order to view this account’s cloud resources.
--remove-read-permission: Remove this permission from the list of read permissions.
--remove-repository: Remove this repository to the list of repositories to cache images from.
--remove-required-group-membership: Remove this group from the list of required group memberships.
--remove-write-permission: Remove this permission to from list of write permissions.
--repositories: (Default: []) An optional list of repositories to cache images from. If not provided, Spinnaker will attempt to read accessible repositories from the registries _catalog endpoint
--required-group-membership: A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--sort-tags-by-date: Sort tags by creation date. Not recommended for use with large registries; sorting performance scales poorly due to limitations of the Docker V2 API.
--track-digests: Track digest changes. This is not recommended as it consumes a high QPM, and most registries are flaky.
--username: Your docker registry username
--write-permissions: A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider docker-registry account get

Get the specified account details for the dockerRegistry provider.

Usage

hal config provider docker-registry account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider docker-registry account list

List the account names for the dockerRegistry provider.

Usage

hal config provider docker-registry account list [parameters]

Parameters

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

hal config provider docker-registry disable

Set the dockerRegistry provider as disabled

Usage

hal config provider docker-registry disable [parameters]

Parameters

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

hal config provider docker-registry enable

Set the dockerRegistry provider as enabled

Usage

hal config provider docker-registry enable [parameters]

Parameters

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

hal config provider ecs

Manage and view Spinnaker configuration for the ecs provider

Usage

hal config provider ecs [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the ecs provider’s account
disable: Set the ecs provider as disabled
enable: Set the ecs provider as enabled

hal config provider ecs account

Manage and view Spinnaker configuration for the ecs provider’s account

Usage

hal config provider ecs account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the account to operate on.

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

Subcommands

add: Add an account to the ecs provider.
delete: Delete a specific ecs account by name.
edit: Edit an account in the ecs provider.
get: Get the specified account details for the ecs provider.
list: List the account names for the ecs provider.

hal config provider ecs account add

Add an account to the ecs provider.

Usage

hal config provider ecs account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--aws-account: (Required) Provide the name of the AWS account associated with this ECS account.See https://github.com/spinnaker/clouddriver/blob/master/clouddriver-ecs/README.md for more information.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--no-validate: (Default: false) Skip validation.
--read-permissions: (Default: []) A user must have at least one of these roles in order to view this account’s cloud resources.
--required-group-membership: (Default: []) A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--write-permissions: (Default: []) A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider ecs account delete

Delete a specific ecs account by name.

Usage

hal config provider ecs account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider ecs account edit

Edit an account in the ecs provider.

Usage

hal config provider ecs account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--add-read-permission: Add this permission to the list of read permissions.
--add-required-group-membership: Add this group to the list of required group memberships.
--add-write-permission: Add this permission to the list of write permissions.
--aws-account: Provide the name of the AWS account associated with this ECS account.See https://github.com/spinnaker/clouddriver/blob/master/clouddriver-ecs/README.md for more information.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--no-validate: (Default: false) Skip validation.
--read-permissions: A user must have at least one of these roles in order to view this account’s cloud resources.
--remove-read-permission: Remove this permission from the list of read permissions.
--remove-required-group-membership: Remove this group from the list of required group memberships.
--remove-write-permission: Remove this permission to from list of write permissions.
--required-group-membership: A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--write-permissions: A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider ecs account get

Get the specified account details for the ecs provider.

Usage

hal config provider ecs account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider ecs account list

List the account names for the ecs provider.

Usage

hal config provider ecs account list [parameters]

Parameters

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

hal config provider ecs disable

Set the ecs provider as disabled

Usage

hal config provider ecs disable [parameters]

Parameters

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

hal config provider ecs enable

Set the ecs provider as enabled

Usage

hal config provider ecs enable [parameters]

Parameters

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

hal config provider google

Manage and view Spinnaker configuration for the google provider

Usage

hal config provider google [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the google provider’s account
bakery: Manage and view Spinnaker configuration for the google provider’s image bakery configuration.
disable: Set the google provider as disabled
edit: Set provider-wide properties for the Google provider
enable: Set the google provider as enabled

hal config provider google account

Manage and view Spinnaker configuration for the google provider’s account

Usage

hal config provider google account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the account to operate on.

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

Subcommands

add: Add an account to the google provider.
delete: Delete a specific google account by name.
edit: Edit an account in the google provider.
get: Get the specified account details for the google provider.
list: List the account names for the google provider.

hal config provider google account add

Add an account to the google provider.

Usage

hal config provider google account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--alpha-listed: (Default: false) Enable this flag if your project has access to alpha features and you want Spinnaker to take advantage of them.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--image-projects: (Default: []) A list of Google Cloud Platform projects Spinnaker will be able to cache and deploy images from. When this is omitted, it defaults to the current project. Each project must have granted the IAM role compute.imageUser to the service account associated with the json key used by this account, as well as to the ‘Google APIs service account’ automatically created for the project being managed (should look similar to 12345678912@cloudservices.gserviceaccount.com). See https://cloud.google.com/compute/docs/images/sharing-images-across-projects for more information about sharing images across GCP projects.
--json-path: The path to a JSON service account that Spinnaker will use as credentials. This is only needed if Spinnaker is not deployed on a Google Compute Engine VM, or needs permissions not afforded to the VM it is running on. See https://cloud.google.com/compute/docs/access/service-accounts for more information.
--no-validate: (Default: false) Skip validation.
--project: (Required) The Google Cloud Platform project this Spinnaker account will manage.
--read-permissions: (Default: []) A user must have at least one of these roles in order to view this account’s cloud resources.
--regions: A list of regions for caching and mutating calls. This overwrites any default-regions set on the provider.
--required-group-membership: (Default: []) A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--user-data: The path to user data template file. Spinnaker has the ability to inject userdata into generated instance templates. The mechanism is via a template file that is token replaced to provide some specifics about the deployment. See https://github.com/spinnaker/clouddriver/blob/master/clouddriver-aws/UserData.md for more information.
--write-permissions: (Default: []) A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider google account delete

Delete a specific google account by name.

Usage

hal config provider google account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider google account edit

Edit an account in the google provider.

Usage

hal config provider google account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--add-image-project: Add this image project to the list of image projects to cache and deploy images from.
--add-read-permission: Add this permission to the list of read permissions.
--add-region: Add this region to the list of regions for caching and mutating calls.
--add-required-group-membership: Add this group to the list of required group memberships.
--add-write-permission: Add this permission to the list of write permissions.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--image-projects: A list of Google Cloud Platform projects Spinnaker will be able to cache and deploy images from. When this is omitted, it defaults to the current project. Each project must have granted the IAM role compute.imageUser to the service account associated with the json key used by this account, as well as to the ‘Google APIs service account’ automatically created for the project being managed (should look similar to 12345678912@cloudservices.gserviceaccount.com). See https://cloud.google.com/compute/docs/images/sharing-images-across-projects for more information about sharing images across GCP projects.
--json-path: The path to a JSON service account that Spinnaker will use as credentials. This is only needed if Spinnaker is not deployed on a Google Compute Engine VM, or needs permissions not afforded to the VM it is running on. See https://cloud.google.com/compute/docs/access/service-accounts for more information.
--no-validate: (Default: false) Skip validation.
--project: The Google Cloud Platform project this Spinnaker account will manage.
--read-permissions: A user must have at least one of these roles in order to view this account’s cloud resources.
--regions: A list of regions for caching and mutating calls. This overwrites any default-regions set on the provider.
--remove-image-project: Remove this image project from the list of image projects to cache and deploy images from.
--remove-read-permission: Remove this permission from the list of read permissions.
--remove-region: Remove this region from the list of regions for caching and mutating calls.
--remove-required-group-membership: Remove this group from the list of required group memberships.
--remove-write-permission: Remove this permission to from list of write permissions.
--required-group-membership: A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--set-alpha-listed: Enable this flag if your project has access to alpha features and you want Spinnaker to take advantage of them.
--user-data: The path to user data template file. Spinnaker has the ability to inject userdata into generated instance templates. The mechanism is via a template file that is token replaced to provide some specifics about the deployment. See https://github.com/spinnaker/clouddriver/blob/master/clouddriver-aws/UserData.md for more information.
--write-permissions: A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider google account get

Get the specified account details for the google provider.

Usage

hal config provider google account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider google account list

List the account names for the google provider.

Usage

hal config provider google account list [parameters]

Parameters

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

hal config provider google bakery

Manage and view Spinnaker configuration for the google provider’s image bakery configuration.

Usage

hal config provider google bakery [parameters] [subcommands]

Parameters

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

Subcommands

base-image: Manage and view Spinnaker configuration for the google provider’s base image.
edit: Edit the google provider’s bakery default options.

hal config provider google bakery base-image

Manage and view Spinnaker configuration for the google provider’s base image.

Usage

hal config provider google bakery base-image [parameters] [subcommands]

Parameters

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

Subcommands

add: Add a base image for the google provider’s bakery.
delete: Delete a specific google base image by name.
edit: Edit a base image for the google provider’s bakery.
get: Get the specified base image details for the google provider.
list: List the base image names for the google provider.

hal config provider google bakery base-image add

Add a base image for the google provider’s bakery.

Usage

hal config provider google bakery base-image add BASE-IMAGE [parameters]

Parameters

BASE-IMAGE: The name of the base image to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--detailed-description: A long description to help human operators identify the image.
--is-image-family: (Default: false) todo(duftler) I couldn’t find a description on the packer website of what this is.
--no-validate: (Default: false) Skip validation.
--package-type: This is used to help Spinnaker’s bakery download the build artifacts you supply it with. For example, specifying ‘deb’ indicates that your artifacts will need to be fetched from a debian repository.
--short-description: A short description to help human operators identify the image.
--source-image: The source image. If both source image and source image family are set, source image will take precedence.
--source-image-family: The source image family to create the image from. The newest, non-deprecated image is used.
--template-file: This is the name of the packer template that will be used to bake images from this base image. The template file must be found in this list https://github.com/spinnaker/rosco/tree/master/rosco-web/config/packer , or supplied as described here: https://spinnaker.io/setup/bakery/

hal config provider google bakery base-image delete

Delete a specific google base image by name.

Usage

hal config provider google bakery base-image delete BASE-IMAGE [parameters]

Parameters

BASE-IMAGE: The name of the base image to operate on.

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

hal config provider google bakery base-image edit

Edit a base image for the google provider’s bakery.

Usage

hal config provider google bakery base-image edit BASE-IMAGE [parameters]

Parameters

BASE-IMAGE: The name of the base image to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--detailed-description: A long description to help human operators identify the image.
--id: This is the identifier used by your cloud to find this base image.
--is-image-family: todo(duftler) I couldn’t find a description on the packer website of what this is.
--no-validate: (Default: false) Skip validation.
--package-type: This is used to help Spinnaker’s bakery download the build artifacts you supply it with. For example, specifying ‘deb’ indicates that your artifacts will need to be fetched from a debian repository.
--short-description: A short description to help human operators identify the image.
--source-image: The source image. If both source image and source image family are set, source image will take precedence.
--source-image-family: The source image family to create the image from. The newest, non-deprecated image is used.
--template-file: This is the name of the packer template that will be used to bake images from this base image. The template file must be found in this list https://github.com/spinnaker/rosco/tree/master/rosco-web/config/packer , or supplied as described here: https://spinnaker.io/setup/bakery/

hal config provider google bakery base-image get

Get the specified base image details for the google provider.

Usage

hal config provider google bakery base-image get BASE-IMAGE [parameters]

Parameters

BASE-IMAGE: The name of the base image to operate on.

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

hal config provider google bakery base-image list

List the base image names for the google provider.

Usage

hal config provider google bakery base-image list [parameters]

Parameters

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

hal config provider google bakery edit

Edit the google provider’s bakery default options.

Usage

hal config provider google bakery edit [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--network: Set the default network your images will be baked in.
--network-project-id: Set the default project id for the network and subnet to use for the VM baking your image.
--no-validate: (Default: false) Skip validation.
--template-file: This is the name of the packer template that will be used to bake images from this base image. The template file must be found in this list https://github.com/spinnaker/rosco/tree/master/rosco-web/config/packer , or supplied as described here: https://spinnaker.io/setup/bakery/
--use-internal-ip: Use the internal rather than external IP of the VM baking your image.
--zone: Set the default zone your images will be baked in.

hal config provider google disable

Set the google provider as disabled

Usage

hal config provider google disable [parameters]

Parameters

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

hal config provider google edit

You can edit the list of default regions used in caching and mutating calls here. This list will become the default for all accounts, unlessspecifically overridden on a per-account basis.

Usage

hal config provider google edit [parameters]

Parameters

--add-default-region: Add this region to the list of regions for caching and mutating calls.
--default-regions: A list of regions for caching and mutating calls, applied to all accounts unless overridden.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--remove-default-region: Remove this region from the list of regions for caching and mutating calls.

hal config provider google enable

Set the google provider as enabled

Usage

hal config provider google enable [parameters]

Parameters

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

hal config provider huaweicloud

Manage and view Spinnaker configuration for the huaweicloud provider

Usage

hal config provider huaweicloud [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the huaweicloud provider’s account
bakery: Manage and view Spinnaker configuration for the huaweicloud provider’s image bakery configuration.
disable: Set the huaweicloud provider as disabled
enable: Set the huaweicloud provider as enabled

hal config provider huaweicloud account

Manage and view Spinnaker configuration for the huaweicloud provider’s account

Usage

hal config provider huaweicloud account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the account to operate on.

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

Subcommands

add: Add an account to the huaweicloud provider.
delete: Delete a specific huaweicloud account by name.
edit: Edit an account in the huaweicloud provider.
get: Get the specified account details for the huaweicloud provider.
list: List the account names for the huaweicloud provider.

hal config provider huaweicloud account add

Add an account to the huaweicloud provider.

Usage

hal config provider huaweicloud account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--account-type: The type of account.
--auth-url: (Required) The auth url of cloud.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--domain-name: (Required) The domain name of the cloud.
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--insecure: (Default: false) Disable certificate validation on SSL connections. Needed if certificates are self signed. Default false.
--no-validate: (Default: false) Skip validation.
--password: (Required) (Sensitive data - user will be prompted on standard input) (Sensitive data - user will be prompted on standard input) The password used to access cloud.
--project-name: (Required) The name of the project within the cloud.
--read-permissions: (Default: []) A user must have at least one of these roles in order to view this account’s cloud resources.
--regions: (Default: []) (Required) The region(s) of the cloud.
--required-group-membership: (Default: []) A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--username: (Required) The username used to access cloud.
--write-permissions: (Default: []) A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider huaweicloud account delete

Delete a specific huaweicloud account by name.

Usage

hal config provider huaweicloud account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider huaweicloud account edit

Edit an account in the huaweicloud provider.

Usage

hal config provider huaweicloud account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--account-type: The type of account.
--add-read-permission: Add this permission to the list of read permissions.
--add-region: Add this region to the list of managed regions.
--add-required-group-membership: Add this group to the list of required group memberships.
--add-write-permission: Add this permission to the list of write permissions.
--auth-url: The auth url of cloud.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--domain-name: The domain name of the cloud.
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--insecure: Disable certificate validation on SSL connections. Needed if certificates are self signed. Default false.
--no-validate: (Default: false) Skip validation.
--password: (Sensitive data - user will be prompted on standard input) (Sensitive data - user will be prompted on standard input) The password used to access cloud.
--project-name: The name of the project within the cloud.
--read-permissions: A user must have at least one of these roles in order to view this account’s cloud resources.
--regions: (Default: []) The region(s) of the cloud.
--remove-read-permission: Remove this permission from the list of read permissions.
--remove-region: Remove this region from the list of managed regions.
--remove-required-group-membership: Remove this group from the list of required group memberships.
--remove-write-permission: Remove this permission to from list of write permissions.
--required-group-membership: A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--username: The username used to access cloud.
--write-permissions: A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider huaweicloud account get

Get the specified account details for the huaweicloud provider.

Usage

hal config provider huaweicloud account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider huaweicloud account list

List the account names for the huaweicloud provider.

Usage

hal config provider huaweicloud account list [parameters]

Parameters

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

hal config provider huaweicloud bakery

Manage and view Spinnaker configuration for the huaweicloud provider’s image bakery configuration.

Usage

hal config provider huaweicloud bakery [parameters] [subcommands]

Parameters

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

Subcommands

base-image: Manage and view Spinnaker configuration for the huaweicloud provider’s base image.
edit: Edit the huaweicloud provider’s bakery default options.

hal config provider huaweicloud bakery base-image

Manage and view Spinnaker configuration for the huaweicloud provider’s base image.

Usage

hal config provider huaweicloud bakery base-image [parameters] [subcommands]

Parameters

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

Subcommands

add: Add a base image for the huaweicloud provider’s bakery.
delete: Delete a specific huaweicloud base image by name.
edit: Edit a base image for the huaweicloud provider’s bakery.
get: Get the specified base image details for the huaweicloud provider.
list: List the base image names for the huaweicloud provider.

hal config provider huaweicloud bakery base-image add

Add a base image for the huaweicloud provider’s bakery.

Usage

hal config provider huaweicloud bakery base-image add BASE-IMAGE [parameters]

Parameters

BASE-IMAGE: The name of the base image to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--detailed-description: A long description to help human operators identify the image.
--eip-type: (Required) The eip type for the baking configuration. See the api doc to get its value
--instance-type: (Required) The instance type for the baking configuration.
--no-validate: (Default: false) Skip validation.
--package-type: This is used to help Spinnaker’s bakery download the build artifacts you supply it with. For example, specifying ‘deb’ indicates that your artifacts will need to be fetched from a debian repository.
--region: (Required) The region for the baking configuration.
--short-description: A short description to help human operators identify the image.
--source-image-id: (Required) The source image ID for the baking configuration.
--ssh-user-name: (Required) The ssh username for the baking configuration.
--template-file: This is the name of the packer template that will be used to bake images from this base image. The template file must be found in this list https://github.com/spinnaker/rosco/tree/master/rosco-web/config/packer , or supplied as described here: https://spinnaker.io/setup/bakery/

hal config provider huaweicloud bakery base-image delete

Delete a specific huaweicloud base image by name.

Usage

hal config provider huaweicloud bakery base-image delete BASE-IMAGE [parameters]

Parameters

BASE-IMAGE: The name of the base image to operate on.

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

hal config provider huaweicloud bakery base-image edit

Edit a base image for the huaweicloud provider’s bakery.

Usage

hal config provider huaweicloud bakery base-image edit BASE-IMAGE [parameters]

Parameters

BASE-IMAGE: The name of the base image to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--detailed-description: A long description to help human operators identify the image.
--eip-type: The eip type for the baking configuration. See the api doc to get its value
--id: This is the identifier used by your cloud to find this base image.
--instance-type: The instance type for the baking configuration.
--no-validate: (Default: false) Skip validation.
--package-type: This is used to help Spinnaker’s bakery download the build artifacts you supply it with. For example, specifying ‘deb’ indicates that your artifacts will need to be fetched from a debian repository.
--region: The region for the baking configuration.
--short-description: A short description to help human operators identify the image.
--source-image-id: The source image ID for the baking configuration.
--ssh-user-name: The ssh username for the baking configuration.
--template-file: This is the name of the packer template that will be used to bake images from this base image. The template file must be found in this list https://github.com/spinnaker/rosco/tree/master/rosco-web/config/packer , or supplied as described here: https://spinnaker.io/setup/bakery/

hal config provider huaweicloud bakery base-image get

Get the specified base image details for the huaweicloud provider.

Usage

hal config provider huaweicloud bakery base-image get BASE-IMAGE [parameters]

Parameters

BASE-IMAGE: The name of the base image to operate on.

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

hal config provider huaweicloud bakery base-image list

List the base image names for the huaweicloud provider.

Usage

hal config provider huaweicloud bakery base-image list [parameters]

Parameters

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

hal config provider huaweicloud bakery edit

Edit the huaweicloud provider’s bakery default options.

Usage

hal config provider huaweicloud bakery edit [parameters]

Parameters

--auth-url: (Required) Set the default auth URL your images will be baked in.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--domain-name: (Required) Set the default domainName your images will be baked in.
--eip-bandwidth-size: (Required) Set the bandwidth size of eip your images will be baked in.
--insecure: (Required) The security setting (true/false) for connecting to the HuaweiCloud account.
--no-validate: (Default: false) Skip validation.
--password: (Required) (Sensitive data - user will be prompted on standard input) Set the default password your images will be baked with.
--project-name: (Required) Set the default project name your images will be baked in.
--security-group: (Required) Set the default security group your images will be baked in.
--subnet-id: (Required) Set the subnet your images will be baked in.
--template-file: This is the name of the packer template that will be used to bake images from this base image. The template file must be found in this list https://github.com/spinnaker/rosco/tree/master/rosco-web/config/packer , or supplied as described here: https://spinnaker.io/setup/bakery/
--username: (Required) Set the default username your images will be baked with.
--vpc-id: (Required) Set the vpc your images will be baked in.

hal config provider huaweicloud disable

Set the huaweicloud provider as disabled

Usage

hal config provider huaweicloud disable [parameters]

Parameters

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

hal config provider huaweicloud enable

Set the huaweicloud provider as enabled

Usage

hal config provider huaweicloud enable [parameters]

Parameters

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

hal config provider kubernetes

The Kubernetes provider is used to deploy Kubernetes resources to any number of Kubernetes clusters. Spinnaker assumes you have a Kubernetes cluster already running. If you don’t, you must configure one: https://kubernetes.io/docs/getting-started-guides/ .

Before proceeding, please visit https://kubernetes.io/docs/concepts/cluster-administration/authenticate-across-clusters-kubeconfig/ to make sure you’re familiar with the authentication terminology. For more information on how to configure individual accounts, or how to deploy to multiple clusters, please read the documentation under hal config provider kubernetes account -h.

Usage

hal config provider kubernetes [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the kubernetes provider’s account
disable: Set the kubernetes provider as disabled
edit: Set provider-wide properties for the Kubernetes provider
enable: Set the kubernetes provider as enabled

hal config provider kubernetes account

An account in the Kubernetes provider refers to a single Kubernetes context. In Kubernetes, a context is the combination of a Kubernetes cluster and some credentials. If no context is specified, the default context in in your kubeconfig is assumed.

You must also provide a set of Docker Registries for each account. Spinnaker will automatically upload that Registry’s credentials to the specified Kubernetes cluster allowing you to deploy those images without further configuration.

Usage

hal config provider kubernetes account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the account to operate on.

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

Subcommands

add: Add an account to the kubernetes provider.
delete: Delete a specific kubernetes account by name.
edit: Edit an account in the kubernetes provider.
get: Get the specified account details for the kubernetes provider.
list: List the account names for the kubernetes provider.

hal config provider kubernetes account add

Add an account to the kubernetes provider.

Usage

hal config provider kubernetes account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--cache-threads: (Default: 1) Number of caching agents for this kubernetes account. Each agent handles a subset of the namespaces available to this account. By default, only 1 agent caches all kinds for all namespaces in the account.
--check-permissions-on-startup: When false, clouddriver will skip the permission checks for all kubernetes kinds at startup. This can save a great deal of time during clouddriver startup when you have many kubernetes accounts configured. This disables the log messages at startup about missing permissions.
--configure-image-pull-secrets: (Default: true) (Only applicable to the v1 provider). When true, Spinnaker will create & manage your image pull secrets for you; when false, you will have to create and attach them to your pod specs by hand.
--context: The kubernetes context to be managed by Spinnaker. See http://kubernetes.io/docs/user-guide/kubeconfig-file/#context for more information. When no context is configured for an account the ‘current-context’ in your kubeconfig is assumed.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--docker-registries: (Default: []) A list of the Spinnaker docker registry account names this Spinnaker account can use as image sources. These docker registry accounts must be registered in your halconfig before you can add them here.
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--kinds: (Default: []) (V2 Only) A list of resource kinds this Spinnaker account can deploy to and will cache. When no kinds are configured, this defaults to ‘all kinds described here https://spinnaker.io/reference/providers/kubernetes/ ’.
--kubeconfig-file: The path to your kubeconfig file. By default, it will be under the Spinnaker user’s home directory in the typical .kube/config location.
--live-manifest-calls: When true, clouddriver will query manifest status during pipeline executions using live data rather than the cache. This eliminates all time spent in the “force cache refresh” task in pipelines, greatly reducing execution time.
--namespaces: (Default: []) A list of namespaces this Spinnaker account can deploy to and will cache. When no namespaces are configured, this defaults to ‘all namespaces’.
--no-validate: (Default: false) Skip validation.
--omit-kinds: (Default: []) (V2 Only) A list of resource kinds this Spinnaker account cannot deploy to or cache. This can only be set when –kinds is empty or not set.
--omit-namespaces: (Default: []) A list of namespaces this Spinnaker account cannot deploy to or cache. This can only be set when –namespaces is empty or not set.
--only-spinnaker-managed: (Default: false) (V2 Only) When true, Spinnaker will only cache/display applications that have been created by Spinnaker; as opposed to attempting to configure applications for resources already present in Kubernetes.
--provider-version: (Default: v2) There are currently two versions of the Kubernetes Provider: V1 and V2. This allows you to pick the version of the provider (not the resources it manages) to run within Spinnaker.V1 is scheduled for removal in Spinnaker 1.21; we recommend using V2 only.
--read-permissions: (Default: []) A user must have at least one of these roles in order to view this account’s cloud resources.
--required-group-membership: (Default: []) A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--service-account: When true, Spinnaker attempt to authenticate against Kubernetes using a Kubernetes service account. This only works when Halyard & Spinnaker are deployed in Kubernetes. Read more about service accounts here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ .
--write-permissions: (Default: []) A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider kubernetes account delete

Delete a specific kubernetes account by name.

Usage

hal config provider kubernetes account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider kubernetes account edit

Edit an account in the kubernetes provider.

Usage

hal config provider kubernetes account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--add-custom-resource: (V2 Only) Add Kubernetes custom resource to the list of custom resources to managed by clouddriver and made available for use in patch and delete manifest stages. Fields besides the Kubernetes Kind (resource name) can be set using the flags “–spinnaker-kind” and “–versioned”
--add-docker-registry: Add this docker registry to the list of docker registries to use as a source of images.
--add-kind: Add this kind to the list of kinds to manage.
--add-namespace: Add this namespace to the list of namespaces to manage.
--add-omit-kind: Add this kind to the list of kinds to omit.
--add-omit-namespace: Add this namespace to the list of namespaces to omit.
--add-read-permission: Add this permission to the list of read permissions.
--add-required-group-membership: Add this group to the list of required group memberships.
--add-write-permission: Add this permission to the list of write permissions.
--all-kinds: (Default: false) Set the list of kinds to cache and deploy to every kind available to your supplied credentials.
--all-namespaces: (Default: false) Set the list of namespaces to cache and deploy to every namespace available to your supplied credentials.
--cache-threads: Number of caching agents for this kubernetes account. Each agent handles a subset of the namespaces available to this account. By default, only 1 agent caches all kinds for all namespaces in the account.
--check-permissions-on-startup: When false, clouddriver will skip the permission checks for all kubernetes kinds at startup. This can save a great deal of time during clouddriver startup when you have many kubernetes accounts configured. This disables the log messages at startup about missing permissions.
--clear-context: (Default: false) Removes the currently configured context, defaulting to ‘current-context’ in your kubeconfig.See http://kubernetes.io/docs/user-guide/kubeconfig-file/#context for more information.
--configure-image-pull-secrets: (Only applicable to the v1 provider). When true, Spinnaker will create & manage your image pull secrets for you; when false, you will have to create and attach them to your pod specs by hand.
--context: The kubernetes context to be managed by Spinnaker. See http://kubernetes.io/docs/user-guide/kubeconfig-file/#context for more information. When no context is configured for an account the ‘current-context’ in your kubeconfig is assumed.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--docker-registries: (Default: []) A list of the Spinnaker docker registry account names this Spinnaker account can use as image sources. These docker registry accounts must be registered in your halconfig before you can add them here.
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--kinds: (Default: []) (V2 Only) A list of resource kinds this Spinnaker account can deploy to and will cache. When no kinds are configured, this defaults to ‘all kinds described here https://spinnaker.io/reference/providers/kubernetes/ ’.
--kubeconfig-file: The path to your kubeconfig file. By default, it will be under the Spinnaker user’s home directory in the typical .kube/config location.
--live-manifest-calls: When true, clouddriver will query manifest status during pipeline executions using live data rather than the cache. This eliminates all time spent in the “force cache refresh” task in pipelines, greatly reducing execution time.
--namespaces: (Default: []) A list of namespaces this Spinnaker account can deploy to and will cache. When no namespaces are configured, this defaults to ‘all namespaces’.
--no-validate: (Default: false) Skip validation.
--omit-kinds: (Default: []) (V2 Only) A list of resource kinds this Spinnaker account cannot deploy to or cache. This can only be set when –kinds is empty or not set.
--omit-namespaces: (Default: []) A list of namespaces this Spinnaker account cannot deploy to or cache. This can only be set when –namespaces is empty or not set.
--only-spinnaker-managed: (V2 Only) When true, Spinnaker will only cache/display applications that have been created by Spinnaker; as opposed to attempting to configure applications for resources already present in Kubernetes.
--provider-version: There are currently two versions of the Kubernetes Provider: V1 and V2. This allows you to pick the version of the provider (not the resources it manages) to run within Spinnaker.V1 is scheduled for removal in Spinnaker 1.21; we recommend using V2 only.
--read-permissions: A user must have at least one of these roles in order to view this account’s cloud resources.
--remove-custom-resource: Remove this Kubernetes custom resource by name from the list of custom resources to manage.
--remove-docker-registry: Remove this docker registry from the list of docker registries to use as a source of images.
--remove-kind: Remove this kind to the list of kinds to manage.
--remove-namespace: Remove this namespace to the list of namespaces to manage.
--remove-omit-kind: Remove this kind to the list of kinds to omit.
--remove-omit-namespace: Remove this namespace to the list of namespaces to omit.
--remove-read-permission: Remove this permission from the list of read permissions.
--remove-required-group-membership: Remove this group from the list of required group memberships.
--remove-write-permission: Remove this permission to from list of write permissions.
--required-group-membership: A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--service-account: When true, Spinnaker attempt to authenticate against Kubernetes using a Kubernetes service account. This only works when Halyard & Spinnaker are deployed in Kubernetes. Read more about service accounts here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ .
--spinnaker-kind: Set the Spinnaker kind for custom resource being added.
--versioned: Configure whether the custom resource being added is versioned by Spinnaker.
--write-permissions: A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider kubernetes account get

Get the specified account details for the kubernetes provider.

Usage

hal config provider kubernetes account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider kubernetes account list

List the account names for the kubernetes provider.

Usage

hal config provider kubernetes account list [parameters]

Parameters

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

hal config provider kubernetes disable

Set the kubernetes provider as disabled

Usage

hal config provider kubernetes disable [parameters]

Parameters

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

hal config provider kubernetes edit

Due to how the Kubernetes provider shards its cache resources, there is opportunity to tune how its caching should be handled. This command exists to allow you tune this caching behavior.

Usage

hal config provider kubernetes edit [parameters]

Parameters

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

hal config provider kubernetes enable

Set the kubernetes provider as enabled

Usage

hal config provider kubernetes enable [parameters]

Parameters

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

hal config provider oracle

Manage and view Spinnaker configuration for the oracle provider

Usage

hal config provider oracle [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the oracle provider’s account
bakery: Manage and view Spinnaker configuration for the oracle provider’s image bakery configuration.
disable: Set the oracle provider as disabled
enable: Set the oracle provider as enabled

hal config provider oracle account

Manage and view Spinnaker configuration for the oracle provider’s account

Usage

hal config provider oracle account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the account to operate on.

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

Subcommands

add: Add an account to the oracle provider.
delete: Delete a specific oracle account by name.
edit: Edit an account in the oracle provider.
get: Get the specified account details for the oracle provider.
list: List the account names for the oracle provider.

hal config provider oracle account add

Add an account to the oracle provider.

Usage

hal config provider oracle account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--compartment-id: (Required) Provide the OCID of the Oracle Compartment to use.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--fingerprint: (Required) Fingerprint of the public key
--no-validate: (Default: false) Skip validation.
--private-key-passphrase: (Sensitive data - user will be prompted on standard input) Passphrase used for the private key, if it is encrypted
--read-permissions: (Default: []) A user must have at least one of these roles in order to view this account’s cloud resources.
--region: (Required) An Oracle region (e.g., us-phoenix-1)
--required-group-membership: (Default: []) A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--ssh-private-key-file-path: (Required) Path to the private key in PEM format
--tenancyId: (Required) Provide the OCID of the Oracle Tenancy to use.
--user-id: (Required) Provide the OCID of the Oracle User you’re authenticating as
--write-permissions: (Default: []) A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider oracle account delete

Delete a specific oracle account by name.

Usage

hal config provider oracle account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider oracle account edit

Edit an account in the oracle provider.

Usage

hal config provider oracle account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--add-read-permission: Add this permission to the list of read permissions.
--add-required-group-membership: Add this group to the list of required group memberships.
--add-write-permission: Add this permission to the list of write permissions.
--compartment-id: Provide the OCID of the Oracle Compartment to use.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--fingerprint: Fingerprint of the public key
--no-validate: (Default: false) Skip validation.
--private-key-passphrase: (Sensitive data - user will be prompted on standard input) Passphrase used for the private key, if it is encrypted
--read-permissions: A user must have at least one of these roles in order to view this account’s cloud resources.
--region: An Oracle region (e.g., us-phoenix-1)
--remove-read-permission: Remove this permission from the list of read permissions.
--remove-required-group-membership: Remove this group from the list of required group memberships.
--remove-write-permission: Remove this permission to from list of write permissions.
--required-group-membership: A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--ssh-private-key-file-path: Path to the private key in PEM format
--tenancyId: Provide the OCID of the Oracle Tenancy to use.
--user-id: Provide the OCID of the Oracle User you’re authenticating as
--write-permissions: A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider oracle account get

Get the specified account details for the oracle provider.

Usage

hal config provider oracle account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider oracle account list

List the account names for the oracle provider.

Usage

hal config provider oracle account list [parameters]

Parameters

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

hal config provider oracle bakery

Manage and view Spinnaker configuration for the oracle provider’s image bakery configuration.

Usage

hal config provider oracle bakery [parameters] [subcommands]

Parameters

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

Subcommands

base-image: Manage and view Spinnaker configuration for the oracle provider’s base image.
edit: Edit the oracle provider’s bakery default options.

hal config provider oracle bakery base-image

Manage and view Spinnaker configuration for the oracle provider’s base image.

Usage

hal config provider oracle bakery base-image [parameters] [subcommands]

Parameters

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

Subcommands

add: Add a base image for the oracle provider’s bakery.
delete: Delete a specific oracle base image by name.
edit: Edit a base image for the oracle provider’s bakery.
get: Get the specified base image details for the oracle provider.
list: List the base image names for the oracle provider.

hal config provider oracle bakery base-image add

Add a base image for the oracle provider’s bakery.

Usage

hal config provider oracle bakery base-image add BASE-IMAGE [parameters]

Parameters

BASE-IMAGE: The name of the base image to operate on.

--base-image-id: (Required) The OCID of the base image ID for the baking configuration.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--detailed-description: A long description to help human operators identify the image.
--no-validate: (Default: false) Skip validation.
--package-type: This is used to help Spinnaker’s bakery download the build artifacts you supply it with. For example, specifying ‘deb’ indicates that your artifacts will need to be fetched from a debian repository.
--short-description: A short description to help human operators identify the image.
--ssh-user-name: (Required) The ssh username for the baking configuration.
--template-file: This is the name of the packer template that will be used to bake images from this base image. The template file must be found in this list https://github.com/spinnaker/rosco/tree/master/rosco-web/config/packer , or supplied as described here: https://spinnaker.io/setup/bakery/

hal config provider oracle bakery base-image delete

Delete a specific oracle base image by name.

Usage

hal config provider oracle bakery base-image delete BASE-IMAGE [parameters]

Parameters

BASE-IMAGE: The name of the base image to operate on.

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

hal config provider oracle bakery base-image edit

Edit a base image for the oracle provider’s bakery.

Usage

hal config provider oracle bakery base-image edit BASE-IMAGE [parameters]

Parameters

BASE-IMAGE: The name of the base image to operate on.

--base-image-id: The OCID of the base image ID for the baking configuration.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--detailed-description: A long description to help human operators identify the image.
--id: This is the identifier used by your cloud to find this base image.
--no-validate: (Default: false) Skip validation.
--package-type: This is used to help Spinnaker’s bakery download the build artifacts you supply it with. For example, specifying ‘deb’ indicates that your artifacts will need to be fetched from a debian repository.
--short-description: A short description to help human operators identify the image.
--ssh-user-name: The ssh username for the baking configuration.
--template-file: This is the name of the packer template that will be used to bake images from this base image. The template file must be found in this list https://github.com/spinnaker/rosco/tree/master/rosco-web/config/packer , or supplied as described here: https://spinnaker.io/setup/bakery/

hal config provider oracle bakery base-image get

Get the specified base image details for the oracle provider.

Usage

hal config provider oracle bakery base-image get BASE-IMAGE [parameters]

Parameters

BASE-IMAGE: The name of the base image to operate on.

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

hal config provider oracle bakery base-image list

List the base image names for the oracle provider.

Usage

hal config provider oracle bakery base-image list [parameters]

Parameters

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

hal config provider oracle bakery edit

Edit the oracle provider’s bakery default options.

Usage

hal config provider oracle bakery edit [parameters]

Parameters

--availability-domain: (Required) The name of the Availability Domain within which a new instance is launched and provisioned.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--instance-shape: (Required) The shape for allocated to a newly created instance.
--no-validate: (Default: false) Skip validation.
--subnet-id: (Required) The name of the subnet within which a new instance is launched and provisioned.
--template-file: This is the name of the packer template that will be used to bake images from this base image. The template file must be found in this list https://github.com/spinnaker/rosco/tree/master/rosco-web/config/packer , or supplied as described here: https://spinnaker.io/setup/bakery/

hal config provider oracle disable

Set the oracle provider as disabled

Usage

hal config provider oracle disable [parameters]

Parameters

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

hal config provider oracle enable

Set the oracle provider as enabled

Usage

hal config provider oracle enable [parameters]

Parameters

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

hal config provider tencentcloud

Manage and view Spinnaker configuration for the tencentcloud provider

Usage

hal config provider tencentcloud [parameters] [subcommands]

Parameters

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

Subcommands

account: Manage and view Spinnaker configuration for the tencentcloud provider’s account
bakery: Manage and view Spinnaker configuration for the tencentcloud provider’s image bakery configuration.
disable: Set the tencentcloud provider as disabled
enable: Set the tencentcloud provider as enabled

hal config provider tencentcloud account

Manage and view Spinnaker configuration for the tencentcloud provider’s account

Usage

hal config provider tencentcloud account ACCOUNT [parameters] [subcommands]

Parameters

ACCOUNT: The name of the account to operate on.

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

Subcommands

add: Add an account to the tencentcloud provider.
delete: Delete a specific tencentcloud account by name.
edit: Edit an account in the tencentcloud provider.
get: Get the specified account details for the tencentcloud provider.
list: List the account names for the tencentcloud provider.

hal config provider tencentcloud account add

Add an account to the tencentcloud provider.

Usage

hal config provider tencentcloud account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--no-validate: (Default: false) Skip validation.
--read-permissions: (Default: []) A user must have at least one of these roles in order to view this account’s cloud resources.
--regions: The Tencent CLoud regions this Spinnaker account will manage.
--required-group-membership: (Default: []) A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--secret-id: (Required) The secret id used to access Tencent Cloud.
--secret-key: (Required) (Sensitive data - user will be prompted on standard input) (Sensitive data - user will be prompted on standard input) The secret key used to access Tencent Cloud.
--write-permissions: (Default: []) A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider tencentcloud account delete

Delete a specific tencentcloud account by name.

Usage

hal config provider tencentcloud account delete ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider tencentcloud account edit

Edit an account in the tencentcloud provider.

Usage

hal config provider tencentcloud account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

--add-read-permission: Add this permission to the list of read permissions.
--add-region: Add this region to the list of managed regions.
--add-required-group-membership: Add this group to the list of required group memberships.
--add-write-permission: Add this permission to the list of write permissions.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
--no-validate: (Default: false) Skip validation.
--read-permissions: A user must have at least one of these roles in order to view this account’s cloud resources.
--regions: The Tencent CLoud regions this Spinnaker account will manage.
--remove-read-permission: Remove this permission from the list of read permissions.
--remove-region: Remove this region from the list of managed regions.
--remove-required-group-membership: Remove this group from the list of required group memberships.
--remove-write-permission: Remove this permission to from list of write permissions.
--required-group-membership: A user must be a member of at least one specified group in order to make changes to this account’s cloud resources.
--secret-id: The secret id used to access Tencent Cloud.
--secret-key: (Sensitive data - user will be prompted on standard input) (Sensitive data - user will be prompted on standard input) The secret key used to access Tencent Cloud.
--write-permissions: A user must have at least one of these roles in order to make changes to this account’s cloud resources.

hal config provider tencentcloud account get

Get the specified account details for the tencentcloud provider.

Usage

hal config provider tencentcloud account get ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

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

hal config provider tencentcloud account list

List the account names for the tencentcloud provider.

Usage

hal config provider tencentcloud account list [parameters]

Parameters

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

hal config provider tencentcloud bakery

Manage and view Spinnaker configuration for the tencentcloud provider’s image bakery configuration.

Usage

hal config provider tencentcloud bakery [parameters] [subcommands]

Parameters

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

Subcommands

base-image: Manage and view Spinnaker configuration for the tencentcloud provider’s base image.
edit: Edit the tencentcloud provider’s bakery default options.

hal config provider tencentcloud bakery base-image

Manage and view Spinnaker configuration for the tencentcloud provider’s base image.

Usage

hal config provider tencentcloud bakery base-image [parameters] [subcommands]

Parameters

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

Subcommands

add: Add a base image for the tencentcloud provider’s bakery.
delete: Delete a specific tencentcloud base image by name.
edit: Edit a base image for the tencentcloud provider’s bakery.
get: Get the specified base image details for the tencentcloud provider.
list: List the base image names for the tencentcloud provider.

hal config provider tencentcloud bakery base-image add

Add a base image for the tencentcloud provider’s bakery.

Usage

hal config provider tencentcloud bakery base-image add BASE-IMAGE [parameters]

Parameters

BASE-IMAGE: The name of the base image to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--detailed-description: A long description to help human operators identify the image.
--instance-type: (Required) The instance type for the baking configuration.
--no-validate: (Default: false) Skip validation.
--package-type: This is used to help Spinnaker’s bakery download the build artifacts you supply it with. For example, specifying ‘deb’ indicates that your artifacts will need to be fetched from a debian repository.
--region: (Required) The region for the baking configuration.
--short-description: A short description to help human operators identify the image.
--source-image-id: (Required) The source image ID for the baking configuration.
--ssh-user-name: (Required) The ssh username for the baking configuration.
--template-file: This is the name of the packer template that will be used to bake images from this base image. The template file must be found in this list https://github.com/spinnaker/rosco/tree/master/rosco-web/config/packer , or supplied as described here: https://spinnaker.io/setup/bakery/
--zone: (Required) The zone for the baking configuration.

hal config provider tencentcloud bakery base-image delete

Delete a specific tencentcloud base image by name.

Usage

hal config provider tencentcloud bakery base-image delete BASE-IMAGE [parameters]

Parameters

BASE-IMAGE: The name of the base image to operate on.

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

hal config provider tencentcloud bakery base-image edit

Edit a base image for the tencentcloud provider’s bakery.

Usage

hal config provider tencentcloud bakery base-image edit BASE-IMAGE [parameters]

Parameters

BASE-IMAGE: The name of the base image to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--detailed-description: A long description to help human operators identify the image.
--id: This is the identifier used by your cloud to find this base image.
--instance-type: (Required) The instance type for the baking configuration.
--no-validate: (Default: false) Skip validation.
--package-type: This is used to help Spinnaker’s bakery download the build artifacts you supply it with. For example, specifying ‘deb’ indicates that your artifacts will need to be fetched from a debian repository.
--region: (Required) The region for the baking configuration.
--short-description: A short description to help human operators identify the image.
--source-image-id: (Required) The source image ID for the baking configuration.
--ssh-user-name: (Required) The ssh username for the baking configuration.
--template-file: This is the name of the packer template that will be used to bake images from this base image. The template file must be found in this list https://github.com/spinnaker/rosco/tree/master/rosco-web/config/packer , or supplied as described here: https://spinnaker.io/setup/bakery/
--zone: (Required) The zone for the baking configuration.

hal config provider tencentcloud bakery base-image get

Get the specified base image details for the tencentcloud provider.

Usage

hal config provider tencentcloud bakery base-image get BASE-IMAGE [parameters]

Parameters

BASE-IMAGE: The name of the base image to operate on.

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

hal config provider tencentcloud bakery base-image list

List the base image names for the tencentcloud provider.

Usage

hal config provider tencentcloud bakery base-image list [parameters]

Parameters

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

hal config provider tencentcloud bakery edit

Edit the tencentcloud provider’s bakery default options.

Usage

hal config provider tencentcloud bakery edit [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--secret-id: (Required) The default access key used to communicate with AWS.
--secret-key: (Required) (Sensitive data - user will be prompted on standard input) The secret key used to communicate with AWS.
--template-file: This is the name of the packer template that will be used to bake images from this base image. The template file must be found in this list https://github.com/spinnaker/rosco/tree/master/rosco-web/config/packer , or supplied as described here: https://spinnaker.io/setup/bakery/

hal config provider tencentcloud disable

Set the tencentcloud provider as disabled

Usage

hal config provider tencentcloud disable [parameters]

Parameters

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

hal config provider tencentcloud enable

Set the tencentcloud provider as enabled

Usage

hal config provider tencentcloud enable [parameters]

Parameters

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

hal config pubsub

Configure, validate, and view the specified pubsub.

Usage

hal config pubsub [subcommands]

Subcommands

google: Manage and view Spinnaker configuration for the google pubsub

hal config pubsub google

Manage and view Spinnaker configuration for the google pubsub

Usage

hal config pubsub google [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 the google pubsub as disabled
enable: Set the google pubsub as enabled
subscription: Manage and view Spinnaker configuration for the google pubsub’s subscription

hal config pubsub google disable

Set the google pubsub as disabled

Usage

hal config pubsub google disable [parameters]

Parameters

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

hal config pubsub google enable

Set the google pubsub as enabled

Usage

hal config pubsub google enable [parameters]

Parameters

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

hal config pubsub google subscription

Manage and view Spinnaker configuration for the google pubsub’s subscription

Usage

hal config pubsub google subscription SUBSCRIPTION [parameters] [subcommands]

Parameters

SUBSCRIPTION: The name of the subscription to operate on.

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

Subcommands

add: Add an subscription to the google pubsub.
delete: Delete a specific google subscription by name.
edit: Edit an subscription in the google pubsub.
get: Get the specified subscription details for the google pubsub.
list: List the subscription names for the google pubsub.

hal config pubsub google subscription add

Add an subscription to the google pubsub.

Usage

hal config pubsub google subscription add SUBSCRIPTION [parameters]

Parameters

SUBSCRIPTION: The name of the subscription to operate on.

--ack-deadline-seconds: (Default: 10) Time in seconds before an outstanding message is considered unacknowledged and is re-sent. Configurable in your Google Cloud Pubsub subscription. See the docs here: https://cloud.google.com/pubsub/docs/subscriber
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--json-path: The path to a JSON service account that Spinnaker will use as credentials. This is only needed if Spinnaker is not deployed on a Google Compute Engine VM, or needs permissions not afforded to the VM it is running on. See https://cloud.google.com/compute/docs/access/service-accounts for more information.
--message-format: (Default: CUSTOM) One of ‘GCB’, ‘GCS’, ‘GCR’, or ‘CUSTOM’. This can be used to help Spinnaker translate the contents of the Pub/Sub message into Spinnaker artifacts.
--no-validate: (Default: false) Skip validation.
--project: The name of the GCP project your subscription lives in.
--subscription-name: The name of the subscription to listen to. This identifier does not include the name of the project, and must already be configured for Spinnaker to work.
--template-path: A path to a jinja template that specifies how artifacts from this pubsub system are interpreted and transformed into Spinnaker artifacts. See spinnaker.io/reference/artifacts for more information.

hal config pubsub google subscription delete

Delete a specific google subscription by name.

Usage

hal config pubsub google subscription delete SUBSCRIPTION [parameters]

Parameters

SUBSCRIPTION: The name of the subscription to operate on.

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

hal config pubsub google subscription edit

Edit an subscription in the google pubsub.

Usage

hal config pubsub google subscription edit SUBSCRIPTION [parameters]

Parameters

SUBSCRIPTION: The name of the subscription to operate on.

--ack-deadline-seconds: Time in seconds before an outstanding message is considered unacknowledged and is re-sent. Configurable in your Google Cloud Pubsub subscription. See the docs here: https://cloud.google.com/pubsub/docs/subscriber
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--json-path: The path to a JSON service account that Spinnaker will use as credentials. This is only needed if Spinnaker is not deployed on a Google Compute Engine VM, or needs permissions not afforded to the VM it is running on. See https://cloud.google.com/compute/docs/access/service-accounts for more information.
--message-format: One of ‘GCB’, ‘GCS’, ‘GCR’, or ‘CUSTOM’. This can be used to help Spinnaker translate the contents of the Pub/Sub message into Spinnaker artifacts.
--no-validate: (Default: false) Skip validation.
--project: The name of the GCP project your subscription lives in.
--subscription-name: The name of the subscription to listen to. This identifier does not include the name of the project, and must already be configured for Spinnaker to work.
--template-path: A path to a jinja template that specifies how artifacts from this pubsub system are interpreted and transformed into Spinnaker artifacts. See spinnaker.io/reference/artifacts for more information.

hal config pubsub google subscription get

Get the specified subscription details for the google pubsub.

Usage

hal config pubsub google subscription get SUBSCRIPTION [parameters]

Parameters

SUBSCRIPTION: The name of the subscription to operate on.

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

hal config pubsub google subscription list

List the subscription names for the google pubsub.

Usage

hal config pubsub google subscription list [parameters]

Parameters

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

hal config repository

Configure, validate, and view the specified repository.

Usage

hal config repository [subcommands]

Subcommands

artifactory: Manage and view Spinnaker configuration for the artifactory repository

hal config repository artifactory

Manage and view Spinnaker configuration for the artifactory repository

Usage

hal config repository artifactory [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 the artifactory repository as disabled
enable: Set the artifactory repository as enabled
search: Manage and view Spinnaker configuration for the artifactory repository services’s search

hal config repository artifactory disable

Set the artifactory repository as disabled

Usage

hal config repository artifactory disable [parameters]

Parameters

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

hal config repository artifactory enable

Set the artifactory repository as enabled

Usage

hal config repository artifactory enable [parameters]

Parameters

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

hal config repository artifactory search

Manage and view Spinnaker configuration for the artifactory repository services’s search

Usage

hal config repository artifactory search SEARCH [parameters] [subcommands]

Parameters

SEARCH: The name of the search to operate on.

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

Subcommands

add: Add a search for the artifactory repository service.
delete: Delete a specific artifactory search by name.
edit: Edit a search for the artifactory repository service.
get: Get the specified search details for artifactory.
list: List the search names for artifactory.

hal config repository artifactory search add

Add a search for the artifactory repository service.

Usage

hal config repository artifactory search add SEARCH [parameters]

Parameters

SEARCH: The name of the search to operate on.

--base-url: (Required) The base url your artifactory search is reachable at.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--groupId: The group id in your artifactory to be searched.
--no-validate: (Default: false) Skip validation.
--password: (Required) (Sensitive data - user will be prompted on standard input) The password of the artifactory user to authenticate as.
--read-permissions: (Default: []) A user must have at least one of these roles in order to view this build search or use it as a trigger source.
--repo: (Required) The repo in your artifactory to be searched.
--repo-type: (Default: MAVEN) The package type of repo in your artifactory to be searched.
--username: (Required) The username of the artifactory user to authenticate as.
--write-permissions: (Default: []) A user must have at least one of these roles in order to be able to run jobs on this build search.

hal config repository artifactory search delete

Delete a specific artifactory search by name.

Usage

hal config repository artifactory search delete SEARCH [parameters]

Parameters

SEARCH: The name of the search to operate on.

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

hal config repository artifactory search edit

Edit a search for the artifactory repository service.

Usage

hal config repository artifactory search edit SEARCH [parameters]

Parameters

SEARCH: The name of the search to operate on.

--add-read-permission: Add this permission to the list of read permissions.
--add-write-permission: Add this permission to the list of write permissions.
--base-url: The base url your artifactory search is reachable at.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--groupId: The group id in your artifactory to be searched.
--no-validate: (Default: false) Skip validation.
--password: The password of the artifactory user to authenticate as.
--read-permissions: A user must have at least one of these roles in order to view this build search or use it as a trigger source.
--remove-read-permission: Remove this permission from the list of read permissions.
--remove-write-permission: Remove this permission from the list of write permissions.
--repo: The repo in your artifactory to be searched.
--repo-type: The package type of repo in your artifactory to be searched.
--username: The username of the artifactory user to authenticate as.
--write-permissions: A user must have at least one of these roles in order to be able to run jobs on this build search.

hal config repository artifactory search get

Get the specified search details for artifactory.

Usage

hal config repository artifactory search get SEARCH [parameters]

Parameters

SEARCH: The name of the search to operate on.

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

hal config repository artifactory search list

List the search names for artifactory.

Usage

hal config repository artifactory search list [parameters]

Parameters

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

hal config security

Configure Spinnaker’s security. This includes external SSL, authentication mechanisms, and authorization policies.

Usage

hal config security [parameters] [subcommands]

Parameters

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

Subcommands

api: Configure and view the API server’s addressable URL and CORS policies.
authn: Configure your authentication settings for Spinnaker.
authz: Configure your authorization settings for Spinnaker.
ui: Configure and view the UI server’s addressable URL.

hal config security api

Configure and view the API server’s addressable URL and CORS policies.

Usage

hal config security api [parameters] [subcommands]

Parameters

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

Subcommands

edit: Configure access policies specific to Spinnaker’s API server.
ssl: Configure and view SSL settings for Spinnaker’s API gateway.

hal config security api edit

When Spinnaker is deployed to a remote host, the API server may be configured to accept auth requests from alternate sources, do SSL termination, or sit behind an externally configured proxy server or load balancer.

Usage

hal config security api edit [parameters]

Parameters

--cors-access-pattern: If you have authentication enabled, are accessing Spinnaker remotely, and are logging in from sources other than the UI, provide a regex matching all URLs authentication redirects may come from.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--override-base-url: If you are accessing the API server remotely, provide the full base URL of whatever proxy or load balancer is fronting the API requests.

hal config security api ssl

If you want the API server to do SSL termination, it must be enabled and configured here. If you are doing your own SSL termination, leave this disabled.

Usage

hal config security api ssl [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: Disable SSL for the API gateway.
edit: Edit SSL settings for your API server.
enable: Enable SSL for the API gateway.

hal config security api ssl disable

Disable SSL for the API gateway.

Usage

hal config security api ssl disable [parameters]

Parameters

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

hal config security api ssl edit

Configure SSL termination to handled by the API server’s Tomcat server.

Usage

hal config security api ssl edit [parameters]

Parameters

--client-auth: Declare ‘WANT’ when client auth is wanted but not mandatory, or ‘NEED’, when client auth is mandatory.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--key-alias: Name of your keystore entry as generated with your keytool.
--keystore: Path to the keystore holding your security certificates.
--keystore-password: (Sensitive data - user will be prompted on standard input) The password to unlock your keystore. Due to a limitation in Tomcat, this must match your key’s password in the keystore.
--keystore-type: The type of your keystore. Examples include JKS, and PKCS12.
--no-validate: (Default: false) Skip validation.
--truststore: Path to the truststore holding your trusted certificates.
--truststore-password: (Sensitive data - user will be prompted on standard input) The password to unlock your truststore.
--truststore-type: The type of your truststore. Examples include JKS, and PKCS12.

hal config security api ssl enable

Enable SSL for the API gateway.

Usage

hal config security api ssl enable [parameters]

Parameters

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

hal config security authn

This set of commands allows you to configure how users can authenticate against Spinnaker.

Usage

hal config security authn [parameters] [subcommands]

Parameters

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

Subcommands

iap: Configure the iap method for authenticating.
ldap: Configure the ldap method for authenticating.
oauth2: Configure the oauth2 method for authenticating.
saml: Configure the saml method for authenticating.
x509: Configure the x509 method for authenticating.

hal config security authn iap

Configure the iap method for authenticating.

Usage

hal config security authn iap [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 the iap method as disabled
edit: Configure authentication using the Google Cloud Identity-Aware Proxy authentication model.
enable: Set the iap method as enabled

hal config security authn iap disable

Set the iap method as disabled

Usage

hal config security authn iap disable [parameters]

Parameters

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

hal config security authn iap edit

Google Cloud Identity-Aware Proxy (IAP) is an authentication model that utilizes Google OAuth2.0 and an authorization service to provide access control for users of GCP. After a user has been authenticated and authorized by IAP’s service, a JWT token is passed along which Spinnaker uses to check for authenticity and to get the user email from the payload and sign the user in. To configure IAP, set the audience field retrieved from the IAP console.

Usage

hal config security authn iap edit [parameters]

Parameters

--audience: The Audience from the ID token payload. You can retrieve this field from the IAP console: https://cloud.google.com/iap/docs/signed-headers-howto#verify_the_id_token_header .
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--iap-verify-key-url: The URL containing the Cloud IAP public keys in JWK format.
--issuer-id: The Issuer from the ID token payload.
--jwt-header: The HTTP request header that contains the JWT token.
--no-validate: (Default: false) Skip validation.

hal config security authn iap enable

Set the iap method as enabled

Usage

hal config security authn iap enable [parameters]

Parameters

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

hal config security authn ldap

Configure the ldap method for authenticating.

Usage

hal config security authn ldap [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 the ldap method as disabled
edit: Configure authentication using a LDAP identity provider.
enable: Set the ldap method as enabled

hal config security authn ldap disable

Set the ldap method as disabled

Usage

hal config security authn ldap disable [parameters]

Parameters

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

hal config security authn ldap edit

Lightweight Directory Access Protocol (LDAP) is a standard way many organizations maintain user credentials and group memberships. Spinnaker uses the standard ‘bind’ approach for user authentication. This is a fancy way of saying that Gate uses your username and password to login to the LDAP server, and if the connection is successful, you’re considered authenticated.

Usage

hal config security authn ldap edit [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--group-search-base: The part of the directory tree under which group searches should be performed.
--manager-dn: An LDAP manager user is required for binding to the LDAP server for the user authentication process. This property refers to the DN of that entry. I.e. this is not the user which will be authenticated when logging into DHIS2, rather the user which binds to the LDAP server in order to do the authentication.
--manager-password: (Sensitive data - user will be prompted on standard input) The password for the LDAP manager user.
--no-validate: (Default: false) Skip validation.
--url: ldap:// or ldaps:// url of the LDAP server
--user-dn-pattern: The pattern for finding a user’s DN using simple pattern matching. For example, if your LDAP server has the URL ldap://mysite.com/dc=spinnaker,dc=org , and you have the pattern ‘uid={0},ou=members’, ‘me’ will map to a DN uid=me,ou=members,dc=spinnaker,dc=org. If no match is found, will try to find the user using user-search-filter, if set.
--user-search-base: The part of the directory tree under which user searches should be performed. If user-search-base isn’t supplied, the search will be performed from the root.
--user-search-filter: The filter to use when searching for a user’s DN. Will search either from user-search-base (if specified) or root for entires matching the filter, then attempt to bind as that user with the login password. For example, the filter ‘uid={0}’ would apply to any user where uid matched the user’s login name. If –user-dn-pattern is also specified, will attempt to find a match using the specified pattern first, before searching with the specified search filter if no match is found from the pattern.

hal config security authn ldap enable

Set the ldap method as enabled

Usage

hal config security authn ldap enable [parameters]

Parameters

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

hal config security authn oauth2

Configure the oauth2 method for authenticating.

Usage

hal config security authn oauth2 [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 the oauth2 method as disabled
edit: Edit the oauth2 authentication method.
enable: Set the oauth2 method as enabled

hal config security authn oauth2 disable

Set the oauth2 method as disabled

Usage

hal config security authn oauth2 disable [parameters]

Parameters

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

hal config security authn oauth2 edit

Edit the oauth2 authentication method.

Usage

hal config security authn oauth2 edit [parameters]

Parameters

--access-token-uri: The access token uri for your OAuth provider.
--client-authentication-scheme: The client authentication scheme for your OAuth provider.
--client-id: The OAuth client ID you have configured with your OAuth provider.
--client-secret: The OAuth client secret you have configured with your OAuth provider.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--pre-established-redirect-uri: The externally accessible URL for Gate. For use with load balancers that do any kind of address manipulation for Gate traffic, such as an SSL terminating load balancer.
--provider: The OAuth provider handling authentication. The supported options are Google, GitHub, Oracle, Azure and Other
--scope: The scope for your OAuth provider.
--user-authorization-uri: The user authorization uri for your OAuth provider.
--user-info-mapping-email: The email field returned from your OAuth provider.
--user-info-mapping-first-name: The first name field returned from your OAuth provider.
--user-info-mapping-last-name: The last name field returned from your OAuth provider.
--user-info-mapping-username: The username field returned from your OAuth provider.
--user-info-requirements: (Default: (empty)) The map of requirements the userInfo request must have. This is used to restrict user login to specific domains or having a specific attribute. Use equal signs between key and value, and additional key/value pairs need to repeat the flag. Example: ‘–user-info-requirements foo=bar –userInfoRequirements baz=qux’.
--user-info-uri: The user info uri for your OAuth provider.

hal config security authn oauth2 enable

Set the oauth2 method as enabled

Usage

hal config security authn oauth2 enable [parameters]

Parameters

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

hal config security authn saml

Configure the saml method for authenticating.

Usage

hal config security authn saml [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 the saml method as disabled
edit: Configure authentication using a SAML identity provider.
enable: Set the saml method as enabled

hal config security authn saml disable

Set the saml method as disabled

Usage

hal config security authn saml disable [parameters]

Parameters

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

hal config security authn saml edit

SAML authenticates users by passing cryptographically signed XML documents between the Gate server and an identity provider. Gate’s key is stored and accessed via the –keystore parameters, while the identity provider’s keys are included in the metadata.xml. Finally, the identity provider must redirect the control flow (through the user’s browser) back to Gate by way of the –serviceAddressUrl. This is likely the address of Gate’s load balancer.

Usage

hal config security authn saml edit [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--issuer-id: The identity of the Spinnaker application registered with the SAML provider.
--keystore: Path to the keystore that contains this server’s private key. This key is used to cryptographically sign SAML AuthNRequest objects.
--keystore-alias: The name of the alias under which this server’s private key is stored in the –keystore file.
--keystore-password: The password used to access the file specified in –keystore
--metadata: The address to your identity provider’s metadata XML file. This can be a URL or the path of a local file.
--no-validate: (Default: false) Skip validation.
--service-address-url: The address of the Gate server that will be accesible by the SAML identity provider. This should be the full URL, including port, e.g. https://gate.org.com:8084/ . If deployed behind a load balancer, this would be the laod balancer’s address.
--user-attribute-mapping-email: The email field returned from your SAML provider.
--user-attribute-mapping-first-name: The first name field returned from your SAML provider.
--user-attribute-mapping-last-name: The last name field returned from your SAML provider.
--user-attribute-mapping-roles: The roles field returned from your SAML provider.
--user-attribute-mapping-roles-delimiter: The roles delimiter field returned from your SAML provider.
--user-attribute-mapping-username: The username field returned from your SAML provider.

hal config security authn saml enable

Set the saml method as enabled

Usage

hal config security authn saml enable [parameters]

Parameters

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

hal config security authn x509

Configure the x509 method for authenticating.

Usage

hal config security authn x509 [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 the x509 method as disabled
edit: Configure authentication and role information for a x509 authentication scheme
enable: Set the x509 method as enabled

hal config security authn x509 disable

Set the x509 method as disabled

Usage

hal config security authn x509 disable [parameters]

Parameters

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

hal config security authn x509 edit

x509 authenticates users via client certificate and a corresponding private key These certificates optionally provide authorization information via custom Oids with corresponding group information for the user. This can be configured via –roleOid

Usage

hal config security authn x509 edit [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--role-oid: The OID that encodes roles that the user specified in the x509 certificate belongs to
--subject-principal-regex: The regex used to parse the subject principal name embedded in the x509 certificate if necessary

hal config security authn x509 enable

Set the x509 method as enabled

Usage

hal config security authn x509 enable [parameters]

Parameters

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

hal config security authz

This set of commands allows you to configure what resources users of Spinnaker can read and modify.

Usage

hal config security authz [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 Spinnaker’s role-based authorization to disabled
edit: Edit your roles provider settings.
enable: Set Spinnaker’s role-based authorization to enabled
file: Configure the file role provider.
github: Configure the github role provider.
google: Configure the google role provider.
ldap: Configure the ldap role provider.

hal config security authz disable

Set Spinnaker’s role-based authorization to disabled

Usage

hal config security authz disable [parameters]

Parameters

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

hal config security authz edit

Edit your roles provider settings.

Usage

hal config security authz edit [parameters]

Parameters

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

hal config security authz enable

Set Spinnaker’s role-based authorization to enabled

Usage

hal config security authz enable [parameters]

Parameters

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

hal config security authz file

Configure the file role provider.

Usage

hal config security authz file [parameters] [subcommands]

Parameters

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

Subcommands

edit: Edit the file role provider.

hal config security authz file edit

Edit the file role provider.

Usage

hal config security authz file edit [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--file-path: A path to a file describing the roles of each user.
--no-validate: (Default: false) Skip validation.

hal config security authz github

Configure the github role provider.

Usage

hal config security authz github [parameters] [subcommands]

Parameters

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

Subcommands

edit: Edit the github role provider.

hal config security authz github edit

Edit the github role provider.

Usage

hal config security authz github edit [parameters]

Parameters

--accessToken: A personal access token of an account with access to your organization’s GitHub Teams structure.
--baseUrl: Used if using GitHub enterprise some other non github.com GitHub installation.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--organization: The GitHub organization under which to query for GitHub Teams.

hal config security authz google

Configure the google role provider.

Usage

hal config security authz google [parameters] [subcommands]

Parameters

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

Subcommands

edit: Edit the google role provider.

hal config security authz google edit

Edit the google role provider.

Usage

hal config security authz google edit [parameters]

Parameters

--admin-username: Your role provider’s admin username e.g. admin@myorg.net
--credential-path: A path to a valid json service account that can authenticate against the Google role provider.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--domain: The domain your role provider is configured for e.g. myorg.net.
--no-validate: (Default: false) Skip validation.

hal config security authz ldap

Configure the ldap role provider.

Usage

hal config security authz ldap [parameters] [subcommands]

Parameters

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

Subcommands

edit: Edit the ldap role provider.

hal config security authz ldap edit

Edit the ldap role provider.

Usage

hal config security authz ldap edit [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--group-role-attributes: The attribute which contains the name of the authority defined by the group entry. Defaults to ‘cn’.
--group-search-base: The part of the directory tree under which group searches should be performed.
--group-search-filter: The filter which is used to search for group membership. The default is ‘uniqueMember={0}’, corresponding to the groupOfUniqueMembers LDAP class. In this case, the substituted parameter is the full distinguished name of the user. The parameter ‘{1}’ can be used if you want to filter on the login name.
--manager-dn: The manager user’s distinguished name (principal) to use for querying ldap groups.
--manager-password: (Sensitive data - user will be prompted on standard input) The manager user’s password to use for querying ldap groups.
--no-validate: (Default: false) Skip validation.
--url: ldap:// or ldaps:// url of the LDAP server
--user-dn-pattern: The pattern for finding a user’s DN using simple pattern matching. For example, if your LDAP server has the URL ldap://mysite.com/dc=spinnaker,dc=org , and you have the pattern ‘uid={0},ou=members’, ‘me’ will map to a DN uid=me,ou=members,dc=spinnaker,dc=org. If no match is found, will try to find the user using –user-search-filter, if set.
--user-search-base: The part of the directory tree under which user searches should be performed. If –user-search-base isn’t supplied, the search will be performed from the root.
--user-search-filter: The filter to use when searching for a user’s DN. Will search either from –user-search-base (if specified) or root for entires matching the filter.

hal config security ui

Configure and view the UI server’s addressable URL.

Usage

hal config security ui [parameters] [subcommands]

Parameters

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

Subcommands

edit: Configure access policies specific to Spinnaker’s UI server.
ssl: Configure and view SSL settings for Spinnaker’s UI gateway.

hal config security ui edit

When Spinnaker is deployed to a remote host, the UI server may be configured to do SSL termination, or sit behind an externally configured proxy server or load balancer.

Usage

hal config security ui edit [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--override-base-url: If you are accessing the UI server remotely, provide the full base URL of whatever proxy or load balancer is fronting the UI requests.

hal config security ui ssl

If you want the UI server to do SSL termination, it must be enabled and configured here. If you are doing your own SSL termination, leave this disabled.

Usage

hal config security ui ssl [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: Disable SSL for the UI gateway.
edit: Edit SSL settings for your UI server.
enable: Enable SSL for the UI gateway.

hal config security ui ssl disable

Disable SSL for the UI gateway.

Usage

hal config security ui ssl disable [parameters]

Parameters

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

hal config security ui ssl edit

Configure SSL termination to handled by the UI server’s Apache server.

Usage

hal config security ui ssl edit [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--ssl-certificate-ca-file: Path to the .crt file for the CA that issued your SSL certificate. This is only needed for localgitdeployments that serve the UI using webpack dev server.
--ssl-certificate-file: Path to your .crt file.
--ssl-certificate-key-file: Path to your .key file.
--ssl-certificate-passphrase: (Sensitive data - user will be prompted on standard input) The passphrase needed to unlock your SSL certificate. This will be provided to Apache on startup.

hal config security ui ssl enable

Enable SSL for the UI gateway.

Usage

hal config security ui ssl enable [parameters]

Parameters

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

hal config stats

Show Spinnaker’s stats settings.

Usage

hal config stats [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 Spinnaker’s stats settings to disabled.
edit: Edit Spinnaker’s stats settings.
enable: Set Spinnaker’s stats settings to enabled.

hal config stats disable

Set Spinnaker’s stats settings to disabled.

Usage

hal config stats disable [parameters]

Parameters

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

hal config stats edit

Edit Spinnaker’s stats settings.

Usage

hal config stats edit [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--endpoint: Set the endpoint for stats metrics.
--no-validate: (Default: false) Skip validation.

hal config stats enable

Set Spinnaker’s stats settings to enabled.

Usage

hal config stats enable [parameters]

Parameters

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

hal config storage

Show Spinnaker’s persistent storage configuration.

Usage

hal config storage [parameters] [subcommands]

Parameters

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

Subcommands

azs: Manage and view Spinnaker configuration for the “azs” persistent store.
edit: Edit Spinnaker’s persistent storage.
gcs: Manage and view Spinnaker configuration for the “gcs” persistent store.
oracle: Manage and view Spinnaker configuration for the “oracle” persistent store.
s3: Manage and view Spinnaker configuration for the “s3” persistent store.

hal config storage azs

Manage and view Spinnaker configuration for the “azs” persistent store.

Usage

hal config storage azs [parameters] [subcommands]

Parameters

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

Subcommands

edit: Edit configuration for the “azs” persistent store.

hal config storage azs edit

Edit configuration for the “azs” persistent store.

Usage

hal config storage azs edit [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--storage-account-key: The key to access the Azure Storage Account used for Spinnaker’s persistent data.
--storage-account-name: The name of an Azure Storage Account used for Spinnaker’s persistent data.
--storage-container-name: (Default: spinnaker) The container name in the chosen storage account to place all of Spinnaker’s persistent data.

hal config storage edit

Edit Spinnaker’s persistent storage.

Usage

hal config storage edit [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--type: (Required) The type of the persistent store to use for Spinnaker.

hal config storage gcs

Manage and view Spinnaker configuration for the “gcs” persistent store.

Usage

hal config storage gcs [parameters] [subcommands]

Parameters

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

Subcommands

edit: Edit configuration for the “gcs” persistent store.

hal config storage gcs edit

Edit configuration for the “gcs” persistent store.

Usage

hal config storage gcs edit [parameters]

Parameters

--bucket: The name of a storage bucket that your specified account has access to. If not specified, a random name will be chosen. If you specify a globally unique bucket name that doesn’t exist yet, Halyard will create that bucket for you.
--bucket-location: This is only required if the bucket you specify doesn’t exist yet. In that case, the bucket will be created in that location. See https://cloud.google.com/storage/docs/managing-buckets#manage-class-location .
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--json-path: A path to a JSON service account with permission to read and write to the bucket to be used as a backing store.
--no-validate: (Default: false) Skip validation.
--project: The Google Cloud Platform project you are using to host the GCS bucket as a backing store.
--root-folder: The root folder in the chosen bucket to place all of Spinnaker’s persistent data in.

hal config storage oracle

Manage and view Spinnaker configuration for the “oracle” persistent store.

Usage

hal config storage oracle [parameters] [subcommands]

Parameters

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

Subcommands

edit: Edit configuration for the “oracle” persistent store.

hal config storage oracle edit

Edit configuration for the “oracle” persistent store.

Usage

hal config storage oracle edit [parameters]

Parameters

--bucket-name: The bucket name to store persistent state object in
--compartment-id: Provide the OCID of the Oracle Compartment to use.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--fingerprint: Fingerprint of the public key
--namespace: The namespace the bucket and objects should be created in
--no-validate: (Default: false) Skip validation.
--private-key-passphrase: (Sensitive data - user will be prompted on standard input) Passphrase used for the private key, if it is encrypted
--region: An Oracle region (e.g., us-phoenix-1)
--ssh-private-key-file-path: Path to the private key in PEM format
--tenancy-id: Provide the OCID of the Oracle Tenancy to use.
--user-id: Provide the OCID of the Oracle User you’re authenticating as

hal config storage s3

Manage and view Spinnaker configuration for the “s3” persistent store.

Usage

hal config storage s3 [parameters] [subcommands]

Parameters

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

Subcommands

edit: Edit configuration for the “s3” persistent store.

hal config storage s3 edit

Edit configuration for the “s3” persistent store.

Usage

hal config storage s3 edit [parameters]

Parameters

--access-key-id: Your AWS Access Key ID. If not provided, Halyard/Spinnaker will try to find AWS credentials as described at http://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html#credentials-default
--assume-role: If set, Halyard will configure a credentials provider that uses AWS Security Token Service to assume the specified role.

Example: “user/spinnaker” or “role/spinnakerManaged”

--bucket: The name of a storage bucket that your specified account has access to. If not specified, a random name will be chosen. If you specify a globally unique bucket name that doesn’t exist yet, Halyard will create that bucket for you.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--endpoint: An alternate endpoint that your S3-compatible storage can be found at. This is intended for self-hosted storage services with S3-compatible APIs, e.g. Minio. If supplied, this storage type cannot be validated.
--no-validate: (Default: false) Skip validation.
--path-style-access: (Default: false) when true, use path-style to access bucket; when false, use virtual hosted-style to access bucket. See https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingExamples .
--region: This is only required if the bucket you specify doesn’t exist yet. In that case, the bucket will be created in that region. See http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region .
--root-folder: The root folder in the chosen bucket to place all of Spinnaker’s persistent data in.
--secret-access-key: (Sensitive data - user will be prompted on standard input) Your AWS Secret Key.
--server-side-encryption: Use Amazon Server-Side Encryption (‘x-amz-server-side-encryption’ header). Supports ‘AES256’ (for Amazon S3-managed encryption keys, equivalent to a header value of ‘AES256’) and ‘AWSKMS’ (for AWS KMS-managed encryption keys, equivalent to a header value of ‘aws:kms’.

hal config version

Configure & view the current deployment of Spinnaker’s version.

Usage

hal config version [parameters] [subcommands]

Parameters

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

Subcommands

edit: Set the desired Spinnaker version.

hal config version edit

Set the desired Spinnaker version.

Usage

hal config version edit [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--version: (Required) Must be either a version number “X.Y.Z” for a specific release of Spinnaker, or “$BRANCH-latest-unvalidated” for the most recently built (unvalidated) Spinnaker on $BRANCH.

hal config webhook

Show Spinnaker’s webhook configuration.

Usage

hal config webhook [parameters] [subcommands]

Parameters

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

Subcommands

trust: Show Spinnaker’s webhook trust configuration.

hal config webhook trust

Show Spinnaker’s webhook trust configuration.

Usage

hal config webhook trust [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 Spinnaker’s webhook trust to disabled.
edit: Edit Spinnaker’s webhook trust configuration.
enable: Set Spinnaker’s webhook trust to enabled.

hal config webhook trust disable

Set Spinnaker’s webhook trust to disabled.

Usage

hal config webhook trust disable [parameters]

Parameters

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

hal config webhook trust edit

Edit Spinnaker’s webhook trust configuration.

Usage

hal config webhook trust edit [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--trustStore: The path to a key store in JKS format containing certification authorities that should be trusted by webhook stages.
--trustStorePassword: (Sensitive data - user will be prompted on standard input) The password for the supplied trustStore.

hal config webhook trust enable

Set Spinnaker’s webhook trust to enabled.

Usage

hal config webhook trust enable [parameters]

Parameters

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

hal deploy

Manage the deployment of Spinnaker. This includes where it’s deployed, what the infrastructure footprint looks like, what the currently running deployment looks like, etc…

Usage

hal deploy [subcommands]

Subcommands

apply: Deploy or update the currently configured instance of Spinnaker to a selected environment.
clean: Remove all Spinnaker artifacts in your target deployment environment.
collect-logs: Collect logs from the specified Spinnaker services.
connect: Connect to your Spinnaker deployment.
details: Get details about your currently deployed Spinnaker installation.
diff: This shows what changes you have made since Spinnaker was last deployed.
rollback: Rollback Spinnaker to the prior version on a selected environment.

hal deploy apply

This command deploys Spinnaker, depending on how you’ve configured your deployment. Local deployments are applied to the machine running Halyard, whereas Distributed deployments are applied to a cloud provider. Local deployments are subject to downtime during updates, whereas Distributed deployments are deployed and updated via a headless ‘bootstrap’ deployment of Spinnaker, and don’t suffer downtime.

Usage

hal deploy apply [parameters]

Parameters

--auto-run: This command will generate a script to be run on your behalf. By default, the script will run without intervention - if you want to override this, provide “true” or “false” to this flag.
--delete-orphaned-services: (Default: false) Deletes unused Spinnaker services after the deploy succeeds. This flag is not allowed when using the –service-names or –exclude-service-names arg.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--exclude-service-names: (Default: []) When supplied, do not install or update the specified Spinnaker services.
--flush-infrastructure-caches: (Default: false) WARNING: This is considered an advanced command, and may break your deployment if used incorrectly.

This flushes infrastructure caches (clouddriver) after the deploy succeeds.

--no-validate: (Default: false) Skip validation.
--omit-config: (Default: false) WARNING: This is considered an advanced command, and may break your deployment if used incorrectly.

This guarantees that no configuration will be generated for this deployment. This is useful for staging artifacts for later manual configuration.

--prep-only: (Default: false) This does just the prep work, and not the actual deployment. Only useful at the moment if you want to just clone the repositories for a localgit setup.
--service-names: (Default: []) When supplied, only install or update the specified Spinnaker services.
--wait-for-completion: (Default: false) When supplied, wait for all containers to be ready before returning (only applies to Kubernetes V2 provider).
--wait-for-completion-timeout-minutes: Specify timeout for deploy apply command.

hal deploy clean

This command destroys all Spinnaker artifacts in your target deployment environment. This cannot be undone, so use with care. This does not delete Halyard nor any of the configuration.

Usage

hal deploy clean [parameters]

Parameters

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

hal deploy collect-logs

This command collects logs from all Spinnaker services, and depending on how it was deployed, it will collect logs from sidecars and startup scripts as well.

Usage

hal deploy collect-logs [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--exclude-service-names: (Default: []) When supplied, logs from the specified services will be not collected
--no-validate: (Default: false) Skip validation.
--service-names: (Default: []) When supplied, logs from only the specified services will be collected.

hal deploy connect

This command connects to your Spinnaker deployment, assuming it was already deployed. In the case of the Local* deployment type, this is a NoOp.

Usage

hal deploy connect [parameters]

Parameters

--auto-run: This command will generate a script to be run on your behalf. By default, the script will run without intervention - if you want to override this, provide “true” or “false” to this flag.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--service-names: (Default: []) When supplied, connections to the specified Spinnaker services are opened. When omitted, connections to the UI & API servers are opened to allow you to interact with Spinnaker in your browser.

hal deploy details

Get details about your currently deployed Spinnaker installation.

Usage

hal deploy details [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--service-name: (Required) The name of the service to inspect.

hal deploy diff

This shows what changes you have made since Spinnaker was last deployed.

Usage

hal deploy diff [parameters]

Parameters

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

hal deploy rollback

This command attempts to rollback Spinnaker to the prior deployed version, depending on how you’ve configured your deployment. Local deployments have their prior packages installed and reconfigured, whereas Distributed deployments are rolled back via a headless ‘bootstrap’ deployment of Spinnaker, and don’t suffer downtime.

Usage

hal deploy rollback [parameters]

Parameters

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--exclude-service-names: (Default: []) When supplied, do not install or update the specified Spinnaker services.
--no-validate: (Default: false) Skip validation.
--service-names: (Default: []) When supplied, only install or update the specified Spinnaker services.

hal plugins

Show Spinnaker’s configured plugins.

Usage

hal plugins [parameters] [subcommands]

Parameters

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

Subcommands

add: Add a plugin
delete: Delete a plugin
disable: Enable or disable all plugins
disable-downloading: Enable or disable the ability for Spinnaker services to download jars for plugins
edit: Edit a plugin
enable: Enable or disable all plugins
enable-downloading: Enable or disable the ability for Spinnaker services to download jars for plugins
list: List all plugins
repository: Configure, validate, and view the specified plugin repository.

hal plugins add

Add a plugin

Usage

hal plugins add PLUGIN [parameters]

Parameters

PLUGIN: The name of the plugin to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--enabled: To enable or disable the plugin.
--extensions: A comma separated list of extensions to enable
--no-validate: (Default: false) Skip validation.
--ui-resource-location: The location of the plugin’s ui resource.
--version: The plugin version to use

hal plugins delete

Delete a plugin

Usage

hal plugins delete PLUGIN [parameters]

Parameters

PLUGIN: The name of the plugin to operate on.

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

hal plugins disable

Enable or disable all plugins

Usage

hal plugins disable [parameters]

Parameters

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

hal plugins disable-downloading

Enable or disable the ability for Spinnaker services to download jars for plugins

Usage

hal plugins disable-downloading [parameters]

Parameters

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

hal plugins edit

Edit a plugin

Usage

hal plugins edit PLUGIN [parameters]

Parameters

PLUGIN: The name of the plugin to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--enabled: To enable or disable the plugin.
--extensions: A comma separated list of extensions to create
--no-validate: (Default: false) Skip validation.
--ui-resource-location: The location of the plugin’s ui resource.
--version: The plugin version to use

hal plugins enable

Enable or disable all plugins

Usage

hal plugins enable [parameters]

Parameters

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

hal plugins enable-downloading

Enable or disable the ability for Spinnaker services to download jars for plugins

Usage

hal plugins enable-downloading [parameters]

Parameters

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

hal plugins list

List all plugins

Usage

hal plugins list [parameters]

Parameters

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

hal plugins repository

Configure, validate, and view the specified plugin repository.

Usage

hal plugins repository [subcommands]

Subcommands

add: Add a plugin repository
delete: Delete a plugin repository
edit: Edit a plugin repository
list: List all plugin repositories

hal plugins repository add

Add a plugin repository

Usage

hal plugins repository add REPOSITORY [parameters]

Parameters

REPOSITORY: The name of the plugin repository to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--url: (Required) The location of the plugin repository.

hal plugins repository delete

Delete a plugin repository

Usage

hal plugins repository delete REPOSITORY [parameters]

Parameters

REPOSITORY: The name of the plugin repository to operate on.

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

hal plugins repository edit

Edit a plugin repository

Usage

hal plugins repository edit REPOSITORY [parameters]

Parameters

REPOSITORY: The name of the plugin repository to operate on.

--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.
--url: The location of the plugin repository.

hal plugins repository list

List all plugin repositories

Usage

hal plugins repository list [parameters]

Parameters

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

hal shutdown

Shutdown the halyard daemon.

Usage

hal shutdown

hal spin

Manage the lifecycle of spin CLI.

Usage

hal spin [subcommands]

Subcommands

install: Installs the spin CLI.

hal spin install

This command installs the spin CLI.

Usage

hal spin install [parameters]

Parameters

--auto-run: This command will generate a script to be run on your behalf. By default, the script will run without intervention - if you want to override this, provide “true” or “false” to this flag.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.

hal task

Every unit of work Halyard carries out is bundled in a Task. This set of commands exposes some information about these tasks. The commands here are mainly for troubleshooting.

Usage

hal task [subcommands]

Subcommands

interrupt: Interrupt (attempt to kill) a given task.
list: List the currently running Tasks.

hal task interrupt

Interrupt (attempt to kill) a given task.

Usage

hal task interrupt UUID

hal task list

List the currently running Tasks.

Usage

hal task list

hal version

Get information about the available Spinnaker versions.

Usage

hal version [subcommands]

Subcommands

bom: Get the Bill of Materials (BOM) for the specified version.
latest: Get the latest released, validated version number of Spinnaker.
list: List the available Spinnaker versions and their changelogs.

hal version bom

The Bill of Materials (BOM) is the manifest Halyard and Spinnaker use to agree on what subcomponent versions comprise a top-level release of Spinnaker. This command can be used with a main parameter (VERSION) to get the BOM for a given version of Spinnaker, or without a parameter to get the BOM for whatever version of Spinnaker you are currently configuring.

Usage

hal version bom VERSION [parameters]

Parameters

VERSION: The version whose Bill of Materials (BOM) to lookup.

--artifact-name: When supplied, print the version of this artifact only.
--deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
--no-validate: (Default: false) Skip validation.

hal version latest

Get the latest released, validated version number of Spinnaker.

Usage

hal version latest

hal version list

All Spinnaker releases that have been fully validated are listed here. You can pick one of these releases to deploy using the hal config version edit command. There are unlisted, non-supported releases as well, but we advise against running them. For more information, contact the developers on slack .

Usage

hal version list [parameters]

Parameters

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

Docs: Component Sizing

Mon, 01 Jan 0001 00:00:00 +0000

HALYARD IS DEPRECATED

[!IMPORTANT] At this time, halyard is considered deprecated and no longer supported.
This document is kept here and alive for historical purposes. Documentation should all be moved to native configuration files, and for more questions and information please join the spinnaker slack.

Custom sizing can be specified for each Spinnaker component within the Halyard configuration. You can either add these sizes to the Halyard config manually, or use any of the Halyard component sizing commands . This feature is currently only supported for distributed deployments using Kubernetes (hal config deploy edit --type distributed --account-name my-k8s-cluster).

Kubernetes

The following Kubernetes settings can be tweaked within custom sizing.

CPU & Memory requests/limits

Container requests and limits for cpu and memory can be specified in the deploymentEnvironment.customSizing section of the halconfig file.

There are two ways to specify requests and limits

(Recommended) By supplying the container name, e.g. echo:, followed by the container requests and limits.

This sets resource configuration for the echo container in spin-echo service’s pod only, not any sidecars (e.g. the monitoring daemon).
By supplying the service name, e.g. spin-clouddriver:, followed by the container requests and limits.

This sets the resource configuration for the clouddriver container as well as any sidecar containers in the spin-clouddriver service.

Here is an example of this configuration:

deploymentEnvironment:
  customSizing:
    # This applies sizings to only the echo container and not to any sidecar 
    # containers running with echo. (Use spin-<service> to include sidecars)
    echo:
      limits:
        cpu: 250m
        memory: 512Mi
      requests:
        cpu: 100m
        memory: 128Mi
    # This applies sizings to the clouddriver container as well as any sidecar 
    # containers running with clouddriver. (Use without spin- to only include the clouddriver container)
    spin-clouddriver:
      limits:
        cpu: 1000m
        memory: 1Gi
      requests:
        cpu: 250m
        memory: 512Mi

Limits and requests follow the Kubernetes conventions documented here .

Updating JAVA_OPTS

All JVM-based services have the following JAVA_OPTS set:

JAVA_OPTS=-XX:MaxRAMPercentage=50.0

This sets the JVM’s heap size to half the memory allocated per container. This can be overriden by specifying your own JAVA_OPTS using the env key in service-settings .

As a starting point, the -Xms can be set to 80%-90% of the requests memory allotment and -Xmx can be set to 80-90% of the limits memory allotment. For the clouddriver example above, the env key is as follows:

env:
   JAVA_OPTS: "-Xms410m -Xmx819m"

Recommendations

It is not recommended that limits and requests be applied to the bootstrapping pods. These pods can be scaled down to 0 once hal deploy apply has been completed. They will be relaunched the next time a hal deploy apply is executed.

Optimal sizings for your components will depend upon your environment, but in general clouddriver and orca will need to be larger than the rest of the components, additionally echo may also need to be larger if using event hooks.

Replicas

The number of desired replicas for a component can be specified within customSizing like so:

customSizing:
  spin-[component name]:
    replicas: 2

If the number of replicas isn’t specified for a component halyard will deploy said component with the same number of replicas it had during the previous deployment. On the initial deployment of spinnaker all pods will default to 1 replica if nothing is specified within customSizing.

Important: To avoid duplicate triggering, echo and igor must each be deployed with exactly one pod.

Docs: Custom Settings

Mon, 01 Jan 0001 00:00:00 +0000

HALYARD IS DEPRECATED

[!IMPORTANT] At this time, halyard is considered deprecated and no longer supported.
This document is kept here and alive for historical purposes. Documentation should all be moved to native configuration files, and for more questions and information please join the spinnaker slack.

Furthermore, some users will be more comfortable forgoing Halyard’s configuration generation, or will want to port their old Spinnaker configuration into Halyard. For these users & use-cases, Halyard supports custom Profiles , and custom Service Settings .

Custom Profiles versus Service settings

The two most common ways of customizing your Spinnaker installation is through the use of either a custom profile, for example clouddriver-local.yml, or a service setting, for example clouddriver.yml. Each of these is created in separate subfolders inside the main Halyard deployment profile folder. In a default Halyard profile, this means profiles go in .hal/default/profiles/ while service settings go in .hal/default/service-settings.

Custom profiles are configuration files that override the default configuration files for each Spinnaker Service. Service-Settings are used by Halyard to determine how to build the Spinnaker deployment and contain information specific to how each Spinnaker Service will be deployed.

For example, if you want to substitute which image file will be used for a Spinnaker service, or what environment variables the service will be run with, then you’ll need to modify the service settings for that service.

To override the debugging level specified in clouddriver.yml, create a custom clouddriver-local.yml file and put it in the /profiles/ directory.

Custom Profiles

If you want to supply custom Profiles, for a particular Deployment ($DEPLOYMENT, typically default) place them in ~/.hal/$DEPLOYMENT/profiles/. The will override any profiles generated by Halyard, and will be copied over by Profile name.

For example, if you want to supply a different clouddriver.yml, you can do so by placing it in ~/.hal/$DEPLOYMENT/profiles/clouddriver.yml, and running hal deploy apply.

For any of the Spring based services, any profile matching ${SERVICENAME}-.*\.yml will be copied and applied to $SERVICENAME. Since this approach will completely overwrite the generated service, and you may want to only supply a few flags, you can instead provide them in ${SERVICENAME}-local.yml, which will always be loaded by $SERVICENAME with no further configuration needed. Further Spring Profiles can be activated by configuring their env to include SPRING_PROFILES_ACTIVE entries for your desired service. See the below Custom Service Settings for more information.

You can validate that your Custom Profiles have been picked up and applied to their services by checking ~/.hal/$DEPLOYMENT/history/service-profiles.yml.

Custom Profile for Deck

To supply custom settings or new values that override generated settings for the Deck UI, you can place them in a file called settings-local.js. For example, to enable the chaosMonkey feature flag, you can create the following file:

~/.hal/default/profiles/settings-local.js:

window.spinnakerSettings.feature.chaosMonkey = true

Custom Service Settings

For each service, $SERVICENAME, you can supply a file ~/.hal/$DEPLOYMENT/service-settings/$SERVICENAME.yml to override any settings as found in ~/.hal/$DEPLOYMENT/history/service-settings.yml. For example, if you wanted Echo to listen on port 443 with the JAVA_OPTS="-Xms256m -Xmx512m" environment variables set, you create the following file:

~/.hal/default/service-settings/echo.yml:

port: 443
env:
  JAVA_OPTS: '-Xms256m -Xmx512m'

If you wanted to specify a secure connection to redis, you would create the following file:

~/.hal/default/service-settings/redis.yml:

overrideBaseUrl: redis://someuser:somepassword@localhost:6379

Tweakable Service Settings

Below are all the Service Settings you can configure. Keep in mind the ones generated by Halyard are generally best and are all that we test, so there is no guarantee making changes to these will result in a working Spinnaker cluster.

Value	Description
`address`	The address other services will use to lookup this service; e.g. `localhost` or `redis.service.spinnaker.consul`.
`artifactId`	A fully-qualified identifier for the Artifact this service is to run - see your Service Settings output path for examples, since this varies by platform/deployment environment.
`basicAuthEnabled`	Whether or not to enable HTTP basic auth for this service.
`enabled`	Whether or not this service is enabled. Be careful, since disabling critical services like `consul-client` can make your entire installation unusable and un-upgradable.
`env`	Environment variables to make available to this Service. Supplied as YAML key-value pairs.
`healthEndpoint`	The HTTP endpoint that can be queried for health status. Leave empty if you want Halyard to simply check that a TCP connection is openable. This information is typically transmitted to the platform’s discovery system.
`host`	The host that this service will bind to. `0.0.0.0` will always work, but more restrictive bindings may be more secure.
`kubernetes`	You can add Kubernetes specific service settings, see details below.
`location`	The Spinnaker “location” this will be installed in. This is a namespace in Kubernetes, and a zone in GCE.
`monitored`	Whether or not this has monitoring endpoints exposed.
`overrideBaseUrl`	The baseURL this service is reachable on. This is already made configurable for Deck & Gate via `hal config security`, since these are both public-facing and may service from different hosts than they are discoverable on internal to Spinnaker.
`port`	The port number this service is bound to, and will accept requests on.
`safeToUpdate`	Whether or not this service can be shutdown, and spun on a new VM/container. This protects datastores like Vault & Redis from being taken down from Halyard.
`scheme`	The URI scheme for addressing this service, e.g. `http` vs. `https`.
`skipLifeCycleManagement`	Whether or not Halyard should skip managing a service’s life cycle.
`targetSize`	The initial number of nodes this service will be created with. This is only respected on the initial deployment, and further edits will be rejected in favor of the prior service version’s size.

Kubernetes

Inside the kubernetes item at the top level you can add a number of custom service settings that impact how the Spinnaker services are deployed onto a Kubernetes cluster. This lets you partially configure how the Kubernetes Deployment, Service, Pods and other Kubernetes resources are deployed by Halyard. This allows you to do things like add a Kubernetes secret or emptydir to be mounted as a Volume and VolumeMount, change the default Kubernetes deployment strategy and more.

At a high level, the configurable items inside the Kubernetes service settings are:

Item	Details
`deploymentStrategy`	Defines either `RollingUpdate` or `Recreate` deployment strategy, including setting `MaxSurge` and `MaxUnavailable` See Deployment Strategy below.
`imagePullSecrets`	Define secrets to use to pull a custom artifact when using an artifactId to swap out docker image. More details can be found in the Image Pull Secrets section .
`nodePort`	When using a serviceType of NodePort, this provides the NodePort value.
`nodeSelectors`	Provide a list of `nodeSelectors` key-value pairs to add to the pod specification. See Node Selectors below.
`affinity`	Provide a list of `affinity` rules applied to a Spinnaker component’s pod specification. See Affinity below.
`podAnnotations`	Provide a list of annotations to put on the deployed pods. See Annotations and Labels below.
`podLabels`	Provide a list of labels to put on the deployed pods. See Annotations and Labels below.
`securityContext`	Set the securityContext that the Spinnaker services should run using in Kubernetes
`serviceAnnotations`	Provide a list of annotations to put on the deployed services. See Annotations and Labels below.
`serviceLabels`	Provide a list of labels to put on the deployed services. See Annotations and Labels below.
`serviceAccountName`	Provide a default `serviceAccount` under which to run Spinnaker services.
`serviceType`	Define a specific serviceType for deployed services, `ClusterIP` (Default) or `NodePort`
`useExecHealthCheck`	Disable the exec-based healthcheck if necessary. See useExecHealthCheck for details.
`volumes`	Define a set of `Volume` and `VolumeMount` items to be attached to the Pods through the Deployment. See Custom Volumes

imagePullSecrets

If making use of custom artifactIds from an authenticated docker registry imagePullSecrets must be made available in the replicaset definition. To specify imagePullSecrets to custom artifactIds they can be specified as follows:

kubernetes:
  imagePullSecrets:
  - desired-image-pull-secret1
  - desired-image-pull-secret2

podAnnotations, podLabels and serviceAnnotations, serviceLabels

Annotations and labels hold metadata that can be used to specify special behavior within Kubernetes. To apply annotations or labels to the Pod and Service resources for a particular Spinnaker service you can use something like:

kubernetes:
  podAnnotations:
    example/podAnnotation: spinnaker.io
    example/podAnnotation-2: halyard
  podLabels:
    examplePodLabel: examplePodLabelValue
  serviceLabels:
    exampleServiceLabel: exampleServiceLabelValue
  serviceAnnotations:
    example/serviceAnnotation: spinnaker.io
    example/serviceAnnotation-2: halyard

These are all optional ways to control what metadata elements exist on the resources deployed by Halyard. For additional information about how these can be used, you can look at the Annotations or Labels and Selectors pages from Kubernetes.

nodeSelectors

Node selector annotations will put out nodeSelector values in the Pod specification. They generally follow a similar syntax to the annotations and labels. For example:

kubernetes:
  nodeSelector:
     exampleNodeKey: exampleNodeValue
  deploymentEnvironment:
    nodeSelector:
      exampleNodeKey: exampleNodeValue

Additional information regarding Node Selectors can be found in the Kubernetes NodeSelector documentation .

affinity

Affinity annotations generate affinity values in the Pod specification and are more expressive than nodeSelector. You can set precedence rather than specify an affinity hard requirement. The two types are node affinity and inter-pod affinity/anti-affinity.

Provide configuration per spinnaker component like the below example.

kubernetes:
  deploymentEnvironment:
    affinity:
      spin-clouddriver:
        nodeAffinity:
          requiredDuringSchedulingIgnoredDuringExecution:
            nodeSelectorTerms:
            - matchExpressions:
              - key: spinnaker
                operator: In
                values:
                - 'true'

See the Kubernetes affinity documentation for more information.

useExecHealthCheck

By default halyard deploys services with an exec-based health check in order to improve compatibility with Istio. This however can break functionality for implementations of Load Balancer service types and Ingress Controllers that rely on having an http health check to validate. Setting kubernetes.useExecHealthCheck: false will switch the check method to be http based for such use cases.

Using Custom Volumes

You can define a set of custom volumes for a particular service that will become Volume and VolumeMount items in the generated pod specifications when Halyard deploys Spinnaker on Kubernetes. This can be useful if you need to add custom CA Certificates or other files to Spinnaker service consistently.

The Kubernetes service settings allow you to mount volumes of type configMap, secret and emptyDir with the below syntax.

kubernetes:
  volumes:
  - id: secret-example-vol
    type: secret
    mountPath: /path/to/location/of/secret
  - id: configmap-example-vol
    type: configMap
    mountPath: /path/to/location/of/configMap
  - id: emptydir-example-vol
    type: emptyDir
    mountPath: /path/to/location/of/emptyDir

Make sure that the id field matches the name of the existing secret or configmap resource in Kubernetes that you need mounted.

Deployment Strategy

You can change the deployment strategy that Kubernetes uses when deploying Spinnaker services. For example, if you wanted to adjust the maxSurge and maxUnavailable percentages for a rolling update of Clouddriver, you would define a clouddriver.yml file in your Halyard service-settings like the one below.

kubernetes:
  deploymentStrategy:
    type: rollingUpdate
    strategySettings:
      maxSurge: 100%
      maxUnavailable: 50%

If you wanted to use a Recreate strategy instead, you would use:

kubernetes:
  deploymentStrategy:
    type: recreate

For additional information regarding the implication of each of these deployment strategies, consult the Updating a Deployment documentation.

Docs: High Availability

Mon, 01 Jan 0001 00:00:00 +0000

HALYARD IS DEPRECATED

[!IMPORTANT] At this time, halyard is considered deprecated and no longer supported.
This document is kept here and alive for historical purposes. Documentation should all be moved to native configuration files, and for more questions and information please join the spinnaker slack.

The majority of the relevant information has been moved to high-availability documentation

This page describes how you can configure a Halyard deployment to increase the availability of specific services beyond simply horizontally scaling the service. Halyard does this by splitting the functionalities of a service into separate logical roles (also known as sharding). The benefits of doing this is specific to the service that is being sharded. These deployment strategies are inspired by Netflix’s large scale experience .

When sharded, the new logical services are given new names. This means that these logical services can be configured and scaled independently of each other.

Currently, this feature is only for Clouddriver and Echo.

Important: Halyard only supports this functionality for a distributed Spinnaker deployment configured with the Kubernetes provider .

HA Clouddriver

graph TB clouddriver(Clouddriver) --> clouddriver-caching(Clouddriver-Caching); clouddriver --> clouddriver-rw(Clouddriver-RW); clouddriver --> clouddriver-ro(Clouddriver-RO); clouddriver --> clouddriver-ro-deck(Clouddriver-RO-Deck) classDef default fill:#d8e8ec,stroke:#39546a; linkStyle default stroke:#39546a,stroke-width:1px,fill:none; classDef split fill:#42f4c2,stroke:#39546a; class clouddriver-caching,clouddriver-ro,clouddriver-ro-deck,clouddriver-rw,echo-scheduler,echo-worker split

Clouddriver benefits greatly from isolating its operations into separate services. To split Clouddriver for increased availability, run:

hal config deploy ha clouddriver enable

When Spinnaker is deployed with this flag enabled, Clouddriver will be deployed as four different services, each only performing a subset of the base Clouddriver’s operations.

Although by default the four Clouddriver services will communicate with the global Redis (all Spinnaker services speak to this Redis) provided by Halyard, it is recommended that the logical Clouddriver services be configured to communicate with an external Redis service. To be most effective, clouddriver-ro should be configured to speak to a Redis read replica, clouddriver-ro-deck should be configured to speak to a different Redis read replica, and the other two should be configured to speak to the master. This is handled automatically by Halyard if the user provides the two endpoints using this command:

hal config deploy ha clouddriver edit --redis-master-endpoint $REDIS_MASTER_ENDPOINT --redis-slave-endpoint $REDIS_SLAVE_ENDPOINT --redis-slave-deck-endpoint $REDIS_SLAVE_DECK_ENDPOINT

The values for REDIS_MASTER_ENDPOINT, REDIS_SLAVE_ENDPOINT, and REDIS_SLAVE_DECK_ENDPOINT must be valid Redis URIs .

More information on Redis replication can be found here .

`clouddriver-caching`

The first of the four logical Clouddriver services is the clouddriver-caching service. This service caches and retrieves cloud infrastructure data. Since this is all that clouddriver-caching is doing, there is no communication between this service and any other Spinnaker service.

This service’s name when configuring its sizing is spin-clouddriver-caching.

To add a custom profile or custom service settings for this service, use the name clouddriver-caching.

`clouddriver-rw`

The second logical Clouddriver service is the clouddriver-rw service. This service handles all mutating operations aside from what the clouddriver-caching service does. This service can be scaled to handle an increased number of writes.

This service’s name when configuring its sizing is spin-clouddriver-rw.

To add a custom profile or custom service settings for this service, use the name clouddriver-rw.

`clouddriver-ro`

The clouddriver-ro service handles all read requests to Clouddriver. This service can be scaled to handle an increased number of reads.

This service’s name when configuring its sizing is spin-clouddriver-ro.

To add a custom profile or custom service settings for this service, use the name clouddriver-ro.

`clouddriver-ro-deck`

The clouddriver-ro-deck service handles all read requests to Clouddriver from Deck (through Gate). This service can be scaled to handle an increased number of reads.

This service’s name when configuring its sizing is spin-clouddriver-ro-deck.

To add a custom profile or custom service settings for this service, use the name clouddriver-ro-deck.

HA Echo

graph TB echo(Echo) --> echo-scheduler(Echo-Scheduler); echo(Echo) --> echo-worker(Echo-Worker); classDef default fill:#d8e8ec,stroke:#39546a; linkStyle default stroke:#39546a,stroke-width:1px,fill:none; classDef split fill:#42f4c2,stroke:#39546a; class clouddriver-caching,clouddriver-ro,clouddriver-rw,echo-scheduler,echo-worker split

Echo can be split into two separate services that handle different operations. To split Echo for increased availability, run:

hal config deploy ha echo enable

When Spinnaker is deployed with this enabled, Echo will be deploy as two different services:

Although only the echo-worker service can be horizontally scaled, splitting the services will reduce the load on both.

`echo-scheduler`

The echo-scheduler service handles scheduled tasks, or cron-jobs. Since it performs its tasks periodically (no triggers) there is no need for communication with other Spinnaker services.

This service’s name when configuring its sizing is spin-echo-scheduler. To avoid duplicate triggering, this service must be deployed with exactly one pod.

To add a custom profile or custom service settings for this service, use the name echo-scheduler.

`echo-worker`

The echo-worker service handles all operations of Echo besides the cron-jobs.

This service’s name when configuring its sizing is spin-echo-worker. This service can be scaled to more than one pod, unlike the echo-scheduler.

To add a custom profile or custom service settings for this service, use the name echo-worker.

Deleting Orphaned Services

When enabling or disabling HA for a service on a running Spinnaker, Halyard will not clean up the old service(s) by default. This means that if a non-HA Clouddriver is running (for example) and Spinnaker is then deployed with HA Clouddriver enabled, the non-HA Clouddriver will still be running, even though it is no longer used. To clean up these orphaned services, add a --delete-orphaned-services flag to hal deploy apply:

hal deploy apply --delete-orphaned-services

HA Topology

With all services enabled for high availability, the new architecture looks like this:

graph TB deck(Deck) --> gate; api(Custom Script/API Caller) --> gate(Gate); gate --> kayenta(Kayenta); gate --> orca(Orca); gate --> clouddriver-ro(Clouddriver-RO); gate --> clouddriver-ro-deck(Clouddriver-RO-Deck) orca --> clouddriver-rw(Clouddriver-RW); gate --> rosco(Rosco); orca --> front50; orca --> rosco; gate --> front50(Front50); gate --> fiat(Fiat); orca --> kayenta; clouddriver-ro --> fiat; clouddriver-ro-deck --> fiat; clouddriver-rw --> fiat; orca --> fiat; front50 --> fiat; echo-worker(Echo-Worker) --> orca; echo-worker --> front50; igor(Igor) --> echo-worker; clouddriver-caching(Clouddriver-Caching); echo-scheduler(Echo-Scheduler); classDef default fill:#d8e8ec,stroke:#39546a; linkStyle default stroke:#39546a,stroke-width:1px,fill:none; classDef external fill:#c0d89d,stroke:#39546a; class deck,api external classDef split fill:#42f4c2,stroke:#39546a; class clouddriver-caching,clouddriver-ro,clouddriver-ro-deck,clouddriver-rw,echo-scheduler,echo-worker split

Recoverability

If you’ve configured an external Redis , Spinnaker can recover from failure events. Igor is responsible for polling the state store (Redis) and recreating state. During a recovery, numerous old pipelines may be re-triggered. To protect against this scenario, Igor has a setting called pollingSafeguard.itemUpperThreshold, which is the max number of pipeline triggers to accept before recognizing the scenario of numerous old re-triggers and stopping the state update. Read the inline documentation for this setting .

Although it’s possible, it is not recommended to use spot instances on AWS or preemtible nodes to lower cost in production, as outages in your continuous deployment tool will likely cost more than any savings. Also consider hosting Spinnaker on isolated infrastructure to reduce the possibility that other applications or teams will affect your Spinnaker instance.

It’s also recommended to spread out services over multiple availability zones, as described in the Netflix implementation .

Spinnaker – Halyard

Docs: Commands

HALYARD IS DEPRECATED

Table of Contents

hal

Usage

Global Parameters

Parameters

Subcommands

hal admin

Usage

Subcommands

hal admin deprecate

Usage

Subcommands

hal admin deprecate version

Usage

Parameters

hal admin publish

Usage

Subcommands

hal admin publish bom

Usage

Parameters

hal admin publish latest

Usage

hal admin publish latest-halyard

Usage

hal admin publish latest-spinnaker

Usage

hal admin publish profile

Usage

Parameters

hal admin publish version

Usage

Parameters

hal backup

Usage

Subcommands

hal backup create

Usage

hal backup restore

Usage

Parameters

hal config

Usage

Parameters

Subcommands

hal config artifact

Usage

Subcommands

hal config artifact bitbucket

Usage

Parameters

Subcommands

hal config artifact bitbucket account

Usage

Parameters

Subcommands

hal config artifact bitbucket account add

Usage

Parameters

hal config artifact bitbucket account delete

Usage

Parameters

hal config artifact bitbucket account edit

Usage

Parameters

hal config artifact bitbucket account get

Usage

Parameters

hal config artifact bitbucket account list

Usage

Parameters

hal config artifact bitbucket disable

Usage

Parameters

hal config artifact bitbucket enable

Usage

Parameters