diff --git a/.terraform-docs.yaml b/.terraform-docs.yaml new file mode 100644 index 0000000..e0fd844 --- /dev/null +++ b/.terraform-docs.yaml @@ -0,0 +1,8 @@ +formatter: "markdown table" + +output: + file: "README.md" + mode: inject + +settings: + indent: 3 \ No newline at end of file diff --git a/README.md b/README.md index cc6c16e..05e4975 100644 --- a/README.md +++ b/README.md @@ -6,4 +6,44 @@ - `k apply -f examples/pvc.yaml -n kube-system` - - `k apply -f examples/pod.yaml -n kube-system` \ No newline at end of file + - `k apply -f examples/pod.yaml -n kube-system` + +### Requirements + +| Name | Version | +|------|---------| +| [aws](#requirement\_aws) | ~> 4.0.0 | + +### Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | 5.17.0 | + +### Modules + +| Name | Source | Version | +|------|--------|---------| +| [ebs\_csi\_irsa\_role](#module\_ebs\_csi\_irsa\_role) | terraform-aws-modules/iam/aws//modules/iam-role-for-service-accounts-eks | 5.17.0 | + +### Resources + +| Name | Type | +|------|------| +| [aws_eks_addon.ebs_csi](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/eks_addon) | resource | +| [aws_eks_addon_version.ebs_csi](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/eks_addon_version) | data source | +| [aws_eks_cluster.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/eks_cluster) | data source | +| [aws_iam_openid_connect_provider.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_openid_connect_provider) | data source | + +### Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [aws\_profile](#input\_aws\_profile) | n/a | `string` | n/a | yes | +| [aws\_region](#input\_aws\_region) | ## variables | `string` | n/a | yes | +| [eks\_cluster\_name](#input\_eks\_cluster\_name) | n/a | `string` | n/a | yes | + +### Outputs + +No outputs. + \ No newline at end of file diff --git a/examples/default-with-k8s-resources/main.tf b/examples/default-with-k8s-resources/main.tf index 7c1f2bd..bb0a097 100644 --- a/examples/default-with-k8s-resources/main.tf +++ b/examples/default-with-k8s-resources/main.tf @@ -45,14 +45,14 @@ resource "kubernetes_pod" "pod-with-pvc" { image = nginx port { container_port = "80" - name = "http-server" + name = "http-server" } volume_mount { - name = "pv-test-ebs-csi" + name = "pv-test-ebs-csi" mount_path = "/usr/share/nginx/html" } } } - depends_on = [ kubernetes_persistent_volume.pv-test-ebs-csi ] + depends_on = [kubernetes_persistent_volume.pv-test-ebs-csi] } diff --git a/main.tf b/main.tf index 4425736..4ff2237 100644 --- a/main.tf +++ b/main.tf @@ -4,6 +4,17 @@ provider "aws" { profile = var.aws_profile } +## versions + +terraform { + required_providers { + aws = { + source = "hashicorp/aws" + version = "~> 4.0.0" + } + } +} + ### variables variable "aws_region" { type = string