The following macros are not currently supported in the header:
  • unmigrated-wiki-markup

Documentation for Tasks for AWS 2.10 – other releases are available in the Tasks for AWS Documentation Directory.
View

Unknown macro: {spacejump}

or visit the current documentation home.

Using the AWS OpsWorks Deployment task in Bamboo

Owned by Steffen Opel [Utoolity]
Last updated: 10.02.2016Version comment

You can use the AWS OpsWorks Deployment task to run app commands (deploy the app) and run stack commands (provision the stack) (see Deploying to AWS OpsWorks for an overview of the OpsWorks component lifecycle and deployment workflow).

On this page:

Related Pages:

Configuration

To configure an AWS OpsWorks Deployment task:

  1. Navigate to the Tasks configuration tab for the job (this will be the default job if creating a new plan).
  2. Click the name of an existing AWS OpsWorks Deployment task, or click Add Task and then AWS OpsWorks Deployment to create a new task.

  3. Complete the following settings:

    1. Common to all tasks

       Click here to expand...

      Task Description (Optional) Identify the purpose of the task.
      Disable this task

      Check, or clear, to selectively run this task.

      Action

      Each task supports one or more actions depending on the target AWS resource. Select the desired action and configure the action specific parameters below.

      RegionSelect the desired AWS Region. Alternatively, select [Use region variable ...] to supply the region dynamically via Bamboo variables (needs to be a region code such as ap-southeast-2) - refer to How to parametrize the AWS region via a Bamboo variable for details.
      ...Configure task/action specific parameters, see below ...
      AWS Security Credentials 
      SourceSelect the source for the required AWS Security Credentials - can be either Inline, an IAM Role for EC2 or a shared Identity Federation for AWS Connector.
      Connector(Conditional) Select the shared Identity Federation for AWS Connector. Alternatively, select [Use connector variable ...] to supply the connector dynamically via Bamboo variables (needs to be a connector id such as f24e81bc-7aff-42db-86a2-7cf82e24d871) - refer to How to parametrize the AWS connector via a Bamboo variable for details.

    2. Actions supported by this task:

      Run App Command

      		 
      Stack ID

      Specify the stack ID.

      App ID

      Specify the app ID.

      Command

      Select the command to run.

      Args(Optional) Specify command arguments in JSON format.
      Comment

      (Optional) Specify a user-defined comment to describe the command.

      Custom JSON

      (Optional) Specify attributes in JSON format to override the corresponding default stack configuration attributes.

      Instance IDs

      (Optional) Specify instance IDs for the deployment targets (separated by semicolons).

      • (info) This are the instance's Universally unique identifiers (UUIDs), also referred to as 'OpsWorks ID' in the AWS Management Console.
      • (warning) Beware not to confuse these OpsWorks specific UUIDs (e.g. de305d54-75b4-431b-adb2-eb6b9e546014) with the well known EC2 instance IDs (e.g. i-1234abcd) used in most other AWS services!

      Run Stack Command

      		 
      Stack ID
      		see Run App Command above
      Command

      Select the command to run.

      Args(Optional) Specify the command arguments in JSON format.
      Comment

      see Run App Command above

      Custom JSON

      see Run App Command above

      Instance IDs

      see Run App Command above

Variables

All tasks support Bamboo Variable Substitution/Definition - this task's actions generate variables as follows:

A task's generated variables might get amended with respective AWS API additions over time - a live build log will always provide the most current variable shape accordingly

Deploy App

Creating common variables for deployment '1e5b195e-a096-47a2-9944-f4148eb81bf9':
... bamboo.custom.aws.opsworks.deployment.resources: 1e5b195e-a096-47a2-9944-f4148eb81bf9
... bamboo.custom.aws.opsworks.deployment.resources.1e5b195e-a096-47a2-9944-f4148eb81bf9.AppId: 4d5703bb-02c6-4207-a96f-635c0dcb7dc9
... bamboo.custom.aws.opsworks.deployment.resources.1e5b195e-a096-47a2-9944-f4148eb81bf9.Command: deploy
... bamboo.custom.aws.opsworks.deployment.resources.1e5b195e-a096-47a2-9944-f4148eb81bf9.Comment: Started by: TAWS-IT290-OWD-8
... bamboo.custom.aws.opsworks.deployment.resources.1e5b195e-a096-47a2-9944-f4148eb81bf9.CompletedAt: 2015-11-19T23:29:21+00:00
... bamboo.custom.aws.opsworks.deployment.resources.1e5b195e-a096-47a2-9944-f4148eb81bf9.CreatedAt: 2015-11-19T23:28:40+00:00
... bamboo.custom.aws.opsworks.deployment.resources.1e5b195e-a096-47a2-9944-f4148eb81bf9.CustomJson: null
... bamboo.custom.aws.opsworks.deployment.resources.1e5b195e-a096-47a2-9944-f4148eb81bf9.DeploymentId: 1e5b195e-a096-47a2-9944-f4148eb81bf9
... bamboo.custom.aws.opsworks.deployment.resources.1e5b195e-a096-47a2-9944-f4148eb81bf9.Duration: 41
... bamboo.custom.aws.opsworks.deployment.resources.1e5b195e-a096-47a2-9944-f4148eb81bf9.IamUserArn: arn:aws:sts::288727192237:assumed-role/taws-tst-utoolity-net/SYSTEM
... bamboo.custom.aws.opsworks.deployment.resources.1e5b195e-a096-47a2-9944-f4148eb81bf9.InstanceIds: 3b291bb9-6967-48fc-bed1-f379288b2702
... bamboo.custom.aws.opsworks.deployment.resources.1e5b195e-a096-47a2-9944-f4148eb81bf9.StackId: 06483d86-788a-42a5-be26-6d9ef2ca432a
... bamboo.custom.aws.opsworks.deployment.resources.1e5b195e-a096-47a2-9944-f4148eb81bf9.Status: successful
Creating common variables for first resource affected by task:
... bamboo.custom.aws.opsworks.deployment.first.AppId: 4d5703bb-02c6-4207-a96f-635c0dcb7dc9
... bamboo.custom.aws.opsworks.deployment.first.Command: deploy
... bamboo.custom.aws.opsworks.deployment.first.Comment: Started by: TAWS-IT290-OWD-8
... bamboo.custom.aws.opsworks.deployment.first.CompletedAt: 2015-11-19T23:29:21+00:00
... bamboo.custom.aws.opsworks.deployment.first.CreatedAt: 2015-11-19T23:28:40+00:00
... bamboo.custom.aws.opsworks.deployment.first.CustomJson: null
... bamboo.custom.aws.opsworks.deployment.first.DeploymentId: 1e5b195e-a096-47a2-9944-f4148eb81bf9
... bamboo.custom.aws.opsworks.deployment.first.Duration: 41
... bamboo.custom.aws.opsworks.deployment.first.IamUserArn: arn:aws:sts::288727192237:assumed-role/taws-tst-utoolity-net/SYSTEM
... bamboo.custom.aws.opsworks.deployment.first.InstanceIds: 3b291bb9-6967-48fc-bed1-f379288b2702
... bamboo.custom.aws.opsworks.deployment.first.StackId: 06483d86-788a-42a5-be26-6d9ef2ca432a
... bamboo.custom.aws.opsworks.deployment.first.Status: successful

Run Command

See Create above.

How-to Articles

Frequently Asked Questions (FAQ)