diff --git a/README.md b/README.md index 2c3290e..2160a59 100644 --- a/README.md +++ b/README.md @@ -23,126 +23,81 @@ The cluster-autoscaler uses the kuberentes scheduling algorithm to appropriate s - updated version.tf to 0.0.1 - included module.images in depends on helm charts - created changelog - - -## Input - -**cluster_name** `string` - -EKS cluster name name component used through out the EKS cluster describing its purpose (ex: dice-dev) - - -**region** `string` - -AWS region - - -**profile** `string` - -AWS config profile - - -**vpc_id** `string` - -Specify the VPC id that is used by this cluster - - -**subnets** `list(string)` - -Specify the subnets used by this cluster - - -**security_group_all_worker_mgmt_id** `string` - -The security group representing all of the worker nodes in the cluster. - -**eks_managed_node_groups_autoscaling_group_names** `list(string)` - -List of the autoscaling group names created by EKS managed node groups - - -**oidc_provider_arn** `string` - -The ARN of the OIDC Provider - - -**tag_costallocation** `string` - -Tag CostAllocation (default) - -Default: `"csvd:infrastructure"` - - -**tags** `map(string)` - -AWS Tags to apply to appropriate resources - -Default: `{}` - - -**kubectl_image_tag** `string` - -The version of bitnami/kubectl image to use. - -Default: `"1.27.1"` - - -**cluster_autoscaler_chart_version** `string` - -The helm chart of the cluster-autoscaler most closely matching the Kuberentes version. Review output of `helm add repo autoscaler 'https://kubernetes.github.io/autoscaler'` (if the repo hasn't been added previously) and `helm search repo -l autoscaler/cluster-autoscaler - -Default: `"9.29.3"` - - -**cluster_autoscaler_tag** `string` - -Image tag of cluster-autoscaler associated with the cluster_autoscaler_chart_version helm chart. `helm show values --version [cluster_autoscaler_chart_version] autoscaler/cluster-autoscaler | grep tag:` - -Default: `"v1.27.2"` - - -## Output - -**module_name** -The name of this module. - value = local._module_name -} - -**module_version** -The version of this module. - value = local._module_version -} - -**rwo_storage_class** - -Kubernetes storage class that supports read/write once. - - -**rwx_storage_class** - -Kubernetes storage class that supports read/write many. - - -**cluster_autoscaler_irsa_role** - -The arn/name/unique_id of the irsa role for the cluster autoscaler addon - - -**kubectl_image_full_path** - -The full URI to access the kubectl image including the registry/repository:tag - - -**kubectl_image_registry** - -The registry portion of the URI to access the kubectl image - - -**kubectl_image_repository** - -The repository portion of the URI to access the kubectl image - - -**kubectl_image_tag** - -The tag portion of the URI to access the kubectl image + +## Requirements + +| Name | Version | +|------|---------| +| [terraform](#requirement\_terraform) | >= 0.13 | +| [aws](#requirement\_aws) | >= 5.14.0 | +| [helm](#requirement\_helm) | >= 2.11.0 | +| [kubectl](#requirement\_kubectl) | >= 1.14.0 | +| [kubernetes](#requirement\_kubernetes) | >= 2.23.0 | + +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | >= 5.14.0 | +| [helm](#provider\_helm) | >= 2.11.0 | +| [http](#provider\_http) | n/a | +| [kubectl](#provider\_kubectl) | >= 1.14.0 | +| [kubernetes](#provider\_kubernetes) | >= 2.23.0 | + +## Modules + +| Name | Source | Version | +|------|--------|---------| +| [efs](#module\_efs) | git@github.e.it.census.gov:terraform-modules/aws-efs.git | n/a | +| [images](#module\_images) | git@github.e.it.census.gov:terraform-modules/aws-ecr-copy-images.git/ | tf-upgrade | + +## Resources + +| Name | Type | +|------|------| +| [aws_autoscaling_group_tag.on-demand](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/autoscaling_group_tag) | resource | +| [helm_release.cluster-autoscaler](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource | +| [kubectl_manifest.deploy_cluster_roles](https://registry.terraform.io/providers/gavinbunney/kubectl/latest/docs/resources/manifest) | resource | +| [kubernetes_namespace.operators](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/namespace) | resource | +| [kubernetes_storage_class.ebs_encrypted](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/storage_class) | resource | +| [kubernetes_storage_class.efs-sc](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/storage_class) | resource | +| [kubernetes_storage_class.gp3_encrypted](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/storage_class) | resource | +| [aws_ebs_default_kms_key.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ebs_default_kms_key) | data source | +| [aws_iam_role.cluster_autoscaler_irsa_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_role) | data source | +| [aws_kms_key.ebs_key](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/kms_key) | data source | +| [http_http.cluster_roles](https://registry.terraform.io/providers/hashicorp/http/latest/docs/data-sources/http) | data source | +| [kubectl_file_documents.access_documents](https://registry.terraform.io/providers/gavinbunney/kubectl/latest/docs/data-sources/file_documents) | data source | +| [kubernetes_namespace.kube-system](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/data-sources/namespace) | data source | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [cluster\_autoscaler\_chart\_version](#input\_cluster\_autoscaler\_chart\_version) | The helm chart of the cluster-autoscaler most closely matching the Kuberentes version. Review output of `helm add repo autoscaler 'https://kubernetes.github.io/autoscaler'` (if the repo hasn't been added previously) and `helm search repo -l autoscaler/cluster-autoscaler` | `string` | `"9.37.0"` | no | +| [cluster\_autoscaler\_tag](#input\_cluster\_autoscaler\_tag) | Image tag of cluster-autoscaler associated with the cluster\_autoscaler\_chart\_version helm chart. `helm show values --version [cluster_autoscaler_chart_version] autoscaler/cluster-autoscaler | grep tag:` | `string` | `"v1.30.0"` | no | +| [cluster\_name](#input\_cluster\_name) | EKS cluster name name component used through out the EKS cluster describing its purpose (ex: dice-dev) | `string` | n/a | yes | +| [eks\_managed\_node\_groups\_autoscaling\_group\_names](#input\_eks\_managed\_node\_groups\_autoscaling\_group\_names) | List of the autoscaling group names created by EKS managed node groups | `list(string)` | n/a | yes | +| [kubectl\_image\_tag](#input\_kubectl\_image\_tag) | The version of bitnami/kubectl image to use. | `string` | `"1.27.14"` | no | +| [oidc\_provider\_arn](#input\_oidc\_provider\_arn) | The ARN of the OIDC Provider if `enable_irsa = true` | `string` | n/a | yes | +| [operators\_ns](#input\_operators\_ns) | Namespace to create where operators will be installed. | `string` | `"operators"` | no | +| [profile](#input\_profile) | AWS config profile | `string` | `""` | no | +| [region](#input\_region) | AWS region | `string` | n/a | yes | +| [security\_group\_all\_worker\_mgmt\_id](#input\_security\_group\_all\_worker\_mgmt\_id) | The security group representing all of the worker nodes in the cluster. | `string` | n/a | yes | +| [subnets](#input\_subnets) | Specify the subnets used by this cluster | `list(string)` | n/a | yes | +| [tag\_costallocation](#input\_tag\_costallocation) | Tag CostAllocation (default) | `string` | `"csvd:infrastructure"` | no | +| [tags](#input\_tags) | AWS Tags to apply to appropriate resources | `map(string)` | `{}` | no | +| [vpc\_id](#input\_vpc\_id) | Specify the VPC id that is used by this cluster | `string` | n/a | yes | + +## Outputs + +| Name | Description | +|------|-------------| +| [kubectl\_image\_full\_path](#output\_kubectl\_image\_full\_path) | The full URI to access the kubectl image including the registry/repository:tag | +| [kubectl\_image\_registry](#output\_kubectl\_image\_registry) | The registry portion of the URI to access the kubectl image | +| [kubectl\_image\_repository](#output\_kubectl\_image\_repository) | The repository portion of the URI to access the kubectl image | +| [kubectl\_image\_tag](#output\_kubectl\_image\_tag) | The tag portion of the URI to access the kubectl image | +| [module\_name](#output\_module\_name) | The name of this module. | +| [module\_version](#output\_module\_version) | The version of this module. | +| [rwo\_storage\_class](#output\_rwo\_storage\_class) | Kubernetes storage class that supports read/write once. | +| [rwx\_storage\_class](#output\_rwx\_storage\_class) | Kubernetes storage class that supports read/write many. | + \ No newline at end of file