Skip to content
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.

Sign up for GitHub

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

Jump to bottom

chore(deps): bump actions/cache from 3 to 4 #3

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore(deps): bump actions/cache from 3 to 4 #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a42abd9
chore(deps): bump actions/cache from 3 to 4
dependabot[bot] Jan 22, 2024
37edf1f
docs(terraform): update README.md
github-actions[bot] Jan 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/test-and-release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ jobs:
git-commit-message: "docs(terraform): update README.md"
- name: Cache Docs
if: ${{ github.event_name == 'push' }}
uses: actions/cache@v3
uses: actions/cache@v4
with:
path: |
README.md
Expand Down Expand Up @@ -152,7 +152,7 @@ jobs:
uses: actions/checkout@v4
- name: Restore Cached Docs
if: ${{ github.event_name == 'push' }}
uses: actions/cache@v3
uses: actions/cache@v4
with:
path: README.md
key: ${{ runner.os }}-docs-${{ github.sha }}
Expand Down
62 changes: 31 additions & 31 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -35,51 +35,51 @@ module "actions-runner-controller" {

## Requirements

| Name | Version |
| ---------------------------------------------------------------------------- | --------- |
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13 |
| <a name="requirement_helm"></a> [helm](#requirement\_helm) | >= 2.11.0 |
| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13 |
| <a name="requirement_helm"></a> [helm](#requirement\_helm) | >= 2.11.0 |
| <a name="requirement_kubernetes"></a> [kubernetes](#requirement\_kubernetes) | >= 2.23.0 |

## Providers

| Name | Version |
| ---------------------------------------------------------------------- | --------- |
| <a name="provider_helm"></a> [helm](#provider\_helm) | >= 2.11.0 |
| Name | Version |
|------|---------|
| <a name="provider_helm"></a> [helm](#provider\_helm) | >= 2.11.0 |
| <a name="provider_kubernetes"></a> [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 |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------ | :------: |
| <a name="input_github_app_id"></a> [github\_app\_id](#input\_github\_app\_id) | GitHub App ID | `string` | n/a | yes |
| <a name="input_github_app_install_id"></a> [github\_app\_install\_id](#input\_github\_app\_install\_id) | GitHub App Install ID | `string` | n/a | yes |
| <a name="input_github_app_private_key"></a> [github\_app\_private\_key](#input\_github\_app\_private\_key) | GitHub App Private Key | `string` | n/a | yes |
| <a name="input_allow_granting_container_mode_permissions"></a> [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 |
| <a name="input_atomic"></a> [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 |
| <a name="input_create_namespace"></a> [create\_namespace](#input\_create\_namespace) | If true, the namespace will be created | `bool` | `true` | no |
| <a name="input_helm_chart_version"></a> [helm\_chart\_version](#input\_helm\_chart\_version) | The version of the helm chart to deploy | `string` | `"0.23.5"` | no |
| <a name="input_helm_deployment_name"></a> [helm\_deployment\_name](#input\_helm\_deployment\_name) | The name of the helm deployment | `string` | `"actions-runner-controller"` | no |
| <a name="input_kubernetes_secret_name"></a> [kubernetes\_secret\_name](#input\_kubernetes\_secret\_name) | The name of the secret to create | `string` | `"github-auth-secret"` | no |
| <a name="input_namespace"></a> [namespace](#input\_namespace) | The namespace to deploy the runner controller into | `string` | `"github-actions-runner-controller"` | no |
| <a name="input_replicas"></a> [replicas](#input\_replicas) | The number of replicas for the runner controller | `number` | `3` | no |
| <a name="input_timeout"></a> [timeout](#input\_timeout) | Time in seconds to wait for helm deployment operation (like Jobs for hooks) | `number` | `600` | no |
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_github_app_id"></a> [github\_app\_id](#input\_github\_app\_id) | GitHub App ID | `string` | n/a | yes |
| <a name="input_github_app_install_id"></a> [github\_app\_install\_id](#input\_github\_app\_install\_id) | GitHub App Install ID | `string` | n/a | yes |
| <a name="input_github_app_private_key"></a> [github\_app\_private\_key](#input\_github\_app\_private\_key) | GitHub App Private Key | `string` | n/a | yes |
| <a name="input_allow_granting_container_mode_permissions"></a> [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 |
| <a name="input_atomic"></a> [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 |
| <a name="input_create_namespace"></a> [create\_namespace](#input\_create\_namespace) | If true, the namespace will be created | `bool` | `true` | no |
| <a name="input_helm_chart_version"></a> [helm\_chart\_version](#input\_helm\_chart\_version) | The version of the helm chart to deploy | `string` | `"0.23.5"` | no |
| <a name="input_helm_deployment_name"></a> [helm\_deployment\_name](#input\_helm\_deployment\_name) | The name of the helm deployment | `string` | `"actions-runner-controller"` | no |
| <a name="input_kubernetes_secret_name"></a> [kubernetes\_secret\_name](#input\_kubernetes\_secret\_name) | The name of the secret to create | `string` | `"github-auth-secret"` | no |
| <a name="input_namespace"></a> [namespace](#input\_namespace) | The namespace to deploy the runner controller into | `string` | `"github-actions-runner-controller"` | no |
| <a name="input_replicas"></a> [replicas](#input\_replicas) | The number of replicas for the runner controller | `number` | `3` | no |
| <a name="input_timeout"></a> [timeout](#input\_timeout) | Time in seconds to wait for helm deployment operation (like Jobs for hooks) | `number` | `600` | no |

## Outputs

| Name | Description |
| ---------------------------------------------------------------------------------------------------- | ------------------------------------------------- |
| <a name="output_helm_deployment_name"></a> [helm\_deployment\_name](#output\_helm\_deployment\_name) | The name of the helm deployment |
| <a name="output_namespace"></a> [namespace](#output\_namespace) | The namespace runner controller was deployed into |
| <a name="output_secret_name"></a> [secret\_name](#output\_secret\_name) | The name of the secret created |
| Name | Description |
|------|-------------|
| <a name="output_helm_deployment_name"></a> [helm\_deployment\_name](#output\_helm\_deployment\_name) | The name of the helm deployment |
| <a name="output_namespace"></a> [namespace](#output\_namespace) | The namespace runner controller was deployed into |
| <a name="output_secret_name"></a> [secret\_name](#output\_secret\_name) | The name of the secret created |


<!-- END_TF_DOCS -->
22 changes: 11 additions & 11 deletions examples/full/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand All @@ -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
Expand All @@ -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 {
Expand Down Expand Up @@ -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"
Expand All @@ -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
}
}

Expand All @@ -131,15 +131,15 @@ 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
template = {
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"
Expand All @@ -157,7 +157,7 @@ resource "kubectl_manifest" "runner" {
}
})
depends_on = [
module.actions-runner-controller,
module.actions_runner_controller,
kubernetes_service_account.runner
]
}
Expand Down