Using the AWS OpsWorks Deployment task in Bamboo

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:

1 Configuration
- 1.1 Run App Command
- 1.2 Run Stack Command
2 Variables
- 2.1 Deploy App
- 2.2 Run Command
3 How-to Articles
4 Frequently Asked Questions (FAQ)

Related Pages:

Deploying to AWS OpsWorks
- Using the AWS OpsWorks App task in Bamboo

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:

a. Common to all tasks

b. Actions supported by this task:

Run App Command

Run App Command
Stack ID	Specify the stack ID. This is the stack's Universally unique identifier (UUID), also referred to as 'OpsWorks ID' in the AWS Management Console.
App ID	Specify the app ID. This is the app's Universally unique identifier (UUID), also referred to as 'OpsWorks ID' in the AWS Management Console.
Command	Select the command to run. Refer to Deploying Apps for details on the available commands.
Args	(Optional) Specify command arguments in JSON format. Refer to DeploymentCommand for details.
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. Refer to Using Custom JSON to add Attributes to the Stack Configuration Attributes for details.
Instance IDs	(Optional) Specify instance IDs for the deployment targets (separated by semicolons). This are the instance's Universally unique identifiers (UUIDs), also referred to as 'OpsWorks ID' in the AWS Management Console. 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. Refer to Run Stack Commands for details on the available commands.
Args	(Optional) Specify the command arguments in JSON format. Refer to DeploymentCommand for details.
Comment	see Run App Command above
Custom JSON	see Run App Command above
Instance IDs	see Run App Command above

Variables

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

Page:
How to provide temporary AWS credentials to the AWS Command Line Interface (AWS CLI) via Bamboo variables

Frequently Asked Questions (FAQ)