Spinnaker – spin CLI Guide

Docs: Manage Applications

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

Overview

spin can manage the whole lifecycle of your application:

$ spin application

Usage:
   application [command]

Aliases:
  application, applications, app

Available Commands:
  delete      Delete the specified application
  get         Get the specified application
  list        List the all applications
  save        Save the provided application

Flags:
  -h, --help   help for application

Global Flags:
      --config string          path to config file (default $HOME/.spin/config)
      --gate-endpoint string   Gate (API server) endpoint (default http://localhost:8084)
  -k, --insecure               ignore certificate errors
      --no-color               disable color (default true)
      --output string          configure output formatting
  -q, --quiet                  squelch non-essential output

Use " application [command] --help" for more information about a command.

The following assumes Spinnaker is running and Gate is listening on http://localhost:8084. If gate is running elsewhere, you can set the Gate endpoint with the global --gate-endpoint flag.

Managing Your Application’s Lifecycle

Create a new application using `save`

$ spin application save --application-name my-app --owner-email someone@example.com --cloud-providers "gce, kubernetes"

Application save succeeded

Applications can also be updated with the save command.

List our Spinnaker applications with `list`

spin application list
[
...
{
  "accounts": "my-account",
  "cloudProviders": "gce,kubernetes",
  "createTs": "1529349914747",
  "email": "jacobkiefer@google.com",
  "instancePort": 80,
  "lastModifiedBy": "anonymous",
  "name": "my-app",
  "platformHealthOnly": true,
  "providerSettings": {
    "gce": {
    "associatePublicIpAddress": true
    }
},
"updateTs": "1529349915014",
"user": "anonymous"
}
...
]

We see our application in the returned list along with the other existing applications.

Retrieve a single application with `get`

spin application get my-app
{
  "attributes": {
    "accounts": "my-account",
    "cloudProviders": "gce,kubernetes",
    "createTs": "1529349914747",
    "email": "jacobkiefer@google.com",
    "instancePort": 80,
    "lastModifiedBy": "anonymous",
    "name": "my-account",
    "platformHealthOnly": true,
    "providerSettings": {
      "gce": {
        "associatePublicIpAddress": true
      }
    },
    "updateTs": "1529349915014",
    "user": "anonymous"
  },
  "clusters": {
    "my-account-cluster": [
      {
        "loadBalancers": [],
        "name": "my-account-gce",
        "provider": "gce",
        "serverGroups": [
          "my-account-gce-v000",
          "my-account-gce-v001"
        ]
      }
    ]
  },
  "name": "my-account"
}

Note that we retrieve not only the application attributes, but also the clusters associated with the application.

Delete a single application with `delete`

When we’re finished with our Spinnaker application, we can delete it.

spin application delete my-app

Docs: Manage Canary Configs

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

Overview

$ spin canary canary-configs
Usage:
   canary canary-config [command]

Aliases:
  canary-config, canary-configs, cc

Available Commands:
  delete      Delete the provided canary config
  get         Get the canary config with the provided id
  list        List the canary configs
  retro       Retro the provided canary config
  save        Save the provided canary config

Flags:
  -h, --help   help for canary-config

Global Flags:
      --config string            path to config file (default $HOME/.spin/config)
      --default-headers string   configure default headers for gate client as comma separated list (e.g. key1=value1,key2=value2)
      --gate-endpoint string     Gate (API server) endpoint (default http://localhost:8084)
  -k, --insecure                 ignore certificate errors
      --no-color                 disable color (default true)
      --output string            configure output formatting
  -q, --quiet                    squelch non-essential output

Use " canary canary-config [command] --help" for more information about a command.

The following instructions assume Spinnaker is running and Gate is listening on http://localhost:8084. If gate is running elsewhere, you can set the Gate endpoint with the global --gate-endpoint flag.

Create and update canary configs with `save`

$ spin canary canary-configs save --file <path to canary config json>

Note that save accepts the canary config in JSON format. You can quickly export an existing canary config into a valid argument to the --file flag by using the get command.

List canary configs with `list`

$ spin canary canary-config list

[
...
{
  "id": "canaryConfigId",
  "name": "canaryConfigName"
  ...
},
...
]

Retrieve a single canary config with `get`

$ spin canary canary-config get canaryConfigId

{
  "id": "myPipelineTemplate"
  ...
}

Delete a canary config with `delete`

$ spin canary canary-config delete canaryConfigId

Test a canary config with `retro`

The retro command runs a retrospective analysis given a canary config. You must also supply the control and experiment group locators and analysis time window.

$ spin canary canary-configs retro \
  -f <path to canary config json> \
  --control-group app-control-v001 --control-location us-central1 \
  --experiment-group app-experiment-v001 --experiment-location us-central1 \
  --start 2019-09-17T16:27:19.867Z \
  --end 2019-09-17T17:27:19.867Z

Initiating canary execution for supplied canary config
Spawned canary execution with id 01DR9BEP8XTJQDPVFJ41C9MBJ6, polling for completion...
Retrospective canary execution finished, judgement = PASS

Docs: Manage Pipeline Templates

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

Overview

Note: spin only supports pipeline templates v2.

spin can manage the whole lifecycle of your v2 pipeline templates:

$ spin pipeline-templates

Usage:
   pipeline-template [command]

Aliases:
  pipeline-template, pipeline-templates, pt

Available Commands:
  delete      Delete the provided pipeline template
  get         Get the pipeline template with the provided ID
  list        List the pipeline templates for the provided scopes
  plan        Plan the provided pipeline template config
  save        Save the provided pipeline

Flags:
  -h, --help   help for pipeline-template

Global Flags:
      --config string          path to config file (default $HOME/.spin/config)
      --gate-endpoint string   Gate (API server) endpoint (default http://localhost:8084)
  -k, --insecure               ignore certificate errors
      --no-color               disable color (default true)
      --output string          configure output formatting
  -q, --quiet                  squelch non-essential output

Use " pipeline-template [command] --help" for more information about a command.

The following assumes Spinnaker is running and Gate is listening on http://localhost:8084. If gate is running elsewhere, you can set the Gate endpoint with the global --gate-endpoint flag.

Managing Your Pipeline Template’s Lifecycle

Create and update pipeline templates with `save`

$ spin pipeline-templates save --file <path to pipeline json>

Pipeline template save succeeded

Note that save accepts the pipeline template in JSON format. You can quickly export an existing pipeline template into a valid argument to the --file flag by using the get command.

List pipeline templates for a set of scopes with `list`

spin pipeline-templates list --scopes app1,app2
# Note: --scopes is optional, by default all pipeline templates are global.

[
...
{
  "id": "myPipelineTemplate"
  "pipeline": {...}
  ...
}
...
]

Retrieve a single pipeline template with `get`

spin pipeline-templates get --id myPipelineTemplate
{
  "id": "myPipelineTemplate"
  "pipeline": {...}
}

Visualize a hydrated pipeline with `plan`

spin pipeline-templates plan --file <path to pipeline config>

{
  "application": "my-spinnaker-app"
  "stages": [...] # Evaluated pipeline config based on template config values.
}

Delete a pipeline template with `delete`

spin pipeline-template delete myPipelineTemplate

Pipeline template deleted

Docs: Manage Pipelines

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

Overview

spin can manage the whole lifecycle of your pipeline:

$ spin pipeline

Usage:
   pipeline [command]

Aliases:
  pipeline, pipelines, pi

Available Commands:
  delete      Delete the provided pipeline
  execute     Execute the provided pipeline
  get         Get the pipeline with the provided name from the provided application
  list        List the pipelines for the provided application
  save        Save the provided pipeline

Flags:
  -h, --help   help for pipeline

Global Flags:
      --config string          path to config file (default $HOME/.spin/config)
      --gate-endpoint string   Gate (API server) endpoint (default http://localhost:8084)
  -k, --insecure               ignore certificate errors
      --no-color               disable color (default true)
      --output string          configure output formatting
  -q, --quiet                  squelch non-essential output

Use " pipeline [command] --help" for more information about a command.

The following assumes Spinnaker is running and Gate is listening on http://localhost:8084. If gate is running elsewhere, you can set the Gate endpoint with the global --gate-endpoint flag.

Managing Your Pipeline’s Lifecycle

Create and update pipelines with `save`

$ spin pipeline save --file <path to pipeline json>

Parsed submitted pipeline: <...>

Pipeline save succeeded

Note that save accepts pipeline in JSON format. You can quickly export an existing pipeline into a valid argument to the --file flag by using the get command. You can also export pipeline JSON from the pipeline UI in Deck by clicking Pipeline Actions > Edit as JSON and copying the JSON contents, e.g.

You can also template the pipeline JSON using your favorite templating engine.

List pipelines in an application with `list`

spin pipeline list --application my-app

[
...
{
  "application": "my-app"
  ...
}
...
]

Retrieve a single pipeline with `get`

Get a single pipeline with get:

spin pipeline get --name my-pipeline --application my-app
{
  "application": "my-app"
  "stages": [...]
}

Start a pipeline execution with `execute`

Start a pipeline execution with execute:

spin pipeline execute --name my-pipeline --application my-app

Pipeline execution started

If your pipeline is parameterized, you can submit a JSON-formatted map of the parameters and their values via the --parameter-file flag

{
  "parameter1": "value1",
  "parameter2": "value2",
  ...
}

Delete a pipeline with `delete`

spin pipeline delete --name my-pipeline --application my-app

Pipeline deleted

Spinnaker – spin CLI Guide

Docs: Manage Applications

Overview

Managing Your Application’s Lifecycle

Create a new application using save

List our Spinnaker applications with list

Retrieve a single application with get

Delete a single application with delete

Docs: Manage Canary Configs

Overview

Create and update canary configs with save

List canary configs with list

Retrieve a single canary config with get

Delete a canary config with delete

Test a canary config with retro

Docs: Manage Pipeline Templates

Overview

Managing Your Pipeline Template’s Lifecycle

Create and update pipeline templates with save

List pipeline templates for a set of scopes with list

Retrieve a single pipeline template with get

Visualize a hydrated pipeline with plan

Delete a pipeline template with delete

Docs: Manage Pipelines

Overview

Managing Your Pipeline’s Lifecycle

Create and update pipelines with save

List pipelines in an application with list

Retrieve a single pipeline with get

Start a pipeline execution with execute

Delete a pipeline with delete

Create a new application using `save`

List our Spinnaker applications with `list`

Retrieve a single application with `get`

Delete a single application with `delete`

Create and update canary configs with `save`

List canary configs with `list`

Retrieve a single canary config with `get`

Delete a canary config with `delete`

Test a canary config with `retro`

Create and update pipeline templates with `save`

List pipeline templates for a set of scopes with `list`

Retrieve a single pipeline template with `get`

Visualize a hydrated pipeline with `plan`

Delete a pipeline template with `delete`

Create and update pipelines with `save`

List pipelines in an application with `list`

Retrieve a single pipeline with `get`

Start a pipeline execution with `execute`

Delete a pipeline with `delete`