Support new GitHub bot deployment #15

ChengaDev · 2024-05-01T05:21:51Z

Enable deployment of our new GitHub bot via Terraform
Enable several instances of the bot in a single region
Enable set custom name pattern for all module resources
Allow the user to set a path to the required source code files he wants to deploy to the lambdas
Update runtime to nodejs20.x

kaplanelad · 2024-06-03T06:03:03Z

README.md

@@ -152,3 +152,7 @@ module "spectral_lambda_integration" {
 8. `lambda_iam_role_arn` - Amazon Resource Name (ARN) specifying the role.
 9. `lambda_iam_role_name` - Name of the role.
 10. `secrets_arns` - Arns of created secrets in secrets manager.
+
+## Support


Adding a changelog file that lists versions, describes the changes, and breaks changes per version is essential, and can avoid a lot of questions.

kaplanelad · 2024-06-03T06:08:42Z

README.md

@@ -14,14 +14,14 @@ Terraform configuration used to create the required AWS resources for integratin

 | Name      | Version |
 | ----------- | ----------- |
-| [aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs)      | >= 4.37.0    |
+| [aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs)      | >= 5.26.0    |

 ## Inputs


There is some missing fields in the documentation. check out this tool https://terraform-docs.io/ it can help you to manage it
lambda_source_code_path
frontend_lambda_source_code_path
backend_lambda_source_code_path
lambda_logs_retention_in_days
lambda_enable_logs
resource_name_common_part
secrets_names
gateway_api_integration_timeout_milliseconds

kaplanelad · 2024-06-03T06:10:54Z

README.md

@@ -30,7 +30,7 @@ Terraform configuration used to create the required AWS resources for integratin
 | `lambda_function_timeout` | Amount of time your Lambda Function has to run in seconds.  | `number` | 300 | No |
 | `lambda_function_memory_size` | Amount of memory in MB your Lambda Function can use at runtime. | `number` | 1024 | No |
 | `lambda_publish` | Whether to publish creation/change as new Lambda Function Version. | `bool` | `false` | No |
-| `store_secret_in_secrets_manager` | Whether to store secrets values on a vault (currently supporting AWS secrets manager on GitLab integration). | `bool` | `false` | No |
+| `store_secret_in_secrets_manager` | Whether to store secrets values on a vault (currently supporting AWS secrets manager on GitHub / GitLab integration). | `bool` | `false` | No |

 ### env_vars


This section is partially relevant to the bots.
i think we can remove this section and redirect to our guide docs

The env vars are not detailed in this section, this just shows how to set variables and redirects the users to the docs.
The only env var mentioned here is SPECTRAL_DSN which is always mandatory.

If this is the var that is mandatory, in a different but, there is more mandatory env var. i just say to refer to our docs and remote this section

kaplanelad · 2024-06-03T06:15:57Z

locals.tf

  api_triggered_function_arn  = local.single_lambda_integration ? module.lambda_function[0].lambda_function_arn : module.frontend_lambda_function[0].lambda_function_arn
+  frontend_lambda_handler     = contains(["github"], var.integration_type) ? "index.handler" : "frontend.app"
+  backend_lambda_handler      = contains(["github"], var.integration_type) ? "index.handler" : "backend.app"
+  default_secrets_names = {


what about SPECTRAL_DSN?

kaplanelad · 2024-06-03T06:20:20Z

locals.tf

+    "gitlab" = coalesce(var.secrets_names, ["Spectral_GitlabBot_GitlabToken", "Spectral_GitlabBot_WebhookSecret"])
+  }
+  # Please do not change or replace the 'frontend' suffix since there a logic in the bot based in it
+  function_name = local.single_lambda_integration ? local.resource_name_pattern : "${local.resource_name_pattern}-frontend"


function_name can be confusing since it implies working with both the backend and the front end. I recommend the following changes:

Rename options:

receive_hook_lambda_name

provider_request_treigger_lambda_name

The idea is to understand when you read this variable what he does.

Changed to api_integrated_function_name

kaplanelad · 2024-06-03T06:21:39Z

modules/lambda/variables.tf

 variable "lambda_source_code_filename" {
  type        = string
  description = "The lambda source code filename"
 }

+variable "lambda_source_code_path" {


You can use terraform-docs to generate the readme file for the lambda module.
this is relevant for all the modules

kaplanelad · 2024-06-03T06:23:35Z

multiple-lambdas-integration.tf

+  environment      = var.environment
+  integration_type = var.integration_type
+  # Please do not change or replace the 'frontend' suffix since there a logic in the bot based in it
+  resource_name_pattern       = "${local.resource_name_pattern}-frontend"


We currently have ${local.resource_name_pattern}-frontend in the locals.

Can we use the same variable to reduce the string concatenations?

kaplanelad · 2024-06-03T06:25:29Z

shared.tf

 }

 module "lambda_role" {
  source                          = "./modules/role"
-  resource_name_pattern           = local.single_lambda_integration ? local.resource_name_pattern : "${local.resource_name_pattern}-frontend"
+  role_name                       = local.function_name


Why is the role name getting the function name?

Because this role and its policies were created explicitly for this lambda function, and with this function name there will be no doubt about why this role was created and who should use it

initial commit

2e72689

ChengaDev added the wip Work in progress label May 1, 2024

ChengaDev added 12 commits May 23, 2024 14:28

update shared resources name patterns

d1d4d35

nodejs20.x + update default name pattern

687c51f

fmt

695aef0

enhance function name variable to api gateway

4f62c8e

improve secrets management

fdafa31

example + readme

14b09e1

fix example

6cb7f4d

update readme + mvoe logic to locals

fda3e7c

github source code

a86a981

formatting

393253e

update all sources codes

a9f24df

update gitlab source code

a67a435

kaplanelad reviewed Jun 3, 2024

View reviewed changes

ChengaDev added 2 commits June 3, 2024 14:33

add changelog + cr changes

731e6d9

update outputs & readme

8b25bc1

kaplanelad approved these changes Jun 3, 2024

View reviewed changes

ChengaDev added readyforreview and removed wip Work in progress labels Jun 3, 2024

ChengaDev added 2 commits June 3, 2024 23:21

remove SPECTRAL_DSN

5ccf235

rename to api_triggered_function_name

57a1d15

ChengaDev changed the title ~~WIP - Support new GitHub bot deployment~~ Support new GitHub bot deployment Jun 3, 2024

improve role name

c933e4a

eladbash approved these changes Jun 6, 2024

View reviewed changes

ChengaDev added 5 commits June 22, 2024 22:27

add HOME to default variables

527636b

make sure HOME is set

ceec324

lambda module take var from var

50392e1

formatting

605cc6a

GH bot 2.0.4

23d9a4d

update date in change log

be0a379

ChengaDev merged commit 6e71c1a into main Jun 25, 2024
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support new GitHub bot deployment #15

Support new GitHub bot deployment #15

ChengaDev commented May 1, 2024 •

edited

Loading

kaplanelad Jun 3, 2024

kaplanelad Jun 3, 2024

kaplanelad Jun 3, 2024

ChengaDev Jun 3, 2024

kaplanelad Jun 3, 2024

kaplanelad Jun 3, 2024

ChengaDev Jun 3, 2024

kaplanelad Jun 3, 2024

ChengaDev Jun 3, 2024

kaplanelad Jun 3, 2024

kaplanelad Jun 3, 2024

kaplanelad Jun 3, 2024

ChengaDev Jun 3, 2024

Support new GitHub bot deployment #15

Support new GitHub bot deployment #15

Conversation

ChengaDev commented May 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ChengaDev commented May 1, 2024 •

edited

Loading