Armory Docs – Get Started with the AWS Event Cache Plugin

Plugins: Install the AWS Event Cache Plugin in Armory Continuous Deployment

Mon, 01 Jan 0001 00:00:00 +0000

Installation overview

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

Configure the plugin
Install the plugin
Create an AWS SNS topic and subscription

Before you begin

You have read the AWS Event Cache overview.
You are running Armory Continuous Deployment.
You manage your instance using the Armory Operator and the spinnaker-kustomize-patches repo.

Compatibility

Armory CD Version	Spinnaker Version	AWS Event Cache Plugin Version
2.31.x	1.31.x	0.2.1
2.30.x	1.29.x, 1.30.x	0.2.1
2.28.x	1.28.x	0.2.1

Configure the plugin

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

apiVersion: spinnaker.armory.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 Armory CD version.

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

Install the plugin

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/aws-event-cache-plugin.yml

patches:
 - target:
 kind: SpinnakerService
 path: utilities/switch-to-oss.yml

Apply the updates to your Kustomization recipe.

kubectl apply -k <kustomization-directory-path>

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.

Plugins: Install the AWS Event Cache Plugin in Spinnaker (Operator)

Mon, 01 Jan 0001 00:00:00 +0000

Installation overview

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

Configure the plugin
Install the plugin
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

Armory CD Version	Spinnaker Version	AWS Event Cache Plugin Version
2.31.x	1.31.x	0.2.1
2.30.x	1.29.x, 1.30.x	0.2.1
2.28.x	1.28.x	0.2.1

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

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

Apply the updates to your Kustomization recipe.

kubectl apply -k <kustomization-directory-path>

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"
 }
 ]
 }

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

Plugins: Install the AWS Event Cache Plugin in Spinnaker (Halyard)

Mon, 01 Jan 0001 00:00:00 +0000

Installation overview

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

Configure the plugin
Install the plugin
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).

A note about installing plugins in Spinnaker

When Halyard adds a plugin to a Spinnaker installation, it adds the plugin repository information to all services, not just the ones the plugin is for. This means that when you restart Spinnaker, each service restarts, downloads the plugin, and checks if an extension exists for that service. Each service restarting is not ideal for large Spinnaker installations due to service restart times. Clouddriver can take an hour or more to restart if you have many accounts configured.

The AWS Event Cache plugin extends Clouddriver and Gate. To avoid every Spinnaker service restarting and downloading the plugin, do not add the plugin using Halyard. Instead, follow the local config installation method, in which you configure the plugin in each extended service’s local profile.

Compatibility

Armory CD Version	Spinnaker Version	AWS Event Cache Plugin Version
2.31.x	1.31.x	0.2.1
2.30.x	1.29.x, 1.30.x	0.2.1
2.28.x	1.28.x	0.2.1

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

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"
 }
 ]
 }

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

Armory Docs – Get Started with the AWS Event Cache Plugin

Plugins: Install the AWS Event Cache Plugin in Armory Continuous Deployment

Installation overview

Before you begin

Compatibility

Configure the plugin

Install the plugin

Create an AWS SNS topic and subscription

Plugins: Install the AWS Event Cache Plugin in Spinnaker (Operator)

Installation overview

Before you begin

Compatibility

Configure the plugin

Install the plugin

Create an AWS SNS topic and subscription

Plugins: Install the AWS Event Cache Plugin in Spinnaker (Halyard)

Installation overview

Before you begin

A note about installing plugins in Spinnaker

Compatibility

Configure the plugin

Install the plugin

Create an AWS SNS topic and subscription