Component: github-webhook

This component provisions a GitHub webhook for a single GitHub repository.

You may want to use this component if you are provisioning webhooks for multiple ArgoCD deployment repositories across GitHub organizations.

Usage

Stack Level: Regional

Here's an example snippet for how to use this component. This example pulls the value of the webhook from remote-state

components:
  terraform:
    webhook/cloudposse/argocd:
      metadata:
        component: github-webhook
      vars:
        github_organization: cloudposse
        github_repository: argocd-deploy-non-prod
        webhook_url: "https://argocd.ue2.dev.plat.cloudposse.org/api/webhook"

        remote_state_github_webhook_enabled: true # default value added for visibility
        remote_state_component_name: eks/argocd

SSM Stored Value Example

Here's an example snippet for how to use this component with a value stored in SSM

components:
  terraform:
    webhook/cloudposse/argocd:
      metadata:
        component: github-webhook
      vars:
        github_organization: cloudposse
        github_repository: argocd-deploy-non-prod
        webhook_url: "https://argocd.ue2.dev.plat.cloudposse.org/api/webhook"

        remote_state_github_webhook_enabled: false
        ssm_github_webhook_enabled: true
        ssm_github_webhook: "/argocd/github/webhook"

Input Value Example

Here's an example snippet for how to use this component with a value stored in Terraform variables.

components:
  terraform:
    webhook/cloudposse/argocd:
      metadata:
        component: github-webhook
      vars:
        github_organization: cloudposse
        github_repository: argocd-deploy-non-prod
        webhook_url: "https://argocd.ue2.dev.plat.cloudposse.org/api/webhook"

        remote_state_github_webhook_enabled: false
        ssm_github_webhook_enabled: false
        webhook_github_secret: "abcdefg"

ArgoCD Webhooks

For usage with the eks/argocd component, see Creating Webhooks with github-webhook in that component's README.

Requirements

Name	Version
terraform	>= 1.0.0
aws	>= 4.0
github	>= 4.0

Providers

Name	Version
aws	>= 4.0
github	>= 4.0

Modules

Name	Source	Version
iam_roles	../account-map/modules/iam-roles	n/a
source	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
this	cloudposse/label/null	0.25.0

Resources

Name	Type
github_repository_webhook.default	resource
aws_ssm_parameter.github_api_key	data source
aws_ssm_parameter.webhook	data source

Inputs

Name	Description	Type	Default	Required
additional_tag_map	Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id. This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration.	map(string)	{}	no
attributes	ID element. Additional attributes (e.g. workers or cluster) to add to id, in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the delimiter and treated as a single ID element.	list(string)	[]	no
context	Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as null to use default value. Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged.	any	{ "additional_tag_map": {}, "attributes": [], "delimiter": null, "descriptor_formats": {}, "enabled": true, "environment": null, "id_length_limit": null, "label_key_case": null, "label_order": [], "label_value_case": null, "labels_as_tags": [ "unset" ], "name": null, "namespace": null, "regex_replace_chars": null, "stage": null, "tags": {}, "tenant": null }	no
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
descriptor_formats	Describe additional descriptors to be output in the descriptors output map. Map of maps. Keys are names of descriptors. Values are maps of the form {<br/> format = string<br/> labels = list(string)<br/>} (Type is any so the map values can later be enhanced to provide additional options.) format is a Terraform format string to be passed to the format() function. labels is a list of labels, in order, to pass to format() function. Label values will be normalized before being passed to format() so they will be identical to how they appear in id. Default is {} (descriptors output will be empty).	any	{}	no
enabled	Set to false to prevent the module from creating any resources	bool	null	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	no
github_base_url	This is the target GitHub base API endpoint. Providing a value is a requirement when working with GitHub Enterprise. It is optional to provide this value and it can also be sourced from the GITHUB_BASE_URL environment variable. The value must end with a slash, for example: https://terraformtesting-ghe.westus.cloudapp.azure.com/	string	null	no
github_organization	The name of the GitHub Organization where the repository lives	string	n/a	yes
github_repository	The name of the GitHub repository where the webhook will be created	string	n/a	yes
github_token_override	Use the value of this variable as the GitHub token instead of reading it from SSM	string	null	no
id_length_limit	Limit id to this many characters (minimum 6). Set to 0 for unlimited length. Set to null for keep the existing setting, which defaults to 0. Does not affect id_full.	number	null	no
label_key_case	Controls the letter case of the tags keys (label names) for tags generated by this module. Does not affect keys of tags passed in via the tags input. Possible values: lower, title, upper. Default value: title.	string	null	no
label_order	The order in which the labels (ID elements) appear in the id. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.	list(string)	null	no
label_value_case	Controls the letter case of ID elements (labels) as included in id, set as tag values, and output by this module individually. Does not affect values of tags passed in via the tags input. Possible values: lower, title, upper and none (no transformation). Set this to title and set delimiter to "" to yield Pascal Case IDs. Default value: lower.	string	null	no
labels_as_tags	Set of labels (ID elements) to include as tags in the tags output. Default is to include all labels. Tags with empty values will not be included in the tags output. Set to [] to suppress all generated tags. Notes: The value of the name tag, if included, will be the id, not the name. Unlike other null-label inputs, the initial setting of labels_as_tags cannot be changed in later chained modules. Attempts to change it will be silently ignored.	set(string)	[ "default" ]	no
name	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a tag. The "name" tag is set to the full id string. There is no tag with the value of the name input.	string	null	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	string	null	no
regex_replace_chars	Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.	string	null	no
region	AWS Region.	string	n/a	yes
remote_state_component_name	If fetching the Github Webhook value from remote-state, set this to the source compoennt name. For example, eks/argocd.	string	""	no
remote_state_github_webhook_enabled	If true, pull the GitHub Webhook value from remote-state	bool	true	no
ssm_github_api_key	SSM path to the GitHub API key	string	"/argocd/github/api_key"	no
ssm_github_webhook	Format string of the SSM parameter path where the webhook will be pulled from. Only used if var.webhook_github_secret is not given.	string	"/github/webhook"	no
ssm_github_webhook_enabled	If true, pull the GitHub Webhook value from AWS SSM Parameter Store using var.ssm_github_webhook	bool	false	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
tags	Additional tags (e.g. {'BusinessUnit': 'XYZ'}). Neither the tag keys nor the tag values will be modified by this module.	map(string)	{}	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	string	null	no
webhook_github_secret	The value to use as the GitHub webhook secret. Set both var.ssm_github_webhook_enabled and var.remote_state_github_webhook_enabled to false in order to use this value	string	""	no
webhook_url	The URL for the webhook	string	n/a	yes

Outputs

No outputs.

References

• cloudposse/terraform-aws-components - Cloud Posse's upstream components