-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3 from ministryofjustice/docs/updated-readme
updated readme.md
- Loading branch information
Showing
1 changed file
with
62 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,24 +1,79 @@ | ||
| # Modernisation Platform Terraform Module Template | ||
| [](https://operations-engineering-reports.cloud-platform.service.justice.gov.uk/github_repositories#modernisation-platform-terraform-module-template "Link to report") | ||
| # Modernisation Platform Github OIDC Provider Module | ||
| [](https://operations-engineering-reports.cloud-platform.service.justice.gov.uk/github_repositories#modernisation-platform-terraform-github-oidc-provider "Link to report") | ||
|
|
||
| This module allows users to create an [OIDC Provider](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_openid_connect_provider) | ||
| and the associated IAM resources required to make use of the connect provider. | ||
|
|
||
| ## Usage | ||
|
|
||
| ```hcl | ||
| module "template" { | ||
| source = "github.com/ministryofjustice/modernisation-platform-terraform-module-template" | ||
| module "github-oidc-provider" { | ||
| tags = local.tags | ||
| application_name = local.application_name | ||
| source = "https://github.com/ministryofjustice/modernisation-platform-terraform-github-oidc-provider" | ||
| github_repository = "ministryofjustice/your-repository-name:*" | ||
| additional_permissions = data.aws_iam_policy_document.extra_permissions.json | ||
| tags_common = local.tags | ||
| tags_prefix = terraform.workspace | ||
| } | ||
| ``` | ||
|
|
||
| The `additional_permissions` variable will allow you to supply any required IAM permissions beyond `ReadOnlyAccess` in the form of | ||
| an `aws_iam_policy_document` data call. | ||
|
|
||
| <!--- BEGIN_TF_DOCS ---> | ||
|
|
||
|
|
||
| <!--- END_TF_DOCS ---> | ||
|
|
||
| ## Looking for issues? | ||
| If you're looking to raise an issue with this module, please create a new issue in the [Modernisation Platform repository](https://github.com/ministryofjustice/modernisation-platform/issues). | ||
|
|
||
| <!-- BEGIN_TF_DOCS --> | ||
| ## Requirements | ||
|
|
||
| | Name | Version | | ||
| |------|---------| | ||
| | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.1 | | ||
| | <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 4.0 | | ||
|
|
||
| ## Providers | ||
|
|
||
| | Name | Version | | ||
| |------|---------| | ||
| | <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 4.0 | | ||
| | <a name="provider_tls"></a> [tls](#provider\_tls) | n/a | | ||
|
|
||
| ## Modules | ||
|
|
||
| No modules. | ||
|
|
||
| ## Resources | ||
|
|
||
| | Name | Type | | ||
| |------|------| | ||
| | [aws_iam_openid_connect_provider.github_actions](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_openid_connect_provider) | resource | | ||
| | [aws_iam_policy.extra_permissions](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource | | ||
| | [aws_iam_role.github_actions](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource | | ||
| | [aws_iam_role_policy_attachment.read_only](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource | | ||
| | [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source | | ||
| | [aws_iam_policy_document.github_oidc_assume_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | | ||
| | [tls_certificate.github](https://registry.terraform.io/providers/hashicorp/tls/latest/docs/data-sources/certificate) | data source | | ||
|
|
||
| ## Inputs | ||
|
|
||
| | Name | Description | Type | Default | Required | | ||
| |------|-------------|------|---------|:--------:| | ||
| | <a name="input_additional_permissions"></a> [additional\_permissions](#input\_additional\_permissions) | accept aws\_iam\_policy\_document with additional permissions to attach to the github-actions role | `string` | n/a | yes | | ||
| | <a name="input_github_repository"></a> [github\_repository](#input\_github\_repository) | The github repository, for example ministryofjustice/modernisation-platform-environments:* | `string` | n/a | yes | | ||
| | <a name="input_tags_common"></a> [tags\_common](#input\_tags\_common) | MOJ required tags | `map(string)` | n/a | yes | | ||
| | <a name="input_tags_prefix"></a> [tags\_prefix](#input\_tags\_prefix) | prefix for name tags | `string` | n/a | yes | | ||
|
|
||
| ## Outputs | ||
|
|
||
| | Name | Description | | ||
| |------|-------------| | ||
| | <a name="output_github_actions_provider"></a> [github\_actions\_provider](#output\_github\_actions\_provider) | This module configures an OIDC provider for use with GitHub actions | | ||
| <!-- END_TF_DOCS --> |