Install the AWS Event Cache Plugin in Spinnaker (Halyard)

Installation overview

Enabling the AWS Event Cache plugin consists of the following steps:

1. Configure the plugin
2. Install the plugin
3. Create an AWS SNS topic and subscription

Before you begin

• You have read the AWS Event Cache overview.
• You are running open source Spinnaker.
• You manage your instance using Halyard. If you are using the Spinnaker Operator, see Install the AWS Event Cache Plugin in Spinnaker (Operator).

Compatibility

Configure the plugin

Update clouddriver-local.yml, and gate-local.yml config files with the following:

spinnaker:
  extensibility:
    plugins:
      Armory.Integration:
        id: Armory.AWSCATsOnEvent
        enabled: true
        version: <version>
    repositories:
      githubIntegration:
        enabled: true
        url: https://raw.githubusercontent.com/armory-plugins/pluginRepository/master/repositories.json

Replace <version> with the plugin version compatible with your Spinnaker version.

Install the plugin

Once you’ve apply your changes:

hal deploy apply

Create an AWS SNS topic and subscription

After plugin installation finishes, you need to create an AWS Simple Notification Service Standard topic for your Spinnaker or Armory CD instance. See the AWS SNS Creating an Amazon SNS topic for instructions.

In the Details section:

• Type: Select Standard
• Name: Create a meaningful name, such as AWS Event Cache Plugin

In the Access policy section:

Select Advanced and add the following policy:

   {
     "Version": "2008-10-17",
     "Statement": [
       {
         "Sid": "AWSConfigSNSPolicy",
         "Effect": "Allow",
         "Principal": {
            "Service": "config.amazonaws.com"
         },
         "Action": "sns:Publish",
         "Resource": "arn:aws:sns:us-west-2:568975057762:config-topic-568975057762"
         }
     ]
   }

Your Spinnaker or Armory CD instance needs to subscribe to the topic you created. See Subscribing to an Amazon SNS topic for how to create your subscription. You need your Gate endpoint when you create the subscription.

• Protocol: Select either HTTP or HTTPS depending on your Gate endpoint.
• Endpoint: This is your Gate endpoint.

After you create your subscription, you should see it in your AWS SNS Subscriptions list. The status should be Confirmed. If you don’t see the Confirmed after 1 or 2 minutes, ensure your Spinnaker or Armory CD service is running. Verify your Gate endpoint and make sure the plugin installation succeeded.