diff --git a/README.md b/README.md index 043a20c..7720ba4 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ To create runner deployments see the [actions runner module](https://registry.te ```hcl # setup actions-runner-controller -module "actions-runner-controller" { +module "actions_runner_controller" { source = "../.." namespace = "github-actions-runner-controller" create_namespace = true @@ -35,51 +35,51 @@ module "actions-runner-controller" { ## Requirements -| Name | Version | -| ---------------------------------------------------------------------------- | --------- | -| [terraform](#requirement\_terraform) | >= 0.13 | -| [helm](#requirement\_helm) | >= 2.11.0 | +| Name | Version | +|------|---------| +| [terraform](#requirement\_terraform) | >= 0.13 | +| [helm](#requirement\_helm) | >= 2.11.0 | | [kubernetes](#requirement\_kubernetes) | >= 2.23.0 | ## Providers -| Name | Version | -| ---------------------------------------------------------------------- | --------- | -| [helm](#provider\_helm) | >= 2.11.0 | +| Name | Version | +|------|---------| +| [helm](#provider\_helm) | >= 2.11.0 | | [kubernetes](#provider\_kubernetes) | >= 2.23.0 | ## Resources -| Name | Type | -| ------------------------------------------------------------------------------------------------------------------------- | -------- | -| [helm_release.this](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource | +| Name | Type | +|------|------| +| [helm_release.this](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource | | [kubernetes_namespace.this](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/namespace) | resource | -| [kubernetes_secret.this](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/secret) | resource | +| [kubernetes_secret.this](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/secret) | resource | ## Inputs -| Name | Description | Type | Default | Required | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------ | :------: | -| [github\_app\_id](#input\_github\_app\_id) | GitHub App ID | `string` | n/a | yes | -| [github\_app\_install\_id](#input\_github\_app\_install\_id) | GitHub App Install ID | `string` | n/a | yes | -| [github\_app\_private\_key](#input\_github\_app\_private\_key) | GitHub App Private Key | `string` | n/a | yes | -| [allow\_granting\_container\_mode\_permissions](#input\_allow\_granting\_container\_mode\_permissions) | If true, the runner controller will be allowed to grant container mode permissions | `bool` | `false` | no | -| [atomic](#input\_atomic) | If true, installation process purges chart on fail. If false, installation process deletes resources created by chart, but not purge them | `bool` | `true` | no | -| [create\_namespace](#input\_create\_namespace) | If true, the namespace will be created | `bool` | `true` | no | -| [helm\_chart\_version](#input\_helm\_chart\_version) | The version of the helm chart to deploy | `string` | `"0.23.5"` | no | -| [helm\_deployment\_name](#input\_helm\_deployment\_name) | The name of the helm deployment | `string` | `"actions-runner-controller"` | no | -| [kubernetes\_secret\_name](#input\_kubernetes\_secret\_name) | The name of the secret to create | `string` | `"github-auth-secret"` | no | -| [namespace](#input\_namespace) | The namespace to deploy the runner controller into | `string` | `"github-actions-runner-controller"` | no | -| [replicas](#input\_replicas) | The number of replicas for the runner controller | `number` | `3` | no | -| [timeout](#input\_timeout) | Time in seconds to wait for helm deployment operation (like Jobs for hooks) | `number` | `600` | no | +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [github\_app\_id](#input\_github\_app\_id) | GitHub App ID | `string` | n/a | yes | +| [github\_app\_install\_id](#input\_github\_app\_install\_id) | GitHub App Install ID | `string` | n/a | yes | +| [github\_app\_private\_key](#input\_github\_app\_private\_key) | GitHub App Private Key | `string` | n/a | yes | +| [allow\_granting\_container\_mode\_permissions](#input\_allow\_granting\_container\_mode\_permissions) | If true, the runner controller will be allowed to grant container mode permissions | `bool` | `false` | no | +| [atomic](#input\_atomic) | If true, installation process purges chart on fail. If false, installation process deletes resources created by chart, but not purge them | `bool` | `true` | no | +| [create\_namespace](#input\_create\_namespace) | If true, the namespace will be created | `bool` | `true` | no | +| [helm\_chart\_version](#input\_helm\_chart\_version) | The version of the helm chart to deploy | `string` | `"0.23.5"` | no | +| [helm\_deployment\_name](#input\_helm\_deployment\_name) | The name of the helm deployment | `string` | `"actions-runner-controller"` | no | +| [kubernetes\_secret\_name](#input\_kubernetes\_secret\_name) | The name of the secret to create | `string` | `"github-auth-secret"` | no | +| [namespace](#input\_namespace) | The namespace to deploy the runner controller into | `string` | `"github-actions-runner-controller"` | no | +| [replicas](#input\_replicas) | The number of replicas for the runner controller | `number` | `3` | no | +| [timeout](#input\_timeout) | Time in seconds to wait for helm deployment operation (like Jobs for hooks) | `number` | `600` | no | ## Outputs -| Name | Description | -| ---------------------------------------------------------------------------------------------------- | ------------------------------------------------- | -| [helm\_deployment\_name](#output\_helm\_deployment\_name) | The name of the helm deployment | -| [namespace](#output\_namespace) | The namespace runner controller was deployed into | -| [secret\_name](#output\_secret\_name) | The name of the secret created | +| Name | Description | +|------|-------------| +| [helm\_deployment\_name](#output\_helm\_deployment\_name) | The name of the helm deployment | +| [namespace](#output\_namespace) | The namespace runner controller was deployed into | +| [secret\_name](#output\_secret\_name) | The name of the secret created | \ No newline at end of file diff --git a/examples/full/.terraform.lock.hcl b/examples/full/.terraform.lock.hcl index 9bb41bf..02052d3 100644 --- a/examples/full/.terraform.lock.hcl +++ b/examples/full/.terraform.lock.hcl @@ -39,21 +39,21 @@ provider "registry.terraform.io/hashicorp/helm" { } provider "registry.terraform.io/hashicorp/kubernetes" { - version = "2.24.0" + version = "2.25.1" constraints = ">= 2.23.0" hashes = [ - "h1:u9lRMCdNXcB5/WQTZVMvGhNliW2pKOzj3SOVbu9yPpg=", - "zh:0ed83ec390a7e75c4990ebce698f14234de2b6204ed9a01cd042bb7ea5f26564", - "zh:195150e4fdab259c70088528006f4604557a051e037ebe8de64e92840f27e40a", - "zh:1a334af55f7a74adf033eb871c9fe7e9e648b41ab84321114ef4ca0e7a34fba6", - "zh:1ef68c3832691de21a61bf1a4e268123f3e08850712eda0b893cac908a0d1bc1", - "zh:44a1c58e5a6646e62b0bad653319c245f3b635dd03554dea2707a38f553e4a52", - "zh:54b5b374c4386f7f05b3fe986f9cb57bde4beab3bdf6ee33444f2b9a81b8af64", - "zh:aa8c2687ab784b72f8cdad8d3c3673dea83b33561e7b3f2d287ef0d06ff2a9e5", - "zh:e6ecba0503052ef3ad49ad56e17b2a73d9b55e30fcb82b040189d281e25e1a3b", - "zh:f105393f6487d3eb1f1636ba42d10c82950ddfef852244c1bca8d526fa23a9a3", - "zh:f17a8f1914ec66d80ccacecd40123362cf093abee3d3aa1ff9f8f687d8736f85", - "zh:f394b12ef01fa0bdf666a43ad152eb3890134f35e635ea056b18771c292de46e", + "h1:+fjUsoVE/KZfav8BgeQBMKkzpSIjiKhqmDPAPSgviMw=", + "zh:019dcbdd0f6b79bc6331de0f985974585ebdae135924a47991448552f6e7b614", + "zh:10e8e1d4952d1a8d964cf9d9ef980d769ac2b94f56be6cd093b65c700a5023a6", + "zh:11315addb658a91d38f6d1db3358f72de4f3b9bae0934f2f8b0bdff93088711b", + "zh:480db7342b6763dabdaf248782de5a145f7c3b38f88e15e935fd890ad3947d7c", + "zh:4e6d361b3515d1f0255f04ae8b3952cc7ee0133e98142b2fa4b09e83b5c92721", + "zh:5571cf6f7a674c98a9dad4558c1aa65f5883e643e958fcf43c2f7bb474f39fae", + "zh:aec2fe1cafdb413b28e2e74f7f307929497146b99feaaf120a50e4b35e3a892d", + "zh:b6fef36d86b06aec67ffd08280e467b6a268228a4e30202e1981854de8ce7b24", + "zh:ba5eb0e7764df926eb46424bf567ff6226deb00fca389792aa960470345d86cd", + "zh:c79e260c98decd69e956a5a55347127a5a8b3ec5a08c57a0eb127b2cd4bb9292", + "zh:e80a1ee38c21a85607da635c9c18b847d7c2e72a9b1b43e37f05490754d35213", "zh:f569b65999264a9416862bca5cd2a6177d94ccb0424f3a4ef424428912b9cb3c", ] } diff --git a/examples/full/README.md b/examples/full/README.md index 644b76b..52827b5 100644 --- a/examples/full/README.md +++ b/examples/full/README.md @@ -20,7 +20,7 @@ resource "helm_release" "cert_manager" { repository = "https://charts.jetstack.io" chart = "cert-manager" version = "v1.12.3" - namespace = kubernetes_namespace.cert_manager.metadata.0.name + namespace = kubernetes_namespace.cert_manager.metadata[0].name atomic = true timeout = 600 set { @@ -34,7 +34,7 @@ resource "helm_release" "cert_manager" { ```hcl # setup actions-runner-controller -module "actions-runner-controller" { +module "actions_runner_controller" { source = "../.." namespace = "github-actions-runner-controller" create_namespace = true @@ -61,24 +61,24 @@ module "actions-runner-controller" { resource "kubernetes_service_account" "runner" { metadata { name = "test-runner" - namespace = module.actions-runner-controller.namespace + namespace = module.actions_runner_controller.namespace } secret { - name = kubernetes_secret.runner.metadata.0.name + name = kubernetes_secret.runner.metadata[0].name } } resource "kubernetes_secret" "runner" { metadata { name = "test-runner" - namespace = module.actions-runner-controller.namespace + namespace = module.actions_runner_controller.namespace } } resource "kubernetes_role" "runner" { metadata { name = "test-runner" - namespace = module.actions-runner-controller.namespace + namespace = module.actions_runner_controller.namespace } rule { @@ -111,7 +111,7 @@ resource "kubernetes_role" "runner" { resource "kubernetes_role_binding" "runner" { metadata { name = "test-runner" - namespace = module.actions-runner-controller.namespace + namespace = module.actions_runner_controller.namespace } role_ref { api_group = "rbac.authorization.k8s.io" @@ -121,7 +121,7 @@ resource "kubernetes_role_binding" "runner" { subject { kind = "ServiceAccount" name = "test-runner" - namespace = module.actions-runner-controller.namespace + namespace = module.actions_runner_controller.namespace } } @@ -131,7 +131,7 @@ resource "kubectl_manifest" "runner" { kind = "RunnerDeployment" metadata = { name = "test-runner" - namespace = module.actions-runner-controller.namespace + namespace = module.actions_runner_controller.namespace } spec = { replicas = 2 @@ -139,7 +139,7 @@ resource "kubectl_manifest" "runner" { spec = { repository = "infinite-automations/terraform-helm-github-actions-runner-controller" labels = var.labels - serviceAccountName = kubernetes_service_account.runner.metadata.0.name + serviceAccountName = kubernetes_service_account.runner.metadata[0].name containerMode = "kubernetes" workVolumeClaimTemplate = { storageClassName = "standard" @@ -157,7 +157,7 @@ resource "kubectl_manifest" "runner" { } }) depends_on = [ - module.actions-runner-controller, + module.actions_runner_controller, kubernetes_service_account.runner ] } @@ -178,7 +178,7 @@ resource "kubectl_manifest" "runner" { |------|---------| | [helm](#provider\_helm) | 2.12.1 | | [kubectl](#provider\_kubectl) | 1.14.0 | -| [kubernetes](#provider\_kubernetes) | 2.24.0 | +| [kubernetes](#provider\_kubernetes) | 2.25.1 | ## Resources