Skip to content

Commit

Permalink
feat(spec-tests): introduce aws spec tests
Browse files Browse the repository at this point in the history
  • Loading branch information
obs-gh-colinhutchinson committed Sep 12, 2023
1 parent d09cc53 commit 3b34140
Show file tree
Hide file tree
Showing 8 changed files with 174 additions and 4 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/spec-tests.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Run AWS Spec tests

on:
workflow_dispatch:
schedule:
- cron: "0 13 * * 1" # Every Monday

permissions:
contents: write
id-token: write
packages: write

jobs:
run-aws-test-kitchen:
uses: observeinc/aws-test-kitchen/.github/workflows/ci.yml@main
with:
test_type: terraform
code_sha: ${{ github.sha }}
secrets:
OBSERVE_CUSTOMER: ${{ secrets.OBSERVE_CUSTOMER }}
OBSERVE_TOKEN: ${{ secrets.OBSERVE_TOKEN }}
OBSERVE_DOMAIN: ${{ secrets.OBSERVE_DOMAIN }}
AWS_ROLE_ARN: ${{ secrets.AWS_ROLE_ARN }}
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,11 @@ module "observe_collection" {

| Name | Source | Version |
|------|--------|---------|
| <a name="module_lambda_log_subscription"></a> [lambda\_log\_subscription](#module\_lambda\_log\_subscription) | observeinc/kinesis-firehose/aws//modules/cloudwatch_logs_subscription | 2.0.3 |
| <a name="module_lambda_log_subscription"></a> [lambda\_log\_subscription](#module\_lambda\_log\_subscription) | observeinc/kinesis-firehose/aws//modules/cloudwatch_logs_subscription | 2.1.0 |
| <a name="module_observe_cloudwatch_logs_subscription"></a> [observe\_cloudwatch\_logs\_subscription](#module\_observe\_cloudwatch\_logs\_subscription) | observeinc/cloudwatch-logs-subscription/aws | 0.5.0 |
| <a name="module_observe_cloudwatch_metrics"></a> [observe\_cloudwatch\_metrics](#module\_observe\_cloudwatch\_metrics) | observeinc/kinesis-firehose/aws//modules/cloudwatch_metrics | 2.0.3 |
| <a name="module_observe_firehose_eventbridge"></a> [observe\_firehose\_eventbridge](#module\_observe\_firehose\_eventbridge) | observeinc/kinesis-firehose/aws//modules/eventbridge | 2.0.3 |
| <a name="module_observe_kinesis_firehose"></a> [observe\_kinesis\_firehose](#module\_observe\_kinesis\_firehose) | observeinc/kinesis-firehose/aws | 2.0.3 |
| <a name="module_observe_cloudwatch_metrics"></a> [observe\_cloudwatch\_metrics](#module\_observe\_cloudwatch\_metrics) | observeinc/kinesis-firehose/aws//modules/cloudwatch_metrics | 2.1.0 |
| <a name="module_observe_firehose_eventbridge"></a> [observe\_firehose\_eventbridge](#module\_observe\_firehose\_eventbridge) | observeinc/kinesis-firehose/aws//modules/eventbridge | 2.1.0 |
| <a name="module_observe_kinesis_firehose"></a> [observe\_kinesis\_firehose](#module\_observe\_kinesis\_firehose) | observeinc/kinesis-firehose/aws | 2.1.0 |
| <a name="module_observe_lambda"></a> [observe\_lambda](#module\_observe\_lambda) | observeinc/lambda/aws | 3.3.0 |
| <a name="module_observe_lambda_s3_bucket_subscription"></a> [observe\_lambda\_s3\_bucket\_subscription](#module\_observe\_lambda\_s3\_bucket\_subscription) | observeinc/lambda/aws//modules/s3_bucket_subscription | 3.3.0 |
| <a name="module_observe_lambda_snapshot"></a> [observe\_lambda\_snapshot](#module\_observe\_lambda\_snapshot) | observeinc/lambda/aws//modules/snapshot | 3.3.0 |
Expand Down
67 changes: 67 additions & 0 deletions infrastructure/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# CloudFormation AWS Collection Infrastructure

This directory contains a Terraform module responsible for setting up the necessary infrastructure to allow GitHub Actions to release CloudFormation templates to an S3 bucket using OIDC for authentication. This ensures a seamless integration between the CI/CD pipeline and AWS services.

## Usage

Changes to this module are not automatically applied. After merging changes, you should manually apply them.

### Requirements

- **AWS Credentials**: Ensure that you have AWS credentials set up with permissions to create IAM roles, OIDC providers, and manage the specified S3 bucket.

- **GitHub Access Token**: Set the `GITHUB_TOKEN` environment variable to a GitHub access token with at least the `repo` scope. This token should also have permission to set repository secrets.

### Setup

1. Initialize the Terraform directory:

```bash
terraform init
```

2. Verify your AWS identity to ensure you're acting as the expected user or role:
```bash
aws sts get-caller-identity
```
Check the output to ensure your ARN and account match your expectations.
3. Plan your Terraform changes:
```bash
terraform plan -out=tfplan
```
Review the plan to see what changes will be made. Make sure everything aligns with your intentions.
4. Apply the Terraform changes:
```bash
terraform apply tfplan
```
If everything looks correct, approve the changes to apply them.
### Destroy
To tear down the resources created by this module (use with caution):
```bash
terraform destroy
```
## Contents
### GitHub Actions Integration
- Sets up an OIDC provider in AWS to allow GitHub Actions to authenticate.
- Creates an IAM role with permissions that allow GitHub Actions to release CloudFormation templates to the specified S3 bucket.
- Configures GitHub Actions variables in the repository with the ARN of the IAM role so that it can be used.
### S3 Bucket Management
- Grants necessary permissions to the IAM role to read from and write to the specified S3 bucket.
7 changes: 7 additions & 0 deletions infrastructure/backend.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
terraform {
backend "s3" {
bucket = "observe-github-tf-state"
region = "us-west-2"
key = "github.com/observeinc/terraform-aws-collection"
}
}
57 changes: 57 additions & 0 deletions infrastructure/main.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
locals {
organization = "observeinc"
repository = "terraform-aws-collection"
}

data "aws_iam_openid_connect_provider" "github_actions" {
url = "https://token.actions.githubusercontent.com"
}

locals {
oidc_claim_prefix = trimprefix(data.aws_iam_openid_connect_provider.github_actions.url, "https://")
}

data "aws_iam_policy_document" "github_actions_assume_role" {
statement {
actions = ["sts:AssumeRoleWithWebIdentity"]

principals {
type = "Federated"
identifiers = [data.aws_iam_openid_connect_provider.github_actions.arn]
}

condition {
test = "StringLike"
variable = "${local.oidc_claim_prefix}:sub"
values = ["repo:${local.organization}/${local.repository}:*"]
}

condition {
test = "StringEquals"
variable = "${local.oidc_claim_prefix}:aud"
values = ["sts.amazonaws.com"]
}
}
}

resource "aws_iam_role" "github_actions_ci" {
name = "${local.repository}-gha-ci"

assume_role_policy = data.aws_iam_policy_document.github_actions_assume_role.json

tags = {
Principal = "GitHub Actions"
Repository = "${local.organization}/${local.repository}"
}
}

resource "aws_iam_role_policy_attachment" "admin_policy_attachment" {
role = aws_iam_role.github_actions_ci.name
policy_arn = "arn:aws:iam::aws:policy/AdministratorAccess"
}

resource "github_actions_secret" "aws_ci_role" {
repository = local.repository
secret_name = "AWS_ROLE_ARN"
plaintext_value = aws_iam_role.github_actions_ci.arn
}
3 changes: 3 additions & 0 deletions infrastructure/providers.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
provider "github" {
owner = local.organization
}
Empty file added infrastructure/variables.tf
Empty file.
13 changes: 13 additions & 0 deletions infrastructure/versions.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
terraform {
required_providers {
github = {
source = "integrations/github"
version = "~> 5"
}

aws = {
source = "hashicorp/aws"
version = "~> 5"
}
}
}

0 comments on commit 3b34140

Please sign in to comment.