diff --git a/README.md b/README.md index fccefb8..3a52af4 100644 --- a/README.md +++ b/README.md @@ -7,14 +7,68 @@ provider "kubernetes" {} module "terraform-cloud-agent-kubernetes" { source = "redeux/terraform-cloud-agent/kubernetes" - version = "0.0.3" + version = "0.1.0" namespace = "terraform-cloud-agent" create_namespace = true - agent_name = "example-agent" + agent_name = "example-agent" agent_token = "myagent.atlasv1.secrettoken" cluster_access = true } ``` +## Requirements + +| Name | Version | +|------|---------| +| [terraform](#requirement\_terraform) | >= 0.14 | +| [kubernetes](#requirement\_kubernetes) | >= 2.0.0 | + +## Providers + +| Name | Version | +|------|---------| +| [kubernetes](#provider\_kubernetes) | >= 2.0.0 | + +## Modules + +No modules. + +## Resources + +| Name | Type | +|------|------| +| [kubernetes_cluster_role.tfc_agent_role](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/cluster_role) | resource | +| [kubernetes_cluster_role_binding.tfc_agent_cluster_role_binding](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/cluster_role_binding) | resource | +| [kubernetes_config_map.tfc_agent_configuration](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/config_map) | resource | +| [kubernetes_deployment.tfc_agent](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/deployment) | resource | +| [kubernetes_namespace.tfc_agent_namespace](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/namespace) | resource | +| [kubernetes_secret.tfc_agent_token](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/secret) | resource | +| [kubernetes_service_account.tfc_agent_service_account](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/service_account) | resource | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [agent\_disable\_update](#input\_agent\_disable\_update) | Agents will self-update if set to false. | `bool` | `true` | no | +| [agent\_image](#input\_agent\_image) | Name of the Terraform Cloud Agent docker image. | `string` | `"hashicorp/tfc-agent"` | no | +| [agent\_log\_level](#input\_agent\_log\_level) | Available log levels are info, error, warn, debug, and trace. | `string` | `"error"` | no | +| [agent\_name](#input\_agent\_name) | The TFC agent token description defined in TFC at app//settings/agents. | `string` | n/a | yes | +| [agent\_replicas](#input\_agent\_replicas) | Replicacount of the terraform cloud agent deployment. | `number` | `1` | no | +| [agent\_token](#input\_agent\_token) | The TFC agent token generated when the agent was created. | `string` | n/a | yes | +| [agent\_version](#input\_agent\_version) | Version of the Terraform Cloud Agent docker image. | `string` | `"latest"` | no | +| [cluster\_access](#input\_cluster\_access) | When true, provides the agent access to the cluster to manage Kubernetes resources. | `bool` | `false` | no | +| [cluster\_access\_rbac\_api\_groups](#input\_cluster\_access\_rbac\_api\_groups) | Additional rbac api groups for the rbac role | `list(string)` | `[]` | no | +| [cluster\_access\_rbac\_resources](#input\_cluster\_access\_rbac\_resources) | Additional rbac resources for the rbac role | `list(string)` | `[]` | no | +| [create\_namespace](#input\_create\_namespace) | When true, creates the namespace for the Terraform Cloud Agent. | `bool` | `false` | no | +| [limits\_cpu](#input\_limits\_cpu) | CPU hard limits. | `string` | `"2"` | no | +| [limits\_memory](#input\_limits\_memory) | Memory hard limits. | `string` | `"2Gi"` | no | +| [namespace](#input\_namespace) | The namespace to deploy the agent into. Unless create\_namespace is true, the namespace must already exist. | `string` | n/a | yes | +| [requests\_cpu](#input\_requests\_cpu) | CPU requests. | `string` | `"500m"` | no | +| [requests\_memory](#input\_requests\_memory) | Memory requests. | `string` | `"250Mi"` | no | +| [tfc\_url](#input\_tfc\_url) | The Terraform Cloud endpoint. Must be changed if using Terraform Enterprise. | `string` | `"https://app.terraform.io"` | no | + +## Outputs + +No outputs. **Note**: This is a community module and is not supported by HashiCorp. \ No newline at end of file