Skip to content

feat: remove deprecated bata feature workflow job queue #4249

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 12, 2024

Conversation

npalm
Copy link
Member

@npalm npalm commented Nov 11, 2024

Description

This PR removed the deprecated (beta / experimental) feature to publish the workflow_job event on an extra queue.

Test

  • default example
  • multi runner

Migration

Migration when depended on the feature can be done as follow

Enable eventbridge

module "runners" {

  ...
  eventbridge {
    enable = true}
  }
  ...

Add rule to forward events to a queue

resource "aws_cloudwatch_event_rule" "workflow_job_in_progress" {
  name           = "workflow-job-in-progress"
  event_bus_name = modules.runners.webhook.eventbridge.name # The name of the event bus output by the module

  event_pattern = <<EOF
{
  "detail-type": ["workflow_job"],
  "detail": {
    "action": ["in_progress"]
  }
}
EOF
}

resource "aws_sqs_queue" "workflow_job_in_progress" {
  name = "workflow_job_in_progress
}


resource "aws_sqs_queue_policy" "workflow_job_in_progress" {
  queue_url = aws_sqs_queue.workflow_job_in_progress.id
  policy    = data.aws_iam_policy_document.sqs_policy.json
}

data "aws_iam_policy_document" "sqs_policy" {
  statement {
    sid     = "AllowFromEventBridge"
    actions = ["sqs:SendMessage"]

    principals {
      type        = "Service"
      identifiers = ["events.amazonaws.com"]
    }

    resources = [aws_sqs_queue.workflow_job_in_progress.arn]

    condition {
      test     = "ArnEquals"
      variable = "aws:SourceArn"
      values   = [aws_cloudwatch_event_rule.workflow_job_in_progress.arn]
    }
  }
}

@npalm npalm self-assigned this Nov 11, 2024
@npalm npalm marked this pull request as draft November 11, 2024 08:51
@npalm npalm marked this pull request as ready for review November 11, 2024 09:08
@npalm npalm changed the title feat: remove depcrecated bata feature workflow job queue feat: remove deprecated bata feature workflow job queue Nov 11, 2024
@npalm npalm merged commit 4066c4e into main Nov 12, 2024
49 checks passed
@npalm npalm deleted the npalm/remove-deprecated-bata-job-queueu branch November 12, 2024 08:02
npalm pushed a commit that referenced this pull request Nov 12, 2024
🤖 I have created a release *beep* *boop*
---


##
[5.19.0](philips-labs/terraform-aws-github-runner@v5.18.4...v5.19.0)
(2024-11-12)


### Features

* remove deprecated bata feature workflow job queue
([#4249](https://github.com/philips-labs/terraform-aws-github-runner/issues/4249))
([4066c4e](philips-labs/terraform-aws-github-runner@4066c4e))


### Bug Fixes

* dispatch only queued events to runners
([#4257](https://github.com/philips-labs/terraform-aws-github-runner/issues/4257))
([a0a8322](philips-labs/terraform-aws-github-runner@a0a8322))
* **lambda:** bump @octokit/auth-app from 6.1.2 to 6.1.3 in /lambdas in
the octokit group
([#4252](https://github.com/philips-labs/terraform-aws-github-runner/issues/4252))
([25f3538](philips-labs/terraform-aws-github-runner@25f3538))
* **lambda:** bump the aws group in /lambdas with 7 updates
([#4251](https://github.com/philips-labs/terraform-aws-github-runner/issues/4251))
([6a98712](philips-labs/terraform-aws-github-runner@6a98712))


### Migration notes

This release removes experimental / beta feature
`enable_workflow_job_events_queue`. When depending on the events on this
queue you can migrate to using the EventBridgge.

#### Enable eventbridge

```hcl
module "runners" {

  ...
  eventbridge {
    enable = true
  }
  ...

```


#### Add rule to forward events to a queue

```hcl

resource "aws_cloudwatch_event_rule" "workflow_job_in_progress" {
  name           = "workflow-job-in-progress"
  event_bus_name = modules.runners.webhook.eventbridge.name # The name of the event bus output by the module

  event_pattern = <<EOF
{
  "detail-type": ["workflow_job"],
  "detail": {
    "action": ["in_progress"]
  }
}
EOF
}

resource "aws_sqs_queue" "workflow_job_in_progress" {
  name = "workflow_job_in_progress
}


resource "aws_sqs_queue_policy" "workflow_job_in_progress" {
  queue_url = aws_sqs_queue.workflow_job_in_progress.id
  policy    = data.aws_iam_policy_document.sqs_policy.json
}

data "aws_iam_policy_document" "sqs_policy" {
  statement {
    sid     = "AllowFromEventBridge"
    actions = ["sqs:SendMessage"]

    principals {
      type        = "Service"
      identifiers = ["events.amazonaws.com"]
    }

    resources = [aws_sqs_queue.workflow_job_in_progress.arn]

    condition {
      test     = "ArnEquals"
      variable = "aws:SourceArn"
      values   = [aws_cloudwatch_event_rule.workflow_job_in_progress.arn]
    }
  }
}
```


---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: forest-releaser[bot] <80285352+forest-releaser[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants