Install the AWS Event Cache Plugin in Spinnaker (Operator)

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 the Spinnaker Operator and the spinnaker-kustomize-patches repo. If you are using Halyard, see Install the AWS Event Cache Plugin in Spinnaker (Halyard).

Compatibility

Configure the plugin

Create an aws-event-cache-plugin.yml file with the following contents:

apiVersion: spinnaker.io/v1alpha2
kind: SpinnakerService
metadata:
  name: spinnaker
spec:
  spinnakerConfig:
    profiles:
      spinnaker:
        spinnaker:
          extensibility:
            repositories:
              awscatsOnEvent:
                version: <version>
                enabled: true
                url: https://raw.githubusercontent.com/armory-plugins/pluginRepository/master/repositories.json
      clouddriver: &clouddriver-cats
        spinnaker:
          extensibility:
            plugins:
              Armory.AWSCATsOnEvent:
                enabled: true
      clouddriver-ro:
        *clouddriver-cats
      clouddriver-rw:
        *clouddriver-cats
      clouddriver-caching:
        *clouddriver-cats
      gate:
        spinnaker:
          extensibility:
            plugins:
              Armory.AWSCATsOnEvent:
                enabled: true

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

Save the file to your spinnaker-kustomize-patches/plugins/oss directory.

Install the plugin

1. Add the plugin patch to your Kustomize recipe’s patchesStrategicMerge section. For example:

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

   apiVersion: kustomize.config.k8s.io/v1beta1 kind: Kustomization namespace: spinnaker components: - core/base - core/persistence/in-cluster - targets/kubernetes/default patchesStrategicMerge: - core/patches/oss-version.yml - plugins/oss/aws-event-cache-plugin.yml patches: - target: kind: SpinnakerService path: utilities/switch-to-oss.yml

2. Apply the updates to your Kustomization recipe.

   kubectl apply -k <kustomization-directory-path>
   

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.