Permalink
Find file Copy path
8442 lines (6262 sloc) 326 KB

Table of Contents

hal

A tool for configuring, installing, and updating Spinnaker.

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

Usage

hal [parameters] [subcommands]

Global Parameters

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

Parameters

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

Subcommands

  • 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...
  • 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.
  • security: Configure Spinnaker's security. This includes external SSL, authentication mechanisms, and authorization policies.
  • 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
  • helm: Manage and view Spinnaker configuration for the helm provider
  • http: Manage and view Spinnaker configuration for the http 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 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 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.
  • 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 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.
  • --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.
  • --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

  • 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 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.
  • --username: The username of the jenkins user to authenticate as.

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.

  • --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.
  • --username: The username of the jenkins user to authenticate as.

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.

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.

  • --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.

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.
  • --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.

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.

  • --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.
  • --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.

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

  • edit: Edit Spinnaker's deployment footprint and configuration.
  • ha: Configure, validate, and view the specified high availability Spinnaker service configuration.

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.
  • --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

  • --appengine-container-image-url-deployments: Enable appengine deployments using a container image URL from gcr.io.
  • --artifacts: Enable artifact support. Read more at spinnaker.io/reference/artifacts
  • --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.
  • --infrastructure-stages: Enable infrastructure stages. Allows for creating Load Balancers as part of pipelines.
  • --jobs: Allow Spinnaker to run containers in Kubernetes and Titus as Job stages in pipelines.
  • --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.
  • --travis: Enable the Travis CI stage.
  • --wercker: Enable the Wercker CI stage.

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.
  • 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 authentication method.
  • 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 authentication method.

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 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 authentication method.
  • 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 authentication method.

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 authentication method.
  • 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 authentication method.

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

  • slack: Manage and view Spinnaker configuration for the slack notification
  • twilio: Manage and view Spinnaker configuration for the twilio notification

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

  • --bot-name: The name of your slack bot.
  • --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 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
  • 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
  • kubernetes: Manage and view Spinnaker configuration for the kubernetes provider
  • openstack: Manage and view Spinnaker configuration for the openstack provider
  • oracle: Manage and view Spinnaker configuration for the oracle 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
  • 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.

  • --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.
  • --provider-version: Some providers support multiple versions/release tracks. This allows you to pick the version of the provider (not the resources it manages) to run within Spinnaker.
  • --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.
  • --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.
  • --provider-version: Some providers support multiple versions/release tracks. This allows you to pick the version of the provider (not the resources it manages) to run within Spinnaker.
  • --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 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

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.

Example: "user/spinnaker" or "role/spinnakerManaged"

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)
  • --no-validate: (Default: false) Skip validation.
  • --provider-version: Some providers support multiple versions/release tracks. This allows you to pick the version of the provider (not the resources it manages) to run within Spinnaker.
  • --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.
  • --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"

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)
  • --no-validate: (Default: false) Skip validation.
  • --provider-version: Some providers support multiple versions/release tracks. This allows you to pick the version of the provider (not the resources it manages) to run within Spinnaker.
  • --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.
  • --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 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 default user name and password 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.
  • --provider-version: Some providers support multiple versions/release tracks. This allows you to pick the version of the provider (not the resources it manages) to run within Spinnaker.
  • --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.
  • --subscription-id: (Required) The subscriptionId that your service principal is assigned to.
  • --tenant-id: (Required) The tenantId that your service principal is assigned to.
  • --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 default user name and password 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.
  • --provider-version: Some providers support multiple versions/release tracks. This allows you to pick the version of the provider (not the resources it manages) to run within Spinnaker.
  • --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.
  • --subscription-id: The subscriptionId that your service principal is assigned to.
  • --tenant-id: The tenantId that your service principal is assigned to.
  • --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 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
  • --provider-version: Some providers support multiple versions/release tracks. This allows you to pick the version of the provider (not the resources it manages) to run within Spinnaker.
  • --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.
  • --provider-version: Some providers support multiple versions/release tracks. This allows you to pick the version of the provider (not the resources it manages) to run within Spinnaker.
  • --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)
  • --provider-version: Some providers support multiple versions/release tracks. This allows you to pick the version of the provider (not the resources it manages) to run within Spinnaker.
  • --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.
  • --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)
  • --provider-version: Some providers support multiple versions/release tracks. This allows you to pick the version of the provider (not the resources it manages) to run within Spinnaker.
  • --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.
  • --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.
  • --provider-version: Some providers support multiple versions/release tracks. This allows you to pick the version of the provider (not the resources it manages) to run within Spinnaker.
  • --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.
  • --provider-version: Some providers support multiple versions/release tracks. This allows you to pick the version of the provider (not the resources it manages) to run within Spinnaker.
  • --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.
  • --provider-version: Some providers support multiple versions/release tracks. This allows you to pick the version of the provider (not the resources it manages) to run within Spinnaker.
  • --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.
  • --provider-version: Some providers support multiple versions/release tracks. This allows you to pick the version of the provider (not the resources it manages) to run within Spinnaker.
  • --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 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.

  • --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-v2'.
  • --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.
  • --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: Some providers support multiple versions/release tracks. This allows you to pick the version of the provider (not the resources it manages) to run within Spinnaker.
  • --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-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.
  • --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-v2'.
  • --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.
  • --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: Some providers support multiple versions/release tracks. This allows you to pick the version of the provider (not the resources it manages) to run within Spinnaker.
  • --read-permissions: A user must have at least one of these roles in order to view this account's cloud resources.
  • --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/.
  • --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 Kubenretes 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 openstack

Manage and view Spinnaker configuration for the openstack provider

Usage

hal config provider openstack [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 openstack provider's account
  • bakery: Manage and view Spinnaker configuration for the openstack provider's image bakery configuration.
  • disable: Set the openstack provider as disabled
  • enable: Set the openstack provider as enabled

hal config provider openstack account

Manage and view Spinnaker configuration for the openstack provider's account

Usage

hal config provider openstack 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 openstack provider.
  • delete: Delete a specific openstack account by name.
  • edit: Edit an account in the openstack provider.
  • get: Get the specified account details for the openstack provider.
  • list: List the account names for the openstack provider.

hal config provider openstack account add

Add an account to the openstack provider.

Usage

hal config provider openstack account add ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

  • --account-type: The type of Openstack account.
  • --auth-url: (Required) The auth url of your cloud, usually found in the Horizon console under Compute > Access & Security > API Access > url for Identity. Must be Keystone v3
  • --consul-config: This is the path for your consul config file
  • --deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
  • --domain-name: (Required) The domain of the cloud. Can be found in the RC file.
  • --environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
  • --heat-template-location: The location of your heat template file. (Replacing the Heat template is not recommended)
  • --insecure: (Default: false) Disable certificate validation on SSL connections. Needed if certificates are self signed. Default false.
  • --lbaas-poll-interval: Interval in seconds to poll octavia when an entity is created, updated, or deleted. Default 5.
  • --lbaas-poll-timeout: Time to stop polling octavia when a status of an entity does not change. Default 60.
  • --no-validate: (Default: false) Skip validation.
  • --password: (Required) The password used to access your cloud.
  • --project-name: (Required) The name of the project (formerly tenant) within the cloud. Can be found in the RC file.
  • --provider-version: Some providers support multiple versions/release tracks. This allows you to pick the version of the provider (not the resources it manages) to run within Spinnaker.
  • --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. Can be found in the RC file.
  • --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-file: User data passed to Heat Orchestration Template. Replacement of tokens supported, see http://www.spinnaker.io/v1.0/docs/target-deployment-configuration#section-openstack for details.
  • --username: (Required) The username used to access your 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 openstack account delete

Delete a specific openstack account by name.

Usage

hal config provider openstack 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 openstack account edit

Edit an account in the openstack provider.

Usage

hal config provider openstack account edit ACCOUNT [parameters]

Parameters

ACCOUNT: The name of the account to operate on.

  • --account-type: The type of Openstack 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 your cloud, usually found in the Horizon console under Compute > Access & Security > API Access > url for Identity. Must be Keystone v3
  • --consul-config: This is the path for your consul config file
  • --deployment: If supplied, use this Halyard deployment. This will not create a new deployment.
  • --domain-name: The domain of the cloud. Can be found in the RC file.
  • --environment: The environment name for the account. Many accounts can share the same environment (e.g. dev, test, prod)
  • --heat-template-location: The location of your heat template file. (Replacing the Heat template is not recommended)
  • --insecure: Disable certificate validation on SSL connections. Needed if certificates are self signed. Default false.
  • --lbaas-poll-interval: Interval in seconds to poll octavia when an entity is created, updated, or deleted. Default 5.
  • --lbaas-poll-timeout: Time to stop polling octavia when a status of an entity does not change. Default 60.
  • --no-validate: (Default: false) Skip validation.
  • --password: The password used to access your cloud.
  • --project-name: The name of the project (formerly tenant) within the cloud. Can be found in the RC file.
  • --provider-version: Some providers support multiple versions/release tracks. This allows you to pick the version of the provider (not the resources it manages) to run within Spinnaker.
  • --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. Can be found in the RC file.
  • --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.
  • --user-data-file: User data passed to Heat Orchestration Template. Replacement of tokens supported, see http://www.spinnaker.io/v1.0/docs/target-deployment-configuration#section-openstack for details.
  • --username: The username used to access your 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 openstack account get

Get the specified account details for the openstack provider.

Usage

hal config provider openstack 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 openstack account list

List the account names for the openstack provider.

Usage

hal config provider openstack 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 openstack bakery

Manage and view Spinnaker configuration for the openstack provider's image bakery configuration.

Usage

hal config provider openstack 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 openstack provider's base image.
  • edit: Edit the openstack provider's bakery default options.

hal config provider openstack bakery base-image

Manage and view Spinnaker configuration for the openstack provider's base image.

Usage

hal config provider openstack 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 openstack provider's bakery.
  • delete: Delete a specific openstack base image by name.
  • edit: Edit a base image for the openstack provider's bakery.
  • get: Get the specified base image details for the openstack provider.
  • list: List the base image names for the openstack provider.

hal config provider openstack bakery base-image add

Add a base image for the openstack provider's bakery.

Usage

hal config provider openstack 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/

hal config provider openstack bakery base-image delete

Delete a specific openstack base image by name.

Usage

hal config provider openstack 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 openstack bakery base-image edit

Edit a base image for the openstack provider's bakery.

Usage

hal config provider openstack 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: 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 openstack bakery base-image get

Get the specified base image details for the openstack provider.

Usage

hal config provider openstack 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 openstack bakery base-image list

List the base image names for the openstack provider.

Usage

hal config provider openstack 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 openstack bakery edit

Edit the openstack provider's bakery default options.

Usage

hal config provider openstack 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.
  • --floating-ip-pool: (Required) Set the default floating IP pool your images will be baked in.
  • --insecure: (Required) The security setting (true/false) for connecting to the Openstack account.
  • --network-id: (Required) Set the default network your images will be baked in.
  • --no-validate: (Default: false) Skip validation.
  • --password: (Required) 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-groups: (Required) Set the default security group 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.

hal config provider openstack disable

Set the openstack provider as disabled

Usage

hal config provider openstack 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 openstack enable

Set the openstack provider as enabled

Usage

hal config provider openstack 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
  • --provider-version: Some providers support multiple versions/release tracks. This allows you to pick the version of the provider (not the resources it manages) to run within Spinnaker.
  • --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]