cli-reference.rst

CLI Reference

The Rockefeller command-line interface should be run in a directory with a rockefeller.yml file.

It defines four commands: check, deploy, delete and list-required-secrets

rockefeller check

Validates that a given Rockefeller configuration is valid.

Parameters

rockefeller check does not accept parameters.

rockefeller deploy

Validates and deploys the resources in a given environment.

Parameters

Parameter	Type	Required	Default	Description
--pipeline <value>	string	Yes		The pipeline from your rockefeller.yml file that you wish to deploy.
--account_name <value>	string	Yes		The account you are deploying into.
--secrets <value>	:ref:`secrets`	yes		The base64 encoded JSON string of the deploy secrets. See :ref:`secrets`

Secrets

A base64 encoded array of secrets objects. Note that the required secrets can be obtained with :ref:`list-required-secrets`.

[
  {
      "phaseName": "Github", // The phase the secret is associated with.
      "name": "githubAccessToken", // The name of the secret
      "message": "'Github' phase - Please enter your GitHub access token", // This is not necessary, but will be present if the original object was obtained from rockefeller list-required-secrets.
      "value": "ABCDEFGHIJKLMNOPQRSTUVWXYZ" // The secret's value
  }
]

rockefeller delete

Deletes the AWS CodePipeline.

Parameters

Parameter	Type	Required	Default	Description
--pipeline <value>	string	Yes		The pipeline from your rockefeller.yml file that you wish to delete.
--account_name <value>	string	Yes		The account you are deploying into.

rockefeller list-required-secrets

Returns a JSON string with all of the secrets required for the pipeline.

Parameters

Parameter	Type	Required	Default	Description
--pipeline <value>	string	Yes		The pipeline from your rockefeller.yml file that you want to retreive required secrets from.

Example Response

[
  {
    "phaseName": "Github",
    "name": "githubAccessToken",
    "message": "'Github' phase - Please enter your GitHub access token"
  },
  {
    "phaseName": "npmDeploy",
    "name": "npmToken",
    "message": "npmDeploy' phase - Please enter your NPM Token"
  },
  {
    "phaseName": "pypiDeploy",
    "name": "pypiUsername",
    "message": "'pypiDeploy' phase - Please enter your PyPi username"
  },
  {
    "phaseName": "pypiDeploy",
    "name": "pypiPassword",
    "message": "'pypiDeploy' phase - Please enter your PyPi password"
  },
  {
    "phaseName": "RunscopeTests",
    "name": "runscopeTriggerUrl",
    "message": "'RunscopeTests' phase - Please enter your Runscope Trigger URL"
  },
  {
    "phaseName": "RunscopeTests",
    "name": "runscopeAccessToken",
    "message": "'RunscopeTests' phase - Please enter your Runscope Access Token"
  },
  {
    "phaseName": "Notify",
    "name": "slackUrl",
    "message": "'Notify' phase - Please enter the URL for Slack Notifications"
  }
]