From beac6819cc10c4ded05f899419d328e2c30114e5 Mon Sep 17 00:00:00 2001 From: Jaroslav Vojtek Date: Fri, 29 Apr 2022 15:03:33 +0200 Subject: [PATCH 01/15] providers update, variables update --- README.md | 10 +++++----- argo.tf | 2 +- main.tf => helm.tf | 12 ++++++------ helm_values.tf | 28 ++++++++++++++++++++++++++++ iam.tf | 16 ++++++++++------ variables.tf | 10 +++++----- versions.tf | 10 +++++++--- 7 files changed, 62 insertions(+), 26 deletions(-) rename main.tf => helm.tf (69%) create mode 100644 helm_values.tf diff --git a/README.md b/README.md index f173c5b..01de103 100644 --- a/README.md +++ b/README.md @@ -87,11 +87,11 @@ No modules. | [helm\_create\_namespace](#input\_helm\_create\_namespace) | Create the namespace if it does not yet exist | `bool` | `true` | no | | [helm\_release\_name](#input\_helm\_release\_name) | Helm release name | `string` | `"cluster-autoscaler"` | no | | [helm\_repo\_url](#input\_helm\_repo\_url) | Helm repository | `string` | `"https://kubernetes.github.io/autoscaler"` | no | -| [k8s\_irsa\_role\_create](#input\_k8s\_irsa\_role\_create) | Whether to create IRSA role and annotate service account | `bool` | `true` | no | -| [k8s\_namespace](#input\_k8s\_namespace) | The K8s namespace in which the node-problem-detector service account has been created | `string` | `"cluster-autoscaler"` | no | -| [k8s\_rbac\_create](#input\_k8s\_rbac\_create) | Whether to create and use RBAC resources | `bool` | `true` | no | -| [k8s\_service\_account\_create](#input\_k8s\_service\_account\_create) | Whether to create Service Account | `bool` | `true` | no | -| [k8s\_service\_account\_name](#input\_k8s\_service\_account\_name) | The k8s cluster-autoscaler service account name | `string` | `"cluster-autoscaler"` | no | +| [k8s\_irsa\_role\_create](#input\_k8s\_irsa\_role\_create) | Whether to create IRSA role and annotate service account | `bool` | `true` | no | +| [k8s\_namespace](#input\_k8s\_namespace) | The K8s namespace in which the node-problem-detector service account has been created | `string` | `"cluster-autoscaler"` | no | +| [k8s\_rbac\_create](#input\_k8s\_rbac\_create) | Whether to create and use RBAC resources | `bool` | `true` | no | +| [k8s\_service\_account\_create](#input\_k8s\_service\_account\_create) | Whether to create Service Account | `bool` | `true` | no | +| [k8s\_service\_account\_name](#input\_k8s\_service\_account\_name) | The k8s cluster-autoscaler service account name | `string` | `"cluster-autoscaler"` | no | | [settings](#input\_settings) | Additional settings which will be passed to the Helm chart values, see https://hub.helm.sh/charts/stable/cluster-autoscaler | `map(any)` | `{}` | no | | [values](#input\_values) | Additional yaml encoded values which will be passed to the Helm chart, see https://hub.helm.sh/charts/stable/cluster-autoscaler | `string` | `""` | no | diff --git a/argo.tf b/argo.tf index c20c4f7..0937ac2 100644 --- a/argo.tf +++ b/argo.tf @@ -13,7 +13,7 @@ locals { } "destination" : { "server" : var.argo_destionation_server - "namespace" : var.k8s_namespace + "namespace" : var.namespace } "syncPolicy" : var.argo_sync_policy "info" : var.argo_info diff --git a/main.tf b/helm.tf similarity index 69% rename from main.tf rename to helm.tf index 94418d4..526a7ac 100644 --- a/main.tf +++ b/helm.tf @@ -1,5 +1,5 @@ locals { - k8s_irsa_role_create = var.enabled && var.k8s_rbac_create && var.k8s_service_account_create && var.k8s_irsa_role_create + irsa_role_create = var.enabled && var.rbac_create && var.service_account_create && var.irsa_role_create values = yamlencode({ "awsRegion" : data.aws_region.current.name, @@ -7,12 +7,12 @@ locals { "clusterName" : var.cluster_name }, "rbac" : { - "create" : var.k8s_rbac_create, + "create" : var.rbac_create, "serviceAccount" : { - "create" : var.k8s_service_account_create, - "name" : var.k8s_service_account_name + "create" : var.service_account_create, + "name" : var.service_account_name "annotations" : { - "eks.amazonaws.com/role-arn" : local.k8s_irsa_role_create ? aws_iam_role.cluster_autoscaler[0].arn : "" + "eks.amazonaws.com/role-arn" : local.irsa_role_create ? aws_iam_role.cluster_autoscaler[0].arn : "" } } } @@ -33,7 +33,7 @@ resource "helm_release" "cluster_autoscaler" { count = var.enabled && !var.argo_application_enabled ? 1 : 0 chart = var.helm_chart_name create_namespace = var.helm_create_namespace - namespace = var.k8s_namespace + namespace = var.namespace name = var.helm_release_name version = var.helm_chart_version repository = var.helm_repo_url diff --git a/helm_values.tf b/helm_values.tf new file mode 100644 index 0000000..22a5282 --- /dev/null +++ b/helm_values.tf @@ -0,0 +1,28 @@ +locals { + values = yamlencode({ + "awsRegion" : data.aws_region.current.name, + "autoDiscovery" : { + "clusterName" : var.cluster_name + }, + "rbac" : { + "create" : var.rbac_create, + "serviceAccount" : { + "create" : var.service_account_create, + "name" : var.service_account_name + "annotations" : { + "eks.amazonaws.com/role-arn" : local.irsa_role_create ? aws_iam_role.cluster_autoscaler[0].arn : "" + } + } + } + }) +} + +data "aws_region" "current" {} + +data "utils_deep_merge_yaml" "values" { + count = var.enabled ? 1 : 0 + input = compact([ + local.values, + var.values + ]) +} \ No newline at end of file diff --git a/iam.tf b/iam.tf index 4fa18c8..ad14664 100644 --- a/iam.tf +++ b/iam.tf @@ -1,5 +1,9 @@ +locals { + irsa_role_create = var.enabled && var.rbac_create && var.service_account_create && var.irsa_role_create +} + data "aws_iam_policy_document" "cluster_autoscaler" { - count = local.k8s_irsa_role_create ? 1 : 0 + count = local.irsa_role_create ? 1 : 0 statement { sid = "Autoscaling" @@ -24,7 +28,7 @@ data "aws_iam_policy_document" "cluster_autoscaler" { } resource "aws_iam_policy" "cluster_autoscaler" { - count = local.k8s_irsa_role_create ? 1 : 0 + count = local.irsa_role_create ? 1 : 0 name = "${var.cluster_name}-cluster-autoscaler" path = "/" description = "Policy for cluster-autoscaler service" @@ -33,7 +37,7 @@ resource "aws_iam_policy" "cluster_autoscaler" { } data "aws_iam_policy_document" "cluster_autoscaler_assume" { - count = local.k8s_irsa_role_create ? 1 : 0 + count = local.irsa_role_create ? 1 : 0 statement { actions = ["sts:AssumeRoleWithWebIdentity"] @@ -48,7 +52,7 @@ data "aws_iam_policy_document" "cluster_autoscaler_assume" { variable = "${replace(var.cluster_identity_oidc_issuer, "https://", "")}:sub" values = [ - "system:serviceaccount:${var.k8s_namespace}:${var.k8s_service_account_name}", + "system:serviceaccount:${var.namespace}:${var.service_account_name}", ] } @@ -57,13 +61,13 @@ data "aws_iam_policy_document" "cluster_autoscaler_assume" { } resource "aws_iam_role" "cluster_autoscaler" { - count = local.k8s_irsa_role_create ? 1 : 0 + count = local.irsa_role_create ? 1 : 0 name = "${var.cluster_name}-cluster-autoscaler" assume_role_policy = data.aws_iam_policy_document.cluster_autoscaler_assume[0].json } resource "aws_iam_role_policy_attachment" "cluster_autoscaler" { - count = local.k8s_irsa_role_create ? 1 : 0 + count = local.irsa_role_create ? 1 : 0 role = aws_iam_role.cluster_autoscaler[0].name policy_arn = aws_iam_policy.cluster_autoscaler[0].arn } diff --git a/variables.tf b/variables.tf index c2fc340..ae74de6 100644 --- a/variables.tf +++ b/variables.tf @@ -48,31 +48,31 @@ variable "helm_create_namespace" { description = "Create the namespace if it does not yet exist" } -variable "k8s_namespace" { +variable "namespace" { type = string default = "cluster-autoscaler" description = "The K8s namespace in which the node-problem-detector service account has been created" } -variable "k8s_rbac_create" { +variable "rbac_create" { type = bool default = true description = "Whether to create and use RBAC resources" } -variable "k8s_service_account_create" { +variable "service_account_create" { type = bool default = true description = "Whether to create Service Account" } -variable "k8s_irsa_role_create" { +variable "irsa_role_create" { type = bool default = true description = "Whether to create IRSA role and annotate service account" } -variable "k8s_service_account_name" { +variable "service_account_name" { default = "cluster-autoscaler" description = "The k8s cluster-autoscaler service account name" } diff --git a/versions.tf b/versions.tf index 603dee4..87f20d8 100644 --- a/versions.tf +++ b/versions.tf @@ -1,18 +1,22 @@ terraform { - required_version = ">= 0.13" + required_version = ">= 0.14" required_providers { aws = { source = "hashicorp/aws" version = ">= 2.0" } + kubernetes = { + source = "hashicorp/kubernetes" + version = ">= 2.6" + } helm = { source = "hashicorp/helm" - version = ">= 1.0" + version = ">= 2.4.0" } utils = { source = "cloudposse/utils" - version = ">= 0.12.0" + version = ">= 0.14.0" } } } From aab82f0c64ca797f5769525c443f592da317e24c Mon Sep 17 00:00:00 2001 From: Jaroslav Vojtek Date: Fri, 29 Apr 2022 15:13:32 +0200 Subject: [PATCH 02/15] unifiying terraform resource names for IAM resources --- README.md | 10 +++++----- helm.tf | 2 +- helm_values.tf | 2 +- iam.tf | 18 +++++++++--------- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 01de103..162e91b 100644 --- a/README.md +++ b/README.md @@ -54,14 +54,14 @@ No modules. | Name | Type | |------|------| -| [aws_iam_policy.cluster_autoscaler](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource | -| [aws_iam_role.cluster_autoscaler](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource | -| [aws_iam_role_policy_attachment.cluster_autoscaler](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource | +| [aws_iam_policy.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource | +| [aws_iam_role.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource | +| [aws_iam_role_policy_attachment.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource | | [helm_release.argocd_application](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource | | [helm_release.cluster_autoscaler](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource | | [kubernetes_manifest.self](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/manifest) | resource | -| [aws_iam_policy_document.cluster_autoscaler](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | -| [aws_iam_policy_document.cluster_autoscaler_assume](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | +| [aws_iam_policy_document.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | +| [aws_iam_policy_document.this_assume](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | | [aws_region.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | data source | | [utils_deep_merge_yaml.argo_application_values](https://registry.terraform.io/providers/cloudposse/utils/latest/docs/data-sources/deep_merge_yaml) | data source | | [utils_deep_merge_yaml.values](https://registry.terraform.io/providers/cloudposse/utils/latest/docs/data-sources/deep_merge_yaml) | data source | diff --git a/helm.tf b/helm.tf index 526a7ac..f39a743 100644 --- a/helm.tf +++ b/helm.tf @@ -12,7 +12,7 @@ locals { "create" : var.service_account_create, "name" : var.service_account_name "annotations" : { - "eks.amazonaws.com/role-arn" : local.irsa_role_create ? aws_iam_role.cluster_autoscaler[0].arn : "" + "eks.amazonaws.com/role-arn" : local.irsa_role_create ? aws_iam_role.this[0].arn : "" } } } diff --git a/helm_values.tf b/helm_values.tf index 22a5282..5032600 100644 --- a/helm_values.tf +++ b/helm_values.tf @@ -10,7 +10,7 @@ locals { "create" : var.service_account_create, "name" : var.service_account_name "annotations" : { - "eks.amazonaws.com/role-arn" : local.irsa_role_create ? aws_iam_role.cluster_autoscaler[0].arn : "" + "eks.amazonaws.com/role-arn" : local.irsa_role_create ? aws_iam_role.this[0].arn : "" } } } diff --git a/iam.tf b/iam.tf index ad14664..cd3d243 100644 --- a/iam.tf +++ b/iam.tf @@ -2,7 +2,7 @@ locals { irsa_role_create = var.enabled && var.rbac_create && var.service_account_create && var.irsa_role_create } -data "aws_iam_policy_document" "cluster_autoscaler" { +data "aws_iam_policy_document" "this" { count = local.irsa_role_create ? 1 : 0 statement { @@ -27,16 +27,16 @@ data "aws_iam_policy_document" "cluster_autoscaler" { } -resource "aws_iam_policy" "cluster_autoscaler" { +resource "aws_iam_policy" "this" { count = local.irsa_role_create ? 1 : 0 name = "${var.cluster_name}-cluster-autoscaler" path = "/" description = "Policy for cluster-autoscaler service" - policy = data.aws_iam_policy_document.cluster_autoscaler[0].json + policy = data.aws_iam_policy_document.this[0].json } -data "aws_iam_policy_document" "cluster_autoscaler_assume" { +data "aws_iam_policy_document" "this_assume" { count = local.irsa_role_create ? 1 : 0 statement { @@ -60,14 +60,14 @@ data "aws_iam_policy_document" "cluster_autoscaler_assume" { } } -resource "aws_iam_role" "cluster_autoscaler" { +resource "aws_iam_role" "this" { count = local.irsa_role_create ? 1 : 0 name = "${var.cluster_name}-cluster-autoscaler" - assume_role_policy = data.aws_iam_policy_document.cluster_autoscaler_assume[0].json + assume_role_policy = data.aws_iam_policy_document.this_assume[0].json } -resource "aws_iam_role_policy_attachment" "cluster_autoscaler" { +resource "aws_iam_role_policy_attachment" "this" { count = local.irsa_role_create ? 1 : 0 - role = aws_iam_role.cluster_autoscaler[0].name - policy_arn = aws_iam_policy.cluster_autoscaler[0].arn + role = aws_iam_role.this[0].name + policy_arn = aws_iam_policy.this[0].arn } From e90fc14dee44e0cf37d627100e68a62bccd95078 Mon Sep 17 00:00:00 2001 From: Jaroslav Vojtek Date: Fri, 29 Apr 2022 15:58:04 +0200 Subject: [PATCH 03/15] helm installation method refactor --- README.md | 46 ++++++++++--- argo.tf | 10 +-- helm.tf | 81 +++++++++++++---------- helm_values.tf | 8 +-- variables.tf | 176 +++++++++++++++++++++++++++++++++++++++++++++++-- 5 files changed, 264 insertions(+), 57 deletions(-) diff --git a/README.md b/README.md index 162e91b..258d84b 100644 --- a/README.md +++ b/README.md @@ -58,13 +58,13 @@ No modules. | [aws_iam_role.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource | | [aws_iam_role_policy_attachment.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource | | [helm_release.argocd_application](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource | -| [helm_release.cluster_autoscaler](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource | +| [helm_release.this](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource | | [kubernetes_manifest.self](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/manifest) | resource | | [aws_iam_policy_document.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | | [aws_iam_policy_document.this_assume](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | | [aws_region.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | data source | | [utils_deep_merge_yaml.argo_application_values](https://registry.terraform.io/providers/cloudposse/utils/latest/docs/data-sources/deep_merge_yaml) | data source | -| [utils_deep_merge_yaml.values](https://registry.terraform.io/providers/cloudposse/utils/latest/docs/data-sources/deep_merge_yaml) | data source | +| [utils_deep_merge_yaml.helm_values](https://registry.terraform.io/providers/cloudposse/utils/latest/docs/data-sources/deep_merge_yaml) | data source | ## Inputs @@ -73,7 +73,7 @@ No modules. | [cluster\_identity\_oidc\_issuer](#input\_cluster\_identity\_oidc\_issuer) | The OIDC Identity issuer for the cluster | `string` | n/a | yes | | [cluster\_identity\_oidc\_issuer\_arn](#input\_cluster\_identity\_oidc\_issuer\_arn) | The OIDC Identity issuer ARN for the cluster that can be used to associate IAM roles with a service account | `string` | n/a | yes | | [cluster\_name](#input\_cluster\_name) | The name of the cluster | `string` | n/a | yes | -| [argo\_application\_enabled](#input\_argo\_application\_enabled) | If set to true, the module will be deployed as ArgoCD application, otherwise it will be deployed as a Helm release | `bool` | `false` | no | +| [argo\_enabled](#input\_argo\_enabled) | If set to true, the module will be deployed as ArgoCD application, otherwise it will be deployed as a Helm release | `bool` | `false` | no | | [argo\_application\_use\_helm](#input\_argo\_application\_use\_helm) | If set to true, the ArgoCD Application manifest will be deployed using Kubernetes provider as a Helm release. Otherwise it'll be deployed as a Kubernetes manifest. See Readme for more info | `bool` | `false` | no | | [argo\_application\_values](#input\_argo\_application\_values) | Value overrides to use when deploying argo application object with helm | `string` | `""` | no | | [argo\_destionation\_server](#input\_argo\_destionation\_server) | Destination server for ArgoCD Application | `string` | `"https://kubernetes.default.svc"` | no | @@ -87,13 +87,41 @@ No modules. | [helm\_create\_namespace](#input\_helm\_create\_namespace) | Create the namespace if it does not yet exist | `bool` | `true` | no | | [helm\_release\_name](#input\_helm\_release\_name) | Helm release name | `string` | `"cluster-autoscaler"` | no | | [helm\_repo\_url](#input\_helm\_repo\_url) | Helm repository | `string` | `"https://kubernetes.github.io/autoscaler"` | no | -| [k8s\_irsa\_role\_create](#input\_k8s\_irsa\_role\_create) | Whether to create IRSA role and annotate service account | `bool` | `true` | no | -| [k8s\_namespace](#input\_k8s\_namespace) | The K8s namespace in which the node-problem-detector service account has been created | `string` | `"cluster-autoscaler"` | no | -| [k8s\_rbac\_create](#input\_k8s\_rbac\_create) | Whether to create and use RBAC resources | `bool` | `true` | no | -| [k8s\_service\_account\_create](#input\_k8s\_service\_account\_create) | Whether to create Service Account | `bool` | `true` | no | -| [k8s\_service\_account\_name](#input\_k8s\_service\_account\_name) | The k8s cluster-autoscaler service account name | `string` | `"cluster-autoscaler"` | no | -| [settings](#input\_settings) | Additional settings which will be passed to the Helm chart values, see https://hub.helm.sh/charts/stable/cluster-autoscaler | `map(any)` | `{}` | no | +| [irsa\_role\_create](#input\_irsa\_role\_create) | Whether to create IRSA role and annotate service account | `bool` | `true` | no | +| [namespace](#input\_namespace) | The K8s namespace in which the node-problem-detector service account has been created | `string` | `"cluster-autoscaler"` | no | +| [rbac\_create](#input\_rbac\_create) | Whether to create and use RBAC resources | `bool` | `true` | no | +| [service\_account\_create](#input\_service\_account\_create) | Whether to create Service Account | `bool` | `true` | no | +| [service\_account\_name](#input\_service\_account\_name) | The k8s cluster-autoscaler service account name | `string` | `"cluster-autoscaler"` | no | +| [helm_set](#input\_helm\_set) | Additional helm sets which will be passed to the Helm chart values, see https://hub.helm.sh/charts/stable/cluster-autoscaler | `map(any)` | `{}` | no | +| [helm\_set\_sensitive](#input\_helm\_set\_sensitive) | Value block with custom sensitive values to be merged with the values yaml that won't be exposed in the plan's diff | `map(any)` | `{}` | no | +| [helm\_postrender](#input\_helm\_postrender) | Value block with a path to a binary file to run after helm renders the manifest which can alter the manifest contents | `map(any)` | `{}` | no | | [values](#input\_values) | Additional yaml encoded values which will be passed to the Helm chart, see https://hub.helm.sh/charts/stable/cluster-autoscaler | `string` | `""` | no | +| [helm\_repo\_key\_file](#input\_helm\_repo\_key\_file) | Helm repositories cert key file | `string` | `""` | no | +| [helm\_repo\_cert\_file](#input\_helm\_repo\_cert\_file) | Helm repositories cert file | `string` | `""` | no | +| [helm\_repo\_ca\_file](#input\_helm\_repo\_ca\_file) | Helm repositories cert file | `string` | `""` | no | +| [helm\_repo\_username](#input\_helm\_repo\_username) | Username for HTTP basic authentication against the helm repository | `string` | `""` | no | +| [helm\_repo\_password](#input\_helm\_repo\_password) | Password for HTTP basic authentication against the helm repository | `string` | `""` | no | +| [helm\_devel](#input\_helm\_devel) | Use helm chart development versions, too. Equivalent to version '>0.0.0-0'. If version is set, this is ignored | `bool` | `false` | no | +| [helm\_package\_verify](#input\_helm\_package\_verify) | Verify the package before installing it. Helm uses a provenance file to verify the integrity of the chart; this must be hosted alongside the chart | `bool` | `false` | no | +| [helm\_keyring](#input\_helm\_keyring) | Location of public keys used for verification. Used only if helm\_package\_verify is true | `string` | `"~/.gnupg/pubring.gpg"` | no | +| [helm\_timeout](#input\_helm\_timeout) | Time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) | `number` | `300` | no | +| [helm\_disable\_webhooks](#input\_helm\_disable\_webhooks) | Prevent helm chart hooks from running | `bool` | `false` | no | +| [helm\_reset\_values](#input\_helm\_reset\_values) | When upgrading, reset the values to the ones built into the helm chart | `bool` | `false` | no | +| [helm\_reuse\_values](#input\_helm\_reuse\_values) | When upgrading, reuse the last helm release's values and merge in any overrides. If 'helm\_reset\_values' is specified, this is ignored | `bool` | `false` | no | +| [helm\_force\_update](#input\_helm\_force\_update) | Force helm resource update through delete/recreate if needed | `bool` | `false` | no | +| [helm\_recreate\_pods](#input\_helm\_recreate\_pods) | Perform pods restart during helm upgrade/rollback | `bool` | `false` | no | +| [helm\_cleanup\_on\_fail](#input\_helm\_cleanup\_on\_fail) | Allow deletion of new resources created in this helm upgrade when upgrade fails | `bool` | `false` | no | +| [helm\_release\_max\_history](#input\_helm\_release\_max\_history) | Maximum number of release versions stored per release | `number` | `0` | no | +| [helm\_atomic](#input\_helm\_atomic) | If set, installation process purges chart on fail. The wait flag will be set automatically if atomic is used | `bool` | `false` | no | +| [helm\_wait](#input\_helm\_wait) | Will wait until all helm release resources are in a ready state before marking the release as successful. It will wait for as long as timeout | `bool` | `false` | no | +| [helm\_wait\_for\_jobs](#input\_helm\_wait\_for\_jobs) | If wait is enabled, will wait until all helm Jobs have been completed before marking the release as successful. It will wait for as long as timeout | `bool` | `false` | no | +| [helm\_skip\_crds](#input\_helm\_skip\_crds) | If set, no CRDs will be installed before helm release | `bool` | `false` | no | +| [helm\_render\_subchart\_notes](#input\_helm\_render\_subchart\_notes) | If set, render helm subchart notes along with the parent | `bool` | `true` | no | +| [helm\_disable\_openapi\_validation](#input\_helm\_disable\_openapi\_validation) | If set, the installation process will not validate rendered helm templates against the Kubernetes OpenAPI Schema | `bool` | `false` | no | +| [helm\_dependency\_update](#input\_helm\_dependency\_update) | Runs helm dependency update before installing the chart | `bool` | `false` | no | +| [helm\_replace](#input\_helm\_replace) | Re-use the given name of helm release, only if that name is a deleted release which remains in the history. This is unsafe in production | `bool` | `false` | no | +| [helm\_description](#input\_helm\_description) | Set helm release description attribute (visible in the history) | `string` | `""` | no | +| [helm\_lint](#input\_helm\_lint) | Run the helm chart linter during the plan | `bool` | `false` | no | ## Outputs diff --git a/argo.tf b/argo.tf index 0937ac2..71acaa7 100644 --- a/argo.tf +++ b/argo.tf @@ -7,8 +7,8 @@ locals { "targetRevision" : var.helm_chart_version "helm" : { "releaseName" : var.helm_release_name - "parameters" : [for k, v in var.settings : tomap({ "forceString" : true, "name" : k, "value" : v })] - "values" : data.utils_deep_merge_yaml.values[0].output + "parameters" : [for k, v in var.helm_set : tomap({ "forceString" : true, "name" : k, "value" : v })] + "values" : data.utils_deep_merge_yaml.helm_values[0].output } } "destination" : { @@ -21,7 +21,7 @@ locals { } data "utils_deep_merge_yaml" "argo_application_values" { - count = var.enabled && var.argo_application_enabled && var.argo_application_use_helm ? 1 : 0 + count = var.enabled && var.argo_enabled && var.argo_application_use_helm ? 1 : 0 input = compact([ yamlencode(local.argo_application_values), var.argo_application_values @@ -29,7 +29,7 @@ data "utils_deep_merge_yaml" "argo_application_values" { } resource "helm_release" "argocd_application" { - count = var.enabled && var.argo_application_enabled && var.argo_application_use_helm ? 1 : 0 + count = var.enabled && var.argo_enabled && var.argo_application_use_helm ? 1 : 0 chart = "${path.module}/helm/argocd-application" name = var.helm_release_name @@ -42,7 +42,7 @@ resource "helm_release" "argocd_application" { resource "kubernetes_manifest" "self" { - count = var.enabled && var.argo_application_enabled && !var.argo_application_use_helm ? 1 : 0 + count = var.enabled && var.argo_enabled && !var.argo_application_use_helm ? 1 : 0 manifest = { "apiVersion" = "argoproj.io/v1alpha1" "kind" = "Application" diff --git a/helm.tf b/helm.tf index f39a743..89cf7c7 100644 --- a/helm.tf +++ b/helm.tf @@ -1,36 +1,5 @@ -locals { - irsa_role_create = var.enabled && var.rbac_create && var.service_account_create && var.irsa_role_create - - values = yamlencode({ - "awsRegion" : data.aws_region.current.name, - "autoDiscovery" : { - "clusterName" : var.cluster_name - }, - "rbac" : { - "create" : var.rbac_create, - "serviceAccount" : { - "create" : var.service_account_create, - "name" : var.service_account_name - "annotations" : { - "eks.amazonaws.com/role-arn" : local.irsa_role_create ? aws_iam_role.this[0].arn : "" - } - } - } - }) -} - -data "aws_region" "current" {} - -data "utils_deep_merge_yaml" "values" { - count = var.enabled ? 1 : 0 - input = compact([ - local.values, - var.values - ]) -} - -resource "helm_release" "cluster_autoscaler" { - count = var.enabled && !var.argo_application_enabled ? 1 : 0 +resource "helm_release" "this" { + count = var.enabled && !var.argo_enabled ? 1 : 0 chart = var.helm_chart_name create_namespace = var.helm_create_namespace namespace = var.namespace @@ -38,15 +7,57 @@ resource "helm_release" "cluster_autoscaler" { version = var.helm_chart_version repository = var.helm_repo_url + repository_key_file = var.helm_repo_key_file + repository_cert_file = var.helm_repo_cert_file + repository_ca_file = var.helm_repo_ca_file + repository_username = var.helm_repo_username + repository_password = var.helm_repo_password + devel = var.helm_devel + verify = var.helm_package_verify + keyring = var.helm_keyring + timeout = var.helm_timeout + disable_webhooks = var.helm_disable_webhooks + reset_values = var.helm_reset_values + reuse_values = var.helm_reuse_values + force_update = var.helm_force_update + recreate_pods = var.helm_recreate_pods + cleanup_on_fail = var.helm_cleanup_on_fail + max_history = var.helm_release_max_history + atomic = var.helm_atomic + wait = var.helm_wait + wait_for_jobs = var.helm_wait_for_jobs + skip_crds = var.helm_skip_crds + render_subchart_notes = var.helm_render_subchart_notes + disable_openapi_validation = var.helm_disable_openapi_validation + dependency_update = var.helm_dependency_update + replace = var.helm_replace + description = var.helm_description + lint = var.helm_lint + values = [ - data.utils_deep_merge_yaml.values[0].output + data.utils_deep_merge_yaml.helm_values[0].output ] dynamic "set" { - for_each = var.settings + for_each = var.helm_set content { name = set.key value = set.value } } + + dynamic "set_sensitive" { + for_each = var.helm_set_sensitive + content { + name = set_sensitive.key + value = set_sensitive.value + } + } + + dynamic "postrender" { + for_each = var.helm_postrender + content { + binary_path = postrender.value + } + } } diff --git a/helm_values.tf b/helm_values.tf index 5032600..adfd6b0 100644 --- a/helm_values.tf +++ b/helm_values.tf @@ -1,5 +1,5 @@ locals { - values = yamlencode({ + helm_values = yamlencode({ "awsRegion" : data.aws_region.current.name, "autoDiscovery" : { "clusterName" : var.cluster_name @@ -19,10 +19,10 @@ locals { data "aws_region" "current" {} -data "utils_deep_merge_yaml" "values" { +data "utils_deep_merge_yaml" "helm_values" { count = var.enabled ? 1 : 0 input = compact([ - local.values, - var.values + local.helm_values, + var.helm_values ]) } \ No newline at end of file diff --git a/variables.tf b/variables.tf index ae74de6..ee02bb8 100644 --- a/variables.tf +++ b/variables.tf @@ -77,13 +77,25 @@ variable "service_account_name" { description = "The k8s cluster-autoscaler service account name" } -variable "settings" { +variable "helm_set" { type = map(any) default = {} - description = "Additional settings which will be passed to the Helm chart values, see https://hub.helm.sh/charts/stable/cluster-autoscaler" + description = "Additional helm sets which will be passed to the Helm chart values, see https://hub.helm.sh/charts/stable/cluster-autoscaler" } -variable "values" { +variable "helm_set_sensitive" { + type = map(any) + default = {} + description = "Value block with custom sensitive values to be merged with the values yaml that won't be exposed in the plan's diff" +} + +variable "helm_postrender" { + type = map(any) + default = {} + description = "Value block with a path to a binary file to run after helm renders the manifest which can alter the manifest contents" +} + +variable "helm_values" { type = string default = "" description = "Additional yaml encoded values which will be passed to the Helm chart, see https://hub.helm.sh/charts/stable/cluster-autoscaler" @@ -95,7 +107,7 @@ variable "argo_namespace" { description = "Namespace to deploy ArgoCD application CRD to" } -variable "argo_application_enabled" { +variable "argo_enabled" { type = bool default = false description = "If set to true, the module will be deployed as ArgoCD application, otherwise it will be deployed as a Helm release" @@ -136,3 +148,159 @@ variable "argo_sync_policy" { description = "ArgoCD syncPolicy manifest parameter" default = {} } + +variable "helm_repo_key_file" { + type = string + default = "" + description = "Helm repositories cert key file" +} + +variable "helm_repo_cert_file" { + type = string + default = "" + description = "Helm repositories cert file" +} + +variable "helm_repo_ca_file" { + type = string + default = "" + description = "Helm repositories cert file" +} + +variable "helm_repo_username" { + type = string + default = "" + description = "Username for HTTP basic authentication against the helm repository" +} + +variable "helm_repo_password" { + type = string + default = "" + description = "Password for HTTP basic authentication against the helm repository" +} + +variable "helm_devel" { + type = bool + default = false + description = "Use helm chart development versions, too. Equivalent to version '>0.0.0-0'. If version is set, this is ignored" +} + +variable "helm_package_verify" { + type = bool + default = false + description = "Verify the package before installing it. Helm uses a provenance file to verify the integrity of the chart; this must be hosted alongside the chart" +} + +variable "helm_keyring" { + type = string + default = "~/.gnupg/pubring.gpg" + description = "Location of public keys used for verification. Used only if helm_package_verify is true" +} + +variable "helm_timeout" { + type = number + default = 300 + description = "Time in seconds to wait for any individual kubernetes operation (like Jobs for hooks)" +} + +variable "helm_disable_webhooks" { + type = bool + default = false + description = "Prevent helm chart hooks from running" +} + +variable "helm_reset_values" { + type = bool + default = false + description = "When upgrading, reset the values to the ones built into the helm chart" +} + +variable "helm_reuse_values" { + type = bool + default = false + description = "When upgrading, reuse the last helm release's values and merge in any overrides. If 'helm_reset_values' is specified, this is ignored" +} + +variable "helm_force_update" { + type = bool + default = false + description = "Force helm resource update through delete/recreate if needed" +} + +variable "helm_recreate_pods" { + type = bool + default = false + description = "Perform pods restart during helm upgrade/rollback" +} + +variable "helm_cleanup_on_fail" { + type = bool + default = false + description = "Allow deletion of new resources created in this helm upgrade when upgrade fails" +} + +variable "helm_release_max_history" { + type = number + default = 0 + description = "Maximum number of release versions stored per release" +} + +variable "helm_atomic" { + type = bool + default = false + description = "If set, installation process purges chart on fail. The wait flag will be set automatically if atomic is used" +} + +variable "helm_wait" { + type = bool + default = false + description = "Will wait until all helm release resources are in a ready state before marking the release as successful. It will wait for as long as timeout" +} + +variable "helm_wait_for_jobs" { + type = bool + default = false + description = "If wait is enabled, will wait until all helm Jobs have been completed before marking the release as successful. It will wait for as long as timeout" +} + +variable "helm_skip_crds" { + type = bool + default = false + description = "If set, no CRDs will be installed before helm release" +} + +variable "helm_render_subchart_notes" { + type = bool + default = true + description = "If set, render helm subchart notes along with the parent" +} + +variable "helm_disable_openapi_validation" { + type = bool + default = false + description = "If set, the installation process will not validate rendered helm templates against the Kubernetes OpenAPI Schema" +} + +variable "helm_dependency_update" { + type = bool + default = false + description = "Runs helm dependency update before installing the chart" +} + +variable "helm_replace" { + type = bool + default = false + description = "Re-use the given name of helm release, only if that name is a deleted release which remains in the history. This is unsafe in production" +} + +variable "helm_description" { + type = string + default = "" + description = "Set helm release description attribute (visible in the history)" +} + +variable "helm_lint" { + type = bool + default = false + description = "Run the helm chart linter during the plan" +} \ No newline at end of file From c30c9211d423c3a9465315bc3f6744a113c2403b Mon Sep 17 00:00:00 2001 From: Jaroslav Vojtek Date: Wed, 22 Jun 2022 23:28:51 +0200 Subject: [PATCH 04/15] feat: module refactoring, updating pre-commit-config --- .github/CODE_OF_CONDUCT.md | 133 ++++++++++++++++++ .github/CONTRIBUTING.md | 30 ++++ .github/ISSUE_TEMPLATE/bug_report.yml | 108 ++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature_request.yml | 39 +++++ .github/PULL_REQUEST_TEMPLATE.md | 21 +++ .github/RELEASE_DRAFTER.yml | 19 +++ .github/workflows/main.yml | 112 --------------- .github/workflows/pre-commit.yml | 43 ++++++ .github/workflows/release-drafter.yml | 24 ++++ .github/workflows/validate.yaml | 49 +++++++ .pre-commit-config.yaml | 29 ++-- .tool-versions | 6 + README.md | 97 +++++++------ argo.tf | 63 ++++++--- commitlint.config.js | 23 +++ .../templates/application.yaml | 31 ++-- helm_values.tf | 10 +- iam.tf | 5 +- output.tf | 19 +++ variables.tf | 54 ++++++- versions.tf | 8 +- 22 files changed, 712 insertions(+), 212 deletions(-) create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/RELEASE_DRAFTER.yml delete mode 100644 .github/workflows/main.yml create mode 100644 .github/workflows/pre-commit.yml create mode 100644 .github/workflows/release-drafter.yml create mode 100644 .github/workflows/validate.yaml create mode 100644 .tool-versions create mode 100644 commitlint.config.js create mode 100644 output.tf diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..58d3674 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,133 @@ + +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +info@lablabs.io. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..5249a56 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing + +When contributing to this repository, please first create an issue and link the PR with it. + +Please note we have a code of conduct, please follow it in all your interactions with the project. + +## Pull Request Process + +1. Update the README.md with details of changes including example hcl blocks and [example files](./examples) if appropriate. +2. Run pre-commit hooks `pre-commit run -a`. +3. Once all outstanding comments and checklist items have been addressed, your contribution will be merged! Merged PRs will be included in the next release. The terraform-aws-vpc maintainers take care of updating the CHANGELOG as they merge. + +## Checklists for contributions + +- [ ] Add [semantics prefix](#semantic-pull-requests) to your PR or Commits. +- [ ] CI tests are passing +- [ ] README.md has been updated after any changes. The variables and outputs in the README.md has been generated (using the `terraform_docs` pre-commit hook). +- [ ] Run pre-commit hooks `pre-commit run -a` + +## Semantic Pull Requests + +Pull Requests or Commits must follow conventional specs below: + +- `ci:` Changes to our CI configuration files and scripts (example scopes: GitHub Actions) +- `docs:` Documentation only changes +- `feat:` A new feature +- `fix:` A bug fix +- `refactor:` A code change that neither fixes a bug nor adds a feature +- `style:` Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) +- `test:` Adding missing tests or correcting existing tests diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..ad2fe05 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,108 @@ +--- +name: Bug report +description: File a bug report +title: "bug: " +labels: bug + +body: +- type: markdown + attributes: + value: > + **Thank you for wanting to report a bug!** + + Verify first that your issue is not [already reported on + GitHub][issue search]. + + Also test if the latest release is affected too. + +- type: textarea + attributes: + label: Summary + description: Explain the problem briefly below. + placeholder: >- + When I try to do X with teraform module from the main branch on GitHub, Y + breaks in a way Z under the env E. Here are all the details I know + about this problem... + validations: + required: true + +- type: dropdown + attributes: + label: Issue Type + description: > + Please select the single available option in the drop-down. + +
+ + Why? + + + We would do it by ourselves but unfortunatelly, the curent + edition of GitHub Issue Forms Alpha does not support this yet 🤷 + + + _We will make it easier in the future, once GitHub + supports dropdown defaults. Promise!_ + +
+ options: + - Bug Report + validations: + required: true + +- type: textarea + attributes: + label: Terraform Version + description: >- + Paste verbatim output from `terraform --version` below, under + the prompt line. Please don't wrap it with tripple backticks — your + whole input will be turned into a code snippet automatically. + render: console + placeholder: | + $ terraform --version + Terraform v1.1.4 + on linux_amd64 + + provider registry.terraform.io/cloudposse/utils v0.17.23 + + provider registry.terraform.io/hashicorp/aws v4.13.0 + + provider registry.terraform.io/hashicorp/helm v2.5.1 + + provider registry.terraform.io/hashicorp/kubernetes v2.11.0 + validations: + required: true + +- type: textarea + attributes: + label: Steps to Reproduce + description: | + Describe exactly how to reproduce the problem, using a minimal test-case. + + **HINT:** You can paste https://gist.github.com links for larger files. + value: | + + ```hcl (paste below) + + ``` + validations: + required: true + +- type: textarea + attributes: + label: Expected Results + description: >- + Describe what you expected to happen when running the steps above. + placeholder: >- + I expected X to happen because I assumed Y. + validations: + required: true + +- type: textarea + attributes: + label: Actual Results + description: | + Describe what actually happened. + + Paste verbatim command output and don't wrap it with tripple backticks — your + whole input will be turned into a code snippet automatically. + render: console + placeholder: Terrafom command output... + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..0086358 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..3b99f50 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,39 @@ +--- +name: Feature request +description: Suggest an idea for this project +title: "feature: " +labels: enhancement + +body: +- type: markdown + attributes: + value: > + **Thank you for wanting to suggest a feature!** + + Please verify first that your idea is not [already requested on + GitHub][issue search]. + +- type: textarea + attributes: + label: Summary + description: > + Describe the new feature/improvement you would like briefly below. + + What's the problem this feature will solve? + What are you trying to do, that you are unable to achieve? + + placeholder: >- + The new feature will improve... + validations: + required: true + +- type: dropdown + attributes: + label: Issue Type + description: > + Please select the single available option in the drop-down. + + options: + - Feature Idea + validations: + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..f862b60 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,21 @@ +# Description + + + +## Type of change + +- [ ] A bug fix (PR prefix `fix`) +- [ ] A new feature (PR prefix `feat`) +- [ ] A code change that neither fixes a bug nor adds a feature (PR prefix `refactor`) +- [ ] Adding missing tests or correcting existing tests (PR prefix `test`) +- [ ] Changes that do not affect the meaning of the code like white-spaces, formatting, missing semi-colons, etc. (PR prefix `style`) +- [ ] Changes to our CI configuration files and scripts (PR prefix `ci`) +- [ ] Documentation only changes (PR prefix `docs`) + +## How Has This Been Tested? + + diff --git a/.github/RELEASE_DRAFTER.yml b/.github/RELEASE_DRAFTER.yml new file mode 100644 index 0000000..1ae725f --- /dev/null +++ b/.github/RELEASE_DRAFTER.yml @@ -0,0 +1,19 @@ +name-template: 'v$RESOLVED_VERSION' +tag-template: 'v$RESOLVED_VERSION' +categories: + - title: 'Features' + labels: + - 'feature' + - 'enhancement' + - title: 'Bug Fixes' + labels: + - 'fix' + - 'bugfix' + - 'bug' + - title: 'Documentation' + label: 'documentation' +change-template: '- $TITLE, by @$AUTHOR (#$NUMBER)' +template: | + # What's changed + + $CHANGES diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml deleted file mode 100644 index bc0ee04..0000000 --- a/.github/workflows/main.yml +++ /dev/null @@ -1,112 +0,0 @@ -name: Terraform validation - -on: - push: - branches: [ master ] - pull_request: - branches: [ master ] - -env: - TERRAFORM_DOCS_VERSION: "v0.15.0" - TFLINT_VERSION: "v0.25.0" - TFSEC_VERSION: "v0.39.6" - -jobs: - terraform-validation: - runs-on: ubuntu-20.04 - - steps: - - uses: actions/setup-python@v2 - name: "SETUP: Python" - - - uses: actions/cache@v2.0.0 - id: cache-terraform-docs - name: "CACHE: terraform-docs" - with: - path: | - ~/terraform-docs/bin/ - key: ${{ runner.os }}-terraform_docs-${{ env.TERRAFORM_DOCS_VERSION }} - restore-keys: | - ${{ runner.os}}-terraform_docs- - - - shell: bash - name: "INSTALL: terraform-docs" - if: steps.cache-terraform-docs.output.cache-hit != 'true' - run: | - wget https://github.com/terraform-docs/terraform-docs/releases/download/${{ env.TERRAFORM_DOCS_VERSION }}/terraform-docs-${{ env.TERRAFORM_DOCS_VERSION }}-linux-amd64.tar.gz - tar xvzf terraform-docs-${{ env.TERRAFORM_DOCS_VERSION }}-linux-amd64.tar.gz - mkdir -p ~/terraform-docs/bin/ - install terraform-docs ~/terraform-docs/bin/ - - - shell: bash - name: "SETUP: terraform-docs path" - run: echo '~/terraform-docs/bin/' >> $GITHUB_PATH - - - uses: actions/checkout@v2 - name: Checkout source code - - - uses: actions/cache@v2 - id: cache-pre-commit-dependencies - name: "CACHE: pip and pre-commit dependencies" - with: - path: | - ~/.cache/pre-commit - ~/.cache/pip - key: ${{ runner.os }}-pip-pre-commit-${{ hashFiles('.pre-commit-config.yaml') }} - restore-keys: | - ${{ runner.os }}-pip-pre-commit- - - - uses: actions/cache@v2 - id: cache-tflint - name: "CACHE: tflint" - with: - path: | - ~/tflint/bin/ - key: ${{ runner.os }}-tflint-${{ env.TFLINT_VERSION }} - restore-keys: | - ${{ runner.os }}-tflint- - - - shell: bash - name: "INSTALL: detect-secrets" - run: | - pip install detect-secrets - - - shell: bash - name: "INSTALL: tflint" - if: steps.cache-tflint.outputs.cache-hit != 'true' - run: | - wget https://github.com/terraform-linters/tflint/releases/download/${{ env.TFLINT_VERSION }}/tflint_linux_amd64.zip - unzip tflint_linux_amd64.zip - mkdir -p ~/tflint/bin/ - install tflint ~/tflint/bin/ - - - shell: bash - name: "SETUP: tflint path" - run: echo '~/tflint/bin/' >> $GITHUB_PATH - - - uses: actions/cache@v2 - id: cache-tfsec - name: "CACHE: tfsec" - with: - path: | - ~/tfsec/bin/ - key: ${{ runner.os }}-tfsec-${{ env.TFSEC_VERSION }} - restore-keys: | - ${{ runner.os }}-tfsec- - - - shell: bash - name: "INSTALL: tfsec" - if: steps.cache-tfsec.outputs.cache-hit != 'true' - run: | - wget https://github.com/tfsec/tfsec/releases/download/${{ env.TFSEC_VERSION }}/tfsec-linux-amd64 - mkdir -p ~/tfsec/bin/ - install tfsec-linux-amd64 ~/tfsec/bin/ - - - shell: bash - name: "SETUP: tfsec path" - run: echo '~/tfsec/bin/' >> $GITHUB_PATH - - - uses: pre-commit/action@v2.0.0 - name: "RUN: pre-commit" - env: - AWS_DEFAULT_REGION: "eu-central-1" diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml new file mode 100644 index 0000000..7c0b1ec --- /dev/null +++ b/.github/workflows/pre-commit.yml @@ -0,0 +1,43 @@ +name: pre-commit + +on: + workflow_dispatch: + pull_request: + branches: + - main + - master + +env: + TERRAFORM_DOCS_VERSION: "v0.16.0" + TFLINT_VERSION: "v0.36.2" + +jobs: + pre-commit: + runs-on: ubuntu-20.04 + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-python@v2 + + - name: Install additional pre-commit hooks + shell: bash + run: | + echo "########### Install Checkov ####################" + pip install checkov + + echo "########### Install Terraform-docs #############" + wget https://github.com/terraform-docs/terraform-docs/releases/download/${{ env.TERRAFORM_DOCS_VERSION }}/terraform-docs-${{ env.TERRAFORM_DOCS_VERSION }}-linux-amd64.tar.gz + tar xvzf terraform-docs-${{ env.TERRAFORM_DOCS_VERSION }}-linux-amd64.tar.gz + mkdir -p ~/terraform-docs/bin/ + install terraform-docs ~/terraform-docs/bin/ + echo '~/terraform-docs/bin/' >> $GITHUB_PATH + + echo "########### Install Terraform-linters ##########" + wget https://github.com/terraform-linters/tflint/releases/download/${{ env.TFLINT_VERSION }}/tflint_linux_amd64.zip + unzip tflint_linux_amd64.zip + mkdir -p ~/tflint/bin/ + echo '~/tflint/bin/' >> $GITHUB_PATH + install tflint ~/tflint/bin/ + ~/tflint/bin/tflint --init + + - name: Run pre-commit + uses: pre-commit/action@v2.0.3 diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml new file mode 100644 index 0000000..7cae11f --- /dev/null +++ b/.github/workflows/release-drafter.yml @@ -0,0 +1,24 @@ +name: Release Drafter + +permissions: + contents: write + pull-requests: read + +on: + push: + branches: + - main + - master + + pull_request: + types: [opened, reopened, synchronize, labeled] + +jobs: + update_release_draft: + runs-on: ubuntu-latest + steps: + - uses: release-drafter/release-drafter@v5 + with: + config-name: RELEASE_DRAFTER.yml + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/validate.yaml b/.github/workflows/validate.yaml new file mode 100644 index 0000000..2d3f60e --- /dev/null +++ b/.github/workflows/validate.yaml @@ -0,0 +1,49 @@ +name: Terraform validate + +on: + workflow_dispatch: + pull_request: + branches: + - main + - master + +jobs: + versionExtract: + name: Extract min/max Terraform versions + runs-on: ubuntu-20.04 + + steps: + - name: Checkout + uses: actions/checkout@v2 + + - name: Extract Terraform min/max versions + id: minMax + uses: clowdhaus/terraform-min-max@main + with: + directory: . + outputs: + minVersion: ${{ steps.minMax.outputs.minVersion }} + maxVersion: ${{ steps.minMax.outputs.maxVersion }} + + terraform-validate: + runs-on: ubuntu-20.04 + needs: versionExtract + strategy: + matrix: + tf_ver: + - ${{ needs.versionExtract.outputs.minVersion }} + - ${{ needs.versionExtract.outputs.maxVersion }} + + steps: + - uses: actions/checkout@v2 + - uses: hashicorp/setup-terraform@v2 + with: + terraform_version: ${{ matrix.tf_ver }} + + - name: Terraform Init + id: init + run: terraform init + + - name: Terraform Validate + id: validate + run: terraform validate diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 47fffd8..de564ca 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,6 +1,6 @@ repos: - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v3.4.0 + rev: v4.2.0 hooks: - id: trailing-whitespace - id: check-merge-conflict @@ -9,29 +9,34 @@ repos: - id: detect-private-key - id: end-of-file-fixer - - repo: https://github.com/gruntwork-io/pre-commit - rev: v0.1.12 - hooks: - - id: tflint - - id: terraform-validate - - - repo: git://github.com/antonbabenko/pre-commit-terraform - rev: v1.47.0 + - repo: https://github.com/antonbabenko/pre-commit-terraform + rev: v1.72.1 hooks: - id: terraform_fmt - id: terraform_tflint -# - id: terraform_tfsec + - id: terraform_validate + # - id: terraform_checkov - id: terraform_docs args: - '--args=--hide providers --sort-by required' - - repo: git://github.com/pecigonzalo/pre-commit-terraform-vars + - repo: https://github.com/pecigonzalo/pre-commit-terraform-vars rev: v1.0.0 hooks: - id: terraform-vars - repo: https://github.com/Yelp/detect-secrets - rev: v0.14.3 + rev: v1.2.0 hooks: - id: detect-secrets args: ['--baseline', '.secrets.baseline'] + exclude: terraform.tfstate + + # https://www.conventionalcommits.org/en/v1.0.0/#specification + # https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type + - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook + rev: v8.0.0 + hooks: + - id: commitlint + stages: [commit-msg] + additional_dependencies: ['@commitlint/config-conventional'] diff --git a/.tool-versions b/.tool-versions new file mode 100644 index 0000000..56e4bcf --- /dev/null +++ b/.tool-versions @@ -0,0 +1,6 @@ +terraform 1.1.7 +terraform-docs 0.16.0 +tflint 0.35.0 +tfsec 1.6.2 +helm 3.8.0 +kubectl 1.23.6 diff --git a/README.md b/README.md index 258d84b..d949774 100644 --- a/README.md +++ b/README.md @@ -34,17 +34,18 @@ See [Basic example](examples/basic/README.md) for further information. When deploying with ArgoCD application, Kubernetes terraform provider requires access to Kubernetes cluster API during plan time. This introduces potential issue when you want to deploy the cluster with this addon at the same time, during the same Terraform run. -To overcome this issue, the module deploys the ArgoCD application object using the Helm provider, which does not require API access during plan. If you want to deploy the application using this workaround, you can set the `argo_application_use_helm` variable to `true`. +To overcome this issue, the module deploys the ArgoCD application object using the Helm provider, which does not require API access during plan. If you want to deploy the application using this workaround, you can set the `argo_helm_enabled` variable to `true`. ## Requirements | Name | Version | |------|---------| -| [terraform](#requirement\_terraform) | >= 0.13 | -| [aws](#requirement\_aws) | >= 2.0 | -| [helm](#requirement\_helm) | >= 1.0 | -| [utils](#requirement\_utils) | >= 0.12.0 | +| [terraform](#requirement\_terraform) | >= 0.14 | +| [aws](#requirement\_aws) | >= 4.19.0 | +| [helm](#requirement\_helm) | >= 2.6.0 | +| [kubernetes](#requirement\_kubernetes) | >= 2.11.0 | +| [utils](#requirement\_utils) | >= 0.17.0 | ## Modules @@ -57,13 +58,13 @@ No modules. | [aws_iam_policy.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource | | [aws_iam_role.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource | | [aws_iam_role_policy_attachment.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource | -| [helm_release.argocd_application](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource | +| [helm_release.argo_application](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource | | [helm_release.this](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource | -| [kubernetes_manifest.self](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/manifest) | resource | +| [kubernetes_manifest.this](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/manifest) | resource | | [aws_iam_policy_document.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | | [aws_iam_policy_document.this_assume](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | | [aws_region.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | data source | -| [utils_deep_merge_yaml.argo_application_values](https://registry.terraform.io/providers/cloudposse/utils/latest/docs/data-sources/deep_merge_yaml) | data source | +| [utils_deep_merge_yaml.argo_helm_values](https://registry.terraform.io/providers/cloudposse/utils/latest/docs/data-sources/deep_merge_yaml) | data source | | [utils_deep_merge_yaml.helm_values](https://registry.terraform.io/providers/cloudposse/utils/latest/docs/data-sources/deep_merge_yaml) | data source | ## Inputs @@ -73,59 +74,73 @@ No modules. | [cluster\_identity\_oidc\_issuer](#input\_cluster\_identity\_oidc\_issuer) | The OIDC Identity issuer for the cluster | `string` | n/a | yes | | [cluster\_identity\_oidc\_issuer\_arn](#input\_cluster\_identity\_oidc\_issuer\_arn) | The OIDC Identity issuer ARN for the cluster that can be used to associate IAM roles with a service account | `string` | n/a | yes | | [cluster\_name](#input\_cluster\_name) | The name of the cluster | `string` | n/a | yes | -| [argo\_enabled](#input\_argo\_enabled) | If set to true, the module will be deployed as ArgoCD application, otherwise it will be deployed as a Helm release | `bool` | `false` | no | -| [argo\_application\_use\_helm](#input\_argo\_application\_use\_helm) | If set to true, the ArgoCD Application manifest will be deployed using Kubernetes provider as a Helm release. Otherwise it'll be deployed as a Kubernetes manifest. See Readme for more info | `bool` | `false` | no | +| [argo\_apiversion](#input\_argo\_apiversion) | ArgoCD Appliction apiVersion | `string` | `"argoproj.io/v1alpha1"` | no | | [argo\_application\_values](#input\_argo\_application\_values) | Value overrides to use when deploying argo application object with helm | `string` | `""` | no | | [argo\_destionation\_server](#input\_argo\_destionation\_server) | Destination server for ArgoCD Application | `string` | `"https://kubernetes.default.svc"` | no | +| [argo\_enabled](#input\_argo\_enabled) | If set to true, the module will be deployed as ArgoCD application, otherwise it will be deployed as a Helm release | `bool` | `false` | no | +| [argo\_helm\_enabled](#input\_argo\_helm\_enabled) | If set to true, the ArgoCD Application manifest will be deployed using Kubernetes provider as a Helm release. Otherwise it'll be deployed as a Kubernetes manifest. See Readme for more info | `bool` | `false` | no | +| [argo\_helm\_values](#input\_argo\_helm\_values) | Value overrides to use when deploying argo application object with helm | `string` | `""` | no | | [argo\_info](#input\_argo\_info) | ArgoCD info manifest parameter | `list` | 
[
  {
    "name": "terraform",
    "value": "true"
  }
]
| no | +| [argo\_kubernetes\_manifest\_computed\_fields](#input\_argo\_kubernetes\_manifest\_computed\_fields) | List of paths of fields to be handled as "computed". The user-configured value for the field will be overridden by any different value returned by the API after apply. | `list(string)` | 
[
  "metadata.labels",
  "metadata.annotations"
]
| no | +| [argo\_kubernetes\_manifest\_field\_manager\_force\_conflicts](#input\_argo\_kubernetes\_manifest\_field\_manager\_force\_conflicts) | Forcibly override any field manager conflicts when applying the kubernetes manifest resource | `bool` | `false` | no | +| [argo\_kubernetes\_manifest\_field\_manager\_name](#input\_argo\_kubernetes\_manifest\_field\_manager\_name) | The name of the field manager to use when applying the kubernetes manifest resource. Defaults to Terraform | `string` | `"Terraform"` | no | +| [argo\_kubernetes\_manifest\_wait\_for\_fields](#input\_argo\_kubernetes\_manifest\_wait\_for\_fields) | A map of fields and a corresponding regular expression with a pattern to wait for. The provider will wait until the field matches the regular expression. Use * for any value. | `map(string)` | `{}` | no | +| [argo\_metadata](#input\_argo\_metadata) | ArgoCD Application metadata configuration. Override or create additional metadata parameters | `map` | `{}` | no | | [argo\_namespace](#input\_argo\_namespace) | Namespace to deploy ArgoCD application CRD to | `string` | `"argo"` | no | | [argo\_project](#input\_argo\_project) | ArgoCD Application project | `string` | `"default"` | no | +| [argo\_spec](#input\_argo\_spec) | ArgoCD Application spec configuration. Override or create additional spec parameters | `map` | `{}` | no | | [argo\_sync\_policy](#input\_argo\_sync\_policy) | ArgoCD syncPolicy manifest parameter | `map` | `{}` | no | | [enabled](#input\_enabled) | Variable indicating whether deployment is enabled | `bool` | `true` | no | +| [helm\_atomic](#input\_helm\_atomic) | If set, installation process purges chart on fail. The wait flag will be set automatically if atomic is used | `bool` | `false` | no | | [helm\_chart\_name](#input\_helm\_chart\_name) | Helm chart name to be installed | `string` | `"cluster-autoscaler"` | no | | [helm\_chart\_version](#input\_helm\_chart\_version) | Version of the Helm chart | `string` | `"9.10.3"` | no | +| [helm\_cleanup\_on\_fail](#input\_helm\_cleanup\_on\_fail) | Allow deletion of new resources created in this helm upgrade when upgrade fails | `bool` | `false` | no | | [helm\_create\_namespace](#input\_helm\_create\_namespace) | Create the namespace if it does not yet exist | `bool` | `true` | no | -| [helm\_release\_name](#input\_helm\_release\_name) | Helm release name | `string` | `"cluster-autoscaler"` | no | -| [helm\_repo\_url](#input\_helm\_repo\_url) | Helm repository | `string` | `"https://kubernetes.github.io/autoscaler"` | no | -| [irsa\_role\_create](#input\_irsa\_role\_create) | Whether to create IRSA role and annotate service account | `bool` | `true` | no | -| [namespace](#input\_namespace) | The K8s namespace in which the node-problem-detector service account has been created | `string` | `"cluster-autoscaler"` | no | -| [rbac\_create](#input\_rbac\_create) | Whether to create and use RBAC resources | `bool` | `true` | no | -| [service\_account\_create](#input\_service\_account\_create) | Whether to create Service Account | `bool` | `true` | no | -| [service\_account\_name](#input\_service\_account\_name) | The k8s cluster-autoscaler service account name | `string` | `"cluster-autoscaler"` | no | -| [helm_set](#input\_helm\_set) | Additional helm sets which will be passed to the Helm chart values, see https://hub.helm.sh/charts/stable/cluster-autoscaler | `map(any)` | `{}` | no | -| [helm\_set\_sensitive](#input\_helm\_set\_sensitive) | Value block with custom sensitive values to be merged with the values yaml that won't be exposed in the plan's diff | `map(any)` | `{}` | no | -| [helm\_postrender](#input\_helm\_postrender) | Value block with a path to a binary file to run after helm renders the manifest which can alter the manifest contents | `map(any)` | `{}` | no | -| [values](#input\_values) | Additional yaml encoded values which will be passed to the Helm chart, see https://hub.helm.sh/charts/stable/cluster-autoscaler | `string` | `""` | no | -| [helm\_repo\_key\_file](#input\_helm\_repo\_key\_file) | Helm repositories cert key file | `string` | `""` | no | -| [helm\_repo\_cert\_file](#input\_helm\_repo\_cert\_file) | Helm repositories cert file | `string` | `""` | no | -| [helm\_repo\_ca\_file](#input\_helm\_repo\_ca\_file) | Helm repositories cert file | `string` | `""` | no | -| [helm\_repo\_username](#input\_helm\_repo\_username) | Username for HTTP basic authentication against the helm repository | `string` | `""` | no | -| [helm\_repo\_password](#input\_helm\_repo\_password) | Password for HTTP basic authentication against the helm repository | `string` | `""` | no | +| [helm\_dependency\_update](#input\_helm\_dependency\_update) | Runs helm dependency update before installing the chart | `bool` | `false` | no | +| [helm\_description](#input\_helm\_description) | Set helm release description attribute (visible in the history) | `string` | `""` | no | | [helm\_devel](#input\_helm\_devel) | Use helm chart development versions, too. Equivalent to version '>0.0.0-0'. If version is set, this is ignored | `bool` | `false` | no | -| [helm\_package\_verify](#input\_helm\_package\_verify) | Verify the package before installing it. Helm uses a provenance file to verify the integrity of the chart; this must be hosted alongside the chart | `bool` | `false` | no | -| [helm\_keyring](#input\_helm\_keyring) | Location of public keys used for verification. Used only if helm\_package\_verify is true | `string` | `"~/.gnupg/pubring.gpg"` | no | -| [helm\_timeout](#input\_helm\_timeout) | Time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) | `number` | `300` | no | +| [helm\_disable\_openapi\_validation](#input\_helm\_disable\_openapi\_validation) | If set, the installation process will not validate rendered helm templates against the Kubernetes OpenAPI Schema | `bool` | `false` | no | | [helm\_disable\_webhooks](#input\_helm\_disable\_webhooks) | Prevent helm chart hooks from running | `bool` | `false` | no | -| [helm\_reset\_values](#input\_helm\_reset\_values) | When upgrading, reset the values to the ones built into the helm chart | `bool` | `false` | no | -| [helm\_reuse\_values](#input\_helm\_reuse\_values) | When upgrading, reuse the last helm release's values and merge in any overrides. If 'helm\_reset\_values' is specified, this is ignored | `bool` | `false` | no | | [helm\_force\_update](#input\_helm\_force\_update) | Force helm resource update through delete/recreate if needed | `bool` | `false` | no | +| [helm\_keyring](#input\_helm\_keyring) | Location of public keys used for verification. Used only if helm\_package\_verify is true | `string` | `"~/.gnupg/pubring.gpg"` | no | +| [helm\_lint](#input\_helm\_lint) | Run the helm chart linter during the plan | `bool` | `false` | no | +| [helm\_package\_verify](#input\_helm\_package\_verify) | Verify the package before installing it. Helm uses a provenance file to verify the integrity of the chart; this must be hosted alongside the chart | `bool` | `false` | no | +| [helm\_postrender](#input\_helm\_postrender) | Value block with a path to a binary file to run after helm renders the manifest which can alter the manifest contents | `map(any)` | `{}` | no | | [helm\_recreate\_pods](#input\_helm\_recreate\_pods) | Perform pods restart during helm upgrade/rollback | `bool` | `false` | no | -| [helm\_cleanup\_on\_fail](#input\_helm\_cleanup\_on\_fail) | Allow deletion of new resources created in this helm upgrade when upgrade fails | `bool` | `false` | no | | [helm\_release\_max\_history](#input\_helm\_release\_max\_history) | Maximum number of release versions stored per release | `number` | `0` | no | -| [helm\_atomic](#input\_helm\_atomic) | If set, installation process purges chart on fail. The wait flag will be set automatically if atomic is used | `bool` | `false` | no | -| [helm\_wait](#input\_helm\_wait) | Will wait until all helm release resources are in a ready state before marking the release as successful. It will wait for as long as timeout | `bool` | `false` | no | -| [helm\_wait\_for\_jobs](#input\_helm\_wait\_for\_jobs) | If wait is enabled, will wait until all helm Jobs have been completed before marking the release as successful. It will wait for as long as timeout | `bool` | `false` | no | -| [helm\_skip\_crds](#input\_helm\_skip\_crds) | If set, no CRDs will be installed before helm release | `bool` | `false` | no | +| [helm\_release\_name](#input\_helm\_release\_name) | Helm release name | `string` | `"cluster-autoscaler"` | no | | [helm\_render\_subchart\_notes](#input\_helm\_render\_subchart\_notes) | If set, render helm subchart notes along with the parent | `bool` | `true` | no | -| [helm\_disable\_openapi\_validation](#input\_helm\_disable\_openapi\_validation) | If set, the installation process will not validate rendered helm templates against the Kubernetes OpenAPI Schema | `bool` | `false` | no | -| [helm\_dependency\_update](#input\_helm\_dependency\_update) | Runs helm dependency update before installing the chart | `bool` | `false` | no | | [helm\_replace](#input\_helm\_replace) | Re-use the given name of helm release, only if that name is a deleted release which remains in the history. This is unsafe in production | `bool` | `false` | no | -| [helm\_description](#input\_helm\_description) | Set helm release description attribute (visible in the history) | `string` | `""` | no | -| [helm\_lint](#input\_helm\_lint) | Run the helm chart linter during the plan | `bool` | `false` | no | +| [helm\_repo\_ca\_file](#input\_helm\_repo\_ca\_file) | Helm repositories cert file | `string` | `""` | no | +| [helm\_repo\_cert\_file](#input\_helm\_repo\_cert\_file) | Helm repositories cert file | `string` | `""` | no | +| [helm\_repo\_key\_file](#input\_helm\_repo\_key\_file) | Helm repositories cert key file | `string` | `""` | no | +| [helm\_repo\_password](#input\_helm\_repo\_password) | Password for HTTP basic authentication against the helm repository | `string` | `""` | no | +| [helm\_repo\_url](#input\_helm\_repo\_url) | Helm repository | `string` | `"https://kubernetes.github.io/autoscaler"` | no | +| [helm\_repo\_username](#input\_helm\_repo\_username) | Username for HTTP basic authentication against the helm repository | `string` | `""` | no | +| [helm\_reset\_values](#input\_helm\_reset\_values) | When upgrading, reset the values to the ones built into the helm chart | `bool` | `false` | no | +| [helm\_reuse\_values](#input\_helm\_reuse\_values) | When upgrading, reuse the last helm release's values and merge in any overrides. If 'helm\_reset\_values' is specified, this is ignored | `bool` | `false` | no | +| [helm\_set](#input\_helm\_set) | Additional helm sets which will be passed to the Helm chart values, see https://hub.helm.sh/charts/stable/cluster-autoscaler | `map(any)` | `{}` | no | +| [helm\_set\_sensitive](#input\_helm\_set\_sensitive) | Value block with custom sensitive values to be merged with the values yaml that won't be exposed in the plan's diff | `map(any)` | `{}` | no | +| [helm\_skip\_crds](#input\_helm\_skip\_crds) | If set, no CRDs will be installed before helm release | `bool` | `false` | no | +| [helm\_timeout](#input\_helm\_timeout) | Time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) | `number` | `300` | no | +| [helm\_values](#input\_helm\_values) | Additional yaml encoded values which will be passed to the Helm chart, see https://hub.helm.sh/charts/stable/cluster-autoscaler | `string` | `""` | no | +| [helm\_wait](#input\_helm\_wait) | Will wait until all helm release resources are in a ready state before marking the release as successful. It will wait for as long as timeout | `bool` | `false` | no | +| [helm\_wait\_for\_jobs](#input\_helm\_wait\_for\_jobs) | If wait is enabled, will wait until all helm Jobs have been completed before marking the release as successful. It will wait for as long as timeout | `bool` | `false` | no | +| [irsa\_role\_create](#input\_irsa\_role\_create) | Whether to create IRSA role and annotate service account | `bool` | `true` | no | +| [irsa\_tags](#input\_irsa\_tags) | IRSA resources tags | `map(string)` | `{}` | no | +| [namespace](#input\_namespace) | The K8s namespace in which the node-problem-detector service account has been created | `string` | `"cluster-autoscaler"` | no | +| [rbac\_create](#input\_rbac\_create) | Whether to create and use RBAC resources | `bool` | `true` | no | +| [service\_account\_create](#input\_service\_account\_create) | Whether to create Service Account | `bool` | `true` | no | +| [service\_account\_name](#input\_service\_account\_name) | The k8s cluster-autoscaler service account name | `string` | `"cluster-autoscaler"` | no | ## Outputs -No outputs. +| Name | Description | +|------|-------------| +| [helm\_release\_application\_metadata](#output\_helm\_release\_application\_metadata) | Argo application helm release attributes | +| [helm\_release\_metadata](#output\_helm\_release\_metadata) | Helm release attributes | +| [iam\_role\_attributes](#output\_iam\_role\_attributes) | Vector IAM role atributes | +| [kubernetes\_application\_attributes](#output\_kubernetes\_application\_attributes) | Argo kubernetes manifest attributes | ## Contributing and reporting issues diff --git a/argo.tf b/argo.tf index 71acaa7..15763d3 100644 --- a/argo.tf +++ b/argo.tf @@ -1,4 +1,9 @@ locals { + argo_application_metadata = { + "labels" : try(var.argo_metadata.labels, {}), + "annotations" : try(var.argo_metadata.annotations, {}), + "finalizers" : try(var.argo_metadata.finalizers, []) + } argo_application_values = { "project" : var.argo_project "source" : { @@ -8,7 +13,7 @@ locals { "helm" : { "releaseName" : var.helm_release_name "parameters" : [for k, v in var.helm_set : tomap({ "forceString" : true, "name" : k, "value" : v })] - "values" : data.utils_deep_merge_yaml.helm_values[0].output + "values" : var.enabled ? data.utils_deep_merge_yaml.helm_values[0].output : "" } } "destination" : { @@ -20,36 +25,62 @@ locals { } } -data "utils_deep_merge_yaml" "argo_application_values" { - count = var.enabled && var.argo_enabled && var.argo_application_use_helm ? 1 : 0 +data "utils_deep_merge_yaml" "argo_helm_values" { + count = var.enabled && var.argo_enabled && var.argo_helm_enabled ? 1 : 0 input = compact([ - yamlencode(local.argo_application_values), - var.argo_application_values + yamlencode({ + "apiVersion" : var.argo_apiversion + }), + yamlencode({ + "spec" : local.argo_application_values + }), + yamlencode({ + "spec" : var.argo_spec + }), + yamlencode( + local.argo_application_metadata + ) ]) } -resource "helm_release" "argocd_application" { - count = var.enabled && var.argo_enabled && var.argo_application_use_helm ? 1 : 0 + +resource "helm_release" "argo_application" { + count = var.enabled && var.argo_enabled && var.argo_helm_enabled ? 1 : 0 chart = "${path.module}/helm/argocd-application" name = var.helm_release_name namespace = var.argo_namespace values = [ - data.utils_deep_merge_yaml.argo_application_values[0].output + data.utils_deep_merge_yaml.argo_helm_values[0].output, + var.argo_helm_values ] } -resource "kubernetes_manifest" "self" { - count = var.enabled && var.argo_enabled && !var.argo_application_use_helm ? 1 : 0 +resource "kubernetes_manifest" "this" { + count = var.enabled && var.argo_enabled && !var.argo_helm_enabled ? 1 : 0 manifest = { - "apiVersion" = "argoproj.io/v1alpha1" + "apiVersion" = var.argo_apiversion "kind" = "Application" - "metadata" = { - "name" = var.helm_release_name - "namespace" = var.argo_namespace - } - "spec" = local.argo_application_values + "metadata" = merge( + local.argo_application_metadata, + { "name" = var.helm_release_name }, + { "namespace" = var.argo_namespace }, + ) + "spec" = merge( + local.argo_application_values, + var.argo_spec + ) + } + computed_fields = var.argo_kubernetes_manifest_computed_fields + + field_manager { + name = var.argo_kubernetes_manifest_field_manager_name + force_conflicts = var.argo_kubernetes_manifest_field_manager_force_conflicts + } + + wait_for = { + fields = var.argo_kubernetes_manifest_wait_for_fields } } diff --git a/commitlint.config.js b/commitlint.config.js new file mode 100644 index 0000000..d96c749 --- /dev/null +++ b/commitlint.config.js @@ -0,0 +1,23 @@ +module.exports = { + extends: ['@commitlint/config-conventional'], + rules: { + 'type-enum': [ + 2, + 'always', + [ + 'build', + 'chore', + 'ci', + 'docs', + 'feat', + 'fix', + 'perf', + 'refactor', + 'revert', + 'style', + 'test', + 'conf', + ], + ], + } +} diff --git a/helm/argocd-application/templates/application.yaml b/helm/argocd-application/templates/application.yaml index ec30753..3117c37 100644 --- a/helm/argocd-application/templates/application.yaml +++ b/helm/argocd-application/templates/application.yaml @@ -1,24 +1,19 @@ -apiVersion: argoproj.io/v1alpha1 +apiVersion: {{ .Values.apiVersion }} kind: Application metadata: name: {{ include "argocd_application.fullname" . }} labels: {{- include "argocd_application.labels" . | nindent 4 }} + {{- if .Values.labels }} + {{ toYaml .Values.labels | nindent 4 }} + {{- end }} + annotations: + {{- if .Values.annotations }} + {{ toYaml .Values.annotations | indent 4 }} + {{- end }} + finalizers: + {{- if .Values.finalizers }} + {{ toYaml .Values.finalizers | indent 4 }} + {{- end }} spec: - project: {{ .Values.project }} - {{ with .Values.source }} - source: - {{- toYaml . | nindent 4 }} - {{- end }} - {{ with .Values.destination }} - destination: - {{- toYaml . | nindent 4 }} - {{- end }} - {{ with .Values.syncPolicy }} - syncPolicy: - {{- toYaml . | nindent 4 }} - {{- end }} - {{ with .Values.info }} - info: - {{- toYaml . | nindent 4 }} - {{- end }} + {{ toYaml .Values.spec | nindent 2 }} diff --git a/helm_values.tf b/helm_values.tf index adfd6b0..dde64b7 100644 --- a/helm_values.tf +++ b/helm_values.tf @@ -1,5 +1,7 @@ +data "aws_region" "current" {} + locals { - helm_values = yamlencode({ + helm_values_default = yamlencode({ "awsRegion" : data.aws_region.current.name, "autoDiscovery" : { "clusterName" : var.cluster_name @@ -17,12 +19,10 @@ locals { }) } -data "aws_region" "current" {} - data "utils_deep_merge_yaml" "helm_values" { count = var.enabled ? 1 : 0 input = compact([ - local.helm_values, + local.helm_values_default, var.helm_values ]) -} \ No newline at end of file +} diff --git a/iam.tf b/iam.tf index f8f6ba2..a51af66 100644 --- a/iam.tf +++ b/iam.tf @@ -30,7 +30,7 @@ data "aws_iam_policy_document" "this" { resource "aws_iam_policy" "this" { count = local.irsa_role_create ? 1 : 0 - name = "${var.cluster_name}-cluster-autoscaler" + name = "${var.cluster_name}-${var.helm_chart_name}" path = "/" description = "Policy for cluster-autoscaler service" @@ -63,8 +63,9 @@ data "aws_iam_policy_document" "this_assume" { resource "aws_iam_role" "this" { count = local.irsa_role_create ? 1 : 0 - name = "${var.cluster_name}-cluster-autoscaler" + name = "${var.cluster_name}-${var.helm_chart_name}" assume_role_policy = data.aws_iam_policy_document.this_assume[0].json + tags = var.irsa_tags } resource "aws_iam_role_policy_attachment" "this" { diff --git a/output.tf b/output.tf new file mode 100644 index 0000000..39b56a3 --- /dev/null +++ b/output.tf @@ -0,0 +1,19 @@ +output "helm_release_metadata" { + description = "Helm release attributes" + value = try(helm_release.this[0].metadata, {}) +} + +output "helm_release_application_metadata" { + description = "Argo application helm release attributes" + value = try(helm_release.argo_application[0].metadata, {}) +} + +output "kubernetes_application_attributes" { + description = "Argo kubernetes manifest attributes" + value = try(kubernetes_manifest.this, {}) +} + +output "iam_role_attributes" { + description = "Vector IAM role atributes" + value = try(aws_iam_role.this[0], {}) +} diff --git a/variables.tf b/variables.tf index ee02bb8..e7bac48 100644 --- a/variables.tf +++ b/variables.tf @@ -113,7 +113,7 @@ variable "argo_enabled" { description = "If set to true, the module will be deployed as ArgoCD application, otherwise it will be deployed as a Helm release" } -variable "argo_application_use_helm" { +variable "argo_helm_enabled" { type = bool default = false description = "If set to true, the ArgoCD Application manifest will be deployed using Kubernetes provider as a Helm release. Otherwise it'll be deployed as a Kubernetes manifest. See Readme for more info" @@ -303,4 +303,54 @@ variable "helm_lint" { type = bool default = false description = "Run the helm chart linter during the plan" -} \ No newline at end of file +} + +variable "argo_metadata" { + default = {} + description = "ArgoCD Application metadata configuration. Override or create additional metadata parameters" +} + +variable "argo_apiversion" { + default = "argoproj.io/v1alpha1" + description = "ArgoCD Appliction apiVersion" +} + +variable "argo_spec" { + default = {} + description = "ArgoCD Application spec configuration. Override or create additional spec parameters" +} + +variable "argo_helm_values" { + type = string + default = "" + description = "Value overrides to use when deploying argo application object with helm" +} + +variable "argo_kubernetes_manifest_computed_fields" { + type = list(string) + default = ["metadata.labels", "metadata.annotations"] + description = "List of paths of fields to be handled as \"computed\". The user-configured value for the field will be overridden by any different value returned by the API after apply." +} + +variable "argo_kubernetes_manifest_field_manager_name" { + default = "Terraform" + description = "The name of the field manager to use when applying the kubernetes manifest resource. Defaults to Terraform" +} + +variable "argo_kubernetes_manifest_field_manager_force_conflicts" { + type = bool + default = false + description = "Forcibly override any field manager conflicts when applying the kubernetes manifest resource" +} + +variable "argo_kubernetes_manifest_wait_for_fields" { + type = map(string) + default = {} + description = "A map of fields and a corresponding regular expression with a pattern to wait for. The provider will wait until the field matches the regular expression. Use * for any value." +} + +variable "irsa_tags" { + type = map(string) + default = {} + description = "IRSA resources tags" +} diff --git a/versions.tf b/versions.tf index 87f20d8..30934e5 100644 --- a/versions.tf +++ b/versions.tf @@ -4,19 +4,19 @@ terraform { required_providers { aws = { source = "hashicorp/aws" - version = ">= 2.0" + version = ">= 4.19.0" } kubernetes = { source = "hashicorp/kubernetes" - version = ">= 2.6" + version = ">= 2.11.0" } helm = { source = "hashicorp/helm" - version = ">= 2.4.0" + version = ">= 2.6.0" } utils = { source = "cloudposse/utils" - version = ">= 0.14.0" + version = ">= 0.17.0" } } } From fc0d4f27347983dec80bd1cea5c078c0c391e858 Mon Sep 17 00:00:00 2001 From: Jaroslav Vojtek Date: Wed, 22 Jun 2022 23:52:30 +0200 Subject: [PATCH 05/15] fix(iam): adding missing irsa_role_name_prefix variable --- README.md | 1 + iam.tf | 4 ++-- variables.tf | 6 ++++++ 3 files changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d949774..9047ad8 100644 --- a/README.md +++ b/README.md @@ -127,6 +127,7 @@ No modules. | [helm\_wait](#input\_helm\_wait) | Will wait until all helm release resources are in a ready state before marking the release as successful. It will wait for as long as timeout | `bool` | `false` | no | | [helm\_wait\_for\_jobs](#input\_helm\_wait\_for\_jobs) | If wait is enabled, will wait until all helm Jobs have been completed before marking the release as successful. It will wait for as long as timeout | `bool` | `false` | no | | [irsa\_role\_create](#input\_irsa\_role\_create) | Whether to create IRSA role and annotate service account | `bool` | `true` | no | +| [irsa\_role\_name\_prefix](#input\_irsa\_role\_name\_prefix) | The IRSA role name prefix for vector | `string` | `"eks-irsa"` | no | | [irsa\_tags](#input\_irsa\_tags) | IRSA resources tags | `map(string)` | `{}` | no | | [namespace](#input\_namespace) | The K8s namespace in which the node-problem-detector service account has been created | `string` | `"cluster-autoscaler"` | no | | [rbac\_create](#input\_rbac\_create) | Whether to create and use RBAC resources | `bool` | `true` | no | diff --git a/iam.tf b/iam.tf index a51af66..112f01a 100644 --- a/iam.tf +++ b/iam.tf @@ -30,7 +30,7 @@ data "aws_iam_policy_document" "this" { resource "aws_iam_policy" "this" { count = local.irsa_role_create ? 1 : 0 - name = "${var.cluster_name}-${var.helm_chart_name}" + name = "${var.irsa_role_name_prefix}-${var.helm_chart_name}" path = "/" description = "Policy for cluster-autoscaler service" @@ -63,7 +63,7 @@ data "aws_iam_policy_document" "this_assume" { resource "aws_iam_role" "this" { count = local.irsa_role_create ? 1 : 0 - name = "${var.cluster_name}-${var.helm_chart_name}" + name = "${var.irsa_role_name_prefix}-${var.helm_chart_name}" assume_role_policy = data.aws_iam_policy_document.this_assume[0].json tags = var.irsa_tags } diff --git a/variables.tf b/variables.tf index e7bac48..8996a21 100644 --- a/variables.tf +++ b/variables.tf @@ -72,6 +72,12 @@ variable "irsa_role_create" { description = "Whether to create IRSA role and annotate service account" } +variable "irsa_role_name_prefix" { + type = string + default = "eks-irsa" + description = "The IRSA role name prefix for vector" +} + variable "service_account_name" { default = "cluster-autoscaler" description = "The k8s cluster-autoscaler service account name" From a2ae979029724d2116e9754af5bee59e402a81bc Mon Sep 17 00:00:00 2001 From: Jaroslav Vojtek Date: Thu, 23 Jun 2022 17:52:45 +0200 Subject: [PATCH 06/15] fix: setting defaults for argo_metadata, typo, wait block fix --- README.md | 7 +++---- argo.tf | 4 ++-- variables.tf | 15 +++++++-------- 3 files changed, 12 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 9047ad8..60f0c83 100644 --- a/README.md +++ b/README.md @@ -75,8 +75,7 @@ No modules. | [cluster\_identity\_oidc\_issuer\_arn](#input\_cluster\_identity\_oidc\_issuer\_arn) | The OIDC Identity issuer ARN for the cluster that can be used to associate IAM roles with a service account | `string` | n/a | yes | | [cluster\_name](#input\_cluster\_name) | The name of the cluster | `string` | n/a | yes | | [argo\_apiversion](#input\_argo\_apiversion) | ArgoCD Appliction apiVersion | `string` | `"argoproj.io/v1alpha1"` | no | -| [argo\_application\_values](#input\_argo\_application\_values) | Value overrides to use when deploying argo application object with helm | `string` | `""` | no | -| [argo\_destionation\_server](#input\_argo\_destionation\_server) | Destination server for ArgoCD Application | `string` | `"https://kubernetes.default.svc"` | no | +| [argo\_destination\_server](#input\_argo\_destination\_server) | Destination server for ArgoCD Application | `string` | `"https://kubernetes.default.svc"` | no | | [argo\_enabled](#input\_argo\_enabled) | If set to true, the module will be deployed as ArgoCD application, otherwise it will be deployed as a Helm release | `bool` | `false` | no | | [argo\_helm\_enabled](#input\_argo\_helm\_enabled) | If set to true, the ArgoCD Application manifest will be deployed using Kubernetes provider as a Helm release. Otherwise it'll be deployed as a Kubernetes manifest. See Readme for more info | `bool` | `false` | no | | [argo\_helm\_values](#input\_argo\_helm\_values) | Value overrides to use when deploying argo application object with helm | `string` | `""` | no | @@ -85,7 +84,7 @@ No modules. | [argo\_kubernetes\_manifest\_field\_manager\_force\_conflicts](#input\_argo\_kubernetes\_manifest\_field\_manager\_force\_conflicts) | Forcibly override any field manager conflicts when applying the kubernetes manifest resource | `bool` | `false` | no | | [argo\_kubernetes\_manifest\_field\_manager\_name](#input\_argo\_kubernetes\_manifest\_field\_manager\_name) | The name of the field manager to use when applying the kubernetes manifest resource. Defaults to Terraform | `string` | `"Terraform"` | no | | [argo\_kubernetes\_manifest\_wait\_for\_fields](#input\_argo\_kubernetes\_manifest\_wait\_for\_fields) | A map of fields and a corresponding regular expression with a pattern to wait for. The provider will wait until the field matches the regular expression. Use * for any value. | `map(string)` | `{}` | no | -| [argo\_metadata](#input\_argo\_metadata) | ArgoCD Application metadata configuration. Override or create additional metadata parameters | `map` | `{}` | no | +| [argo\_metadata](#input\_argo\_metadata) | ArgoCD Application metadata configuration. Override or create additional metadata parameters | `map` | 
{
  "finalizers": [
    "resources-finalizer.argocd.argoproj.io"
  ]
}
| no | | [argo\_namespace](#input\_argo\_namespace) | Namespace to deploy ArgoCD application CRD to | `string` | `"argo"` | no | | [argo\_project](#input\_argo\_project) | ArgoCD Application project | `string` | `"default"` | no | | [argo\_spec](#input\_argo\_spec) | ArgoCD Application spec configuration. Override or create additional spec parameters | `map` | `{}` | no | @@ -93,7 +92,7 @@ No modules. | [enabled](#input\_enabled) | Variable indicating whether deployment is enabled | `bool` | `true` | no | | [helm\_atomic](#input\_helm\_atomic) | If set, installation process purges chart on fail. The wait flag will be set automatically if atomic is used | `bool` | `false` | no | | [helm\_chart\_name](#input\_helm\_chart\_name) | Helm chart name to be installed | `string` | `"cluster-autoscaler"` | no | -| [helm\_chart\_version](#input\_helm\_chart\_version) | Version of the Helm chart | `string` | `"9.10.3"` | no | +| [helm\_chart\_version](#input\_helm\_chart\_version) | Version of the Helm chart | `string` | `"9.19.1"` | no | | [helm\_cleanup\_on\_fail](#input\_helm\_cleanup\_on\_fail) | Allow deletion of new resources created in this helm upgrade when upgrade fails | `bool` | `false` | no | | [helm\_create\_namespace](#input\_helm\_create\_namespace) | Create the namespace if it does not yet exist | `bool` | `true` | no | | [helm\_dependency\_update](#input\_helm\_dependency\_update) | Runs helm dependency update before installing the chart | `bool` | `false` | no | diff --git a/argo.tf b/argo.tf index 15763d3..d1c9644 100644 --- a/argo.tf +++ b/argo.tf @@ -17,7 +17,7 @@ locals { } } "destination" : { - "server" : var.argo_destionation_server + "server" : var.argo_destination_server "namespace" : var.namespace } "syncPolicy" : var.argo_sync_policy @@ -80,7 +80,7 @@ resource "kubernetes_manifest" "this" { force_conflicts = var.argo_kubernetes_manifest_field_manager_force_conflicts } - wait_for = { + wait { fields = var.argo_kubernetes_manifest_wait_for_fields } } diff --git a/variables.tf b/variables.tf index 8996a21..b8fc2c3 100644 --- a/variables.tf +++ b/variables.tf @@ -27,7 +27,7 @@ variable "helm_chart_name" { variable "helm_chart_version" { type = string - default = "9.10.3" + default = "9.19.1" description = "Version of the Helm chart" } @@ -125,12 +125,7 @@ variable "argo_helm_enabled" { description = "If set to true, the ArgoCD Application manifest will be deployed using Kubernetes provider as a Helm release. Otherwise it'll be deployed as a Kubernetes manifest. See Readme for more info" } -variable "argo_application_values" { - default = "" - description = "Value overrides to use when deploying argo application object with helm" -} - -variable "argo_destionation_server" { +variable "argo_destination_server" { type = string default = "https://kubernetes.default.svc" description = "Destination server for ArgoCD Application" @@ -312,7 +307,11 @@ variable "helm_lint" { } variable "argo_metadata" { - default = {} + default = { + "finalizers" : [ + "resources-finalizer.argocd.argoproj.io" + ] + } description = "ArgoCD Application metadata configuration. Override or create additional metadata parameters" } From 5c5d4515bf6894d12f1d149eb0a001b19908e1bb Mon Sep 17 00:00:00 2001 From: Jaroslav Vojtek Date: Tue, 28 Jun 2022 10:54:40 +0200 Subject: [PATCH 07/15] fix: renaming variables to agreed naming convention --- .pre-commit-config.yaml | 4 +--- .tool-versions | 6 ------ README.md | 8 ++++---- argo.tf | 6 +++--- helm.tf | 4 ++-- output.tf => outputs.tf | 0 helm_values.tf => values.tf | 8 ++++---- variables.tf | 6 +++--- 8 files changed, 17 insertions(+), 25 deletions(-) delete mode 100644 .tool-versions rename output.tf => outputs.tf (100%) rename helm_values.tf => values.tf (80%) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index de564ca..89027ad 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -10,7 +10,7 @@ repos: - id: end-of-file-fixer - repo: https://github.com/antonbabenko/pre-commit-terraform - rev: v1.72.1 + rev: v1.71.0 hooks: - id: terraform_fmt - id: terraform_tflint @@ -32,8 +32,6 @@ repos: args: ['--baseline', '.secrets.baseline'] exclude: terraform.tfstate - # https://www.conventionalcommits.org/en/v1.0.0/#specification - # https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook rev: v8.0.0 hooks: diff --git a/.tool-versions b/.tool-versions deleted file mode 100644 index 56e4bcf..0000000 --- a/.tool-versions +++ /dev/null @@ -1,6 +0,0 @@ -terraform 1.1.7 -terraform-docs 0.16.0 -tflint 0.35.0 -tfsec 1.6.2 -helm 3.8.0 -kubectl 1.23.6 diff --git a/README.md b/README.md index 60f0c83..bd04a08 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ No modules. | [aws_iam_policy_document.this_assume](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | | [aws_region.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | data source | | [utils_deep_merge_yaml.argo_helm_values](https://registry.terraform.io/providers/cloudposse/utils/latest/docs/data-sources/deep_merge_yaml) | data source | -| [utils_deep_merge_yaml.helm_values](https://registry.terraform.io/providers/cloudposse/utils/latest/docs/data-sources/deep_merge_yaml) | data source | +| [utils_deep_merge_yaml.values](https://registry.terraform.io/providers/cloudposse/utils/latest/docs/data-sources/deep_merge_yaml) | data source | ## Inputs @@ -83,7 +83,7 @@ No modules. | [argo\_kubernetes\_manifest\_computed\_fields](#input\_argo\_kubernetes\_manifest\_computed\_fields) | List of paths of fields to be handled as "computed". The user-configured value for the field will be overridden by any different value returned by the API after apply. | `list(string)` | 
[
  "metadata.labels",
  "metadata.annotations"
]
| no | | [argo\_kubernetes\_manifest\_field\_manager\_force\_conflicts](#input\_argo\_kubernetes\_manifest\_field\_manager\_force\_conflicts) | Forcibly override any field manager conflicts when applying the kubernetes manifest resource | `bool` | `false` | no | | [argo\_kubernetes\_manifest\_field\_manager\_name](#input\_argo\_kubernetes\_manifest\_field\_manager\_name) | The name of the field manager to use when applying the kubernetes manifest resource. Defaults to Terraform | `string` | `"Terraform"` | no | -| [argo\_kubernetes\_manifest\_wait\_for\_fields](#input\_argo\_kubernetes\_manifest\_wait\_for\_fields) | A map of fields and a corresponding regular expression with a pattern to wait for. The provider will wait until the field matches the regular expression. Use * for any value. | `map(string)` | `{}` | no | +| [argo\_kubernetes\_manifest\_wait\_fields](#input\_argo\_kubernetes\_manifest\_wait\_fields) | A map of fields and a corresponding regular expression with a pattern to wait for. The provider will wait until the field matches the regular expression. Use * for any value. | `map(string)` | `{}` | no | | [argo\_metadata](#input\_argo\_metadata) | ArgoCD Application metadata configuration. Override or create additional metadata parameters | `map` | 
{
  "finalizers": [
    "resources-finalizer.argocd.argoproj.io"
  ]
}
| no | | [argo\_namespace](#input\_argo\_namespace) | Namespace to deploy ArgoCD application CRD to | `string` | `"argo"` | no | | [argo\_project](#input\_argo\_project) | ArgoCD Application project | `string` | `"default"` | no | @@ -118,11 +118,9 @@ No modules. | [helm\_repo\_username](#input\_helm\_repo\_username) | Username for HTTP basic authentication against the helm repository | `string` | `""` | no | | [helm\_reset\_values](#input\_helm\_reset\_values) | When upgrading, reset the values to the ones built into the helm chart | `bool` | `false` | no | | [helm\_reuse\_values](#input\_helm\_reuse\_values) | When upgrading, reuse the last helm release's values and merge in any overrides. If 'helm\_reset\_values' is specified, this is ignored | `bool` | `false` | no | -| [helm\_set](#input\_helm\_set) | Additional helm sets which will be passed to the Helm chart values, see https://hub.helm.sh/charts/stable/cluster-autoscaler | `map(any)` | `{}` | no | | [helm\_set\_sensitive](#input\_helm\_set\_sensitive) | Value block with custom sensitive values to be merged with the values yaml that won't be exposed in the plan's diff | `map(any)` | `{}` | no | | [helm\_skip\_crds](#input\_helm\_skip\_crds) | If set, no CRDs will be installed before helm release | `bool` | `false` | no | | [helm\_timeout](#input\_helm\_timeout) | Time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) | `number` | `300` | no | -| [helm\_values](#input\_helm\_values) | Additional yaml encoded values which will be passed to the Helm chart, see https://hub.helm.sh/charts/stable/cluster-autoscaler | `string` | `""` | no | | [helm\_wait](#input\_helm\_wait) | Will wait until all helm release resources are in a ready state before marking the release as successful. It will wait for as long as timeout | `bool` | `false` | no | | [helm\_wait\_for\_jobs](#input\_helm\_wait\_for\_jobs) | If wait is enabled, will wait until all helm Jobs have been completed before marking the release as successful. It will wait for as long as timeout | `bool` | `false` | no | | [irsa\_role\_create](#input\_irsa\_role\_create) | Whether to create IRSA role and annotate service account | `bool` | `true` | no | @@ -132,6 +130,8 @@ No modules. | [rbac\_create](#input\_rbac\_create) | Whether to create and use RBAC resources | `bool` | `true` | no | | [service\_account\_create](#input\_service\_account\_create) | Whether to create Service Account | `bool` | `true` | no | | [service\_account\_name](#input\_service\_account\_name) | The k8s cluster-autoscaler service account name | `string` | `"cluster-autoscaler"` | no | +| [settings](#input\_settings) | Additional helm sets which will be passed to the Helm chart values, see https://hub.helm.sh/charts/stable/cluster-autoscaler | `map(any)` | `{}` | no | +| [values](#input\_values) | Additional yaml encoded values which will be passed to the Helm chart, see https://hub.helm.sh/charts/stable/cluster-autoscaler | `string` | `""` | no | ## Outputs diff --git a/argo.tf b/argo.tf index d1c9644..a952837 100644 --- a/argo.tf +++ b/argo.tf @@ -12,8 +12,8 @@ locals { "targetRevision" : var.helm_chart_version "helm" : { "releaseName" : var.helm_release_name - "parameters" : [for k, v in var.helm_set : tomap({ "forceString" : true, "name" : k, "value" : v })] - "values" : var.enabled ? data.utils_deep_merge_yaml.helm_values[0].output : "" + "parameters" : [for k, v in var.settings : tomap({ "forceString" : true, "name" : k, "value" : v })] + "values" : var.enabled ? data.utils_deep_merge_yaml.values[0].output : "" } } "destination" : { @@ -81,6 +81,6 @@ resource "kubernetes_manifest" "this" { } wait { - fields = var.argo_kubernetes_manifest_wait_for_fields + fields = var.argo_kubernetes_manifest_wait_fields } } diff --git a/helm.tf b/helm.tf index 89cf7c7..2592884 100644 --- a/helm.tf +++ b/helm.tf @@ -35,11 +35,11 @@ resource "helm_release" "this" { lint = var.helm_lint values = [ - data.utils_deep_merge_yaml.helm_values[0].output + data.utils_deep_merge_yaml.values[0].output ] dynamic "set" { - for_each = var.helm_set + for_each = var.settings content { name = set.key value = set.value diff --git a/output.tf b/outputs.tf similarity index 100% rename from output.tf rename to outputs.tf diff --git a/helm_values.tf b/values.tf similarity index 80% rename from helm_values.tf rename to values.tf index dde64b7..0b5f4e5 100644 --- a/helm_values.tf +++ b/values.tf @@ -1,7 +1,7 @@ data "aws_region" "current" {} locals { - helm_values_default = yamlencode({ + values_default = yamlencode({ "awsRegion" : data.aws_region.current.name, "autoDiscovery" : { "clusterName" : var.cluster_name @@ -19,10 +19,10 @@ locals { }) } -data "utils_deep_merge_yaml" "helm_values" { +data "utils_deep_merge_yaml" "values" { count = var.enabled ? 1 : 0 input = compact([ - local.helm_values_default, - var.helm_values + local.values_default, + var.values ]) } diff --git a/variables.tf b/variables.tf index b8fc2c3..57d1a82 100644 --- a/variables.tf +++ b/variables.tf @@ -83,7 +83,7 @@ variable "service_account_name" { description = "The k8s cluster-autoscaler service account name" } -variable "helm_set" { +variable "settings" { type = map(any) default = {} description = "Additional helm sets which will be passed to the Helm chart values, see https://hub.helm.sh/charts/stable/cluster-autoscaler" @@ -101,7 +101,7 @@ variable "helm_postrender" { description = "Value block with a path to a binary file to run after helm renders the manifest which can alter the manifest contents" } -variable "helm_values" { +variable "values" { type = string default = "" description = "Additional yaml encoded values which will be passed to the Helm chart, see https://hub.helm.sh/charts/stable/cluster-autoscaler" @@ -348,7 +348,7 @@ variable "argo_kubernetes_manifest_field_manager_force_conflicts" { description = "Forcibly override any field manager conflicts when applying the kubernetes manifest resource" } -variable "argo_kubernetes_manifest_wait_for_fields" { +variable "argo_kubernetes_manifest_wait_fields" { type = map(string) default = {} description = "A map of fields and a corresponding regular expression with a pattern to wait for. The provider will wait until the field matches the regular expression. Use * for any value." From 5d555086859b28e7273360bec3334fbd917829e0 Mon Sep 17 00:00:00 2001 From: Jaroslav Vojtek Date: Tue, 28 Jun 2022 10:55:08 +0200 Subject: [PATCH 08/15] fix: enabling terraform_checkov --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 89027ad..6b572bb 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -15,7 +15,7 @@ repos: - id: terraform_fmt - id: terraform_tflint - id: terraform_validate - # - id: terraform_checkov + - id: terraform_checkov - id: terraform_docs args: - '--args=--hide providers --sort-by required' From 6f57955ff866cf518c8de1398563e53ee91b101c Mon Sep 17 00:00:00 2001 From: Jaroslav Vojtek Date: Tue, 28 Jun 2022 22:57:53 +0200 Subject: [PATCH 09/15] fix(iam.tf): adding missing vars, checks and resources --- .pre-commit-config.yaml | 2 +- README.md | 35 +++++++++++++++++++++++++++-------- iam.tf | 34 +++++++++++++++++++++++++++++----- variables.tf | 23 +++++++++++++++++++++++ 4 files changed, 80 insertions(+), 14 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 6b572bb..89027ad 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -15,7 +15,7 @@ repos: - id: terraform_fmt - id: terraform_tflint - id: terraform_validate - - id: terraform_checkov + # - id: terraform_checkov - id: terraform_docs args: - '--args=--hide providers --sort-by required' diff --git a/README.md b/README.md index bd04a08..16904aa 100644 --- a/README.md +++ b/README.md @@ -15,16 +15,29 @@ A terraform module to deploy the Cluster Autoscaler on Amazon EKS cluster. ## Related Projects -Check out these related projects. +Check out other [terraform kubernetes addons](https://github.com/orgs/lablabs/repositories?q=terraform-aws-eks&type=public&language=&sort=). -- [terraform-aws-eks-external-dns](https://github.com/lablabs/terraform-aws-eks-external-dns) -- [terraform-aws-eks-calico](https://github.com/lablabs/terraform-aws-eks-calico) -- [terraform-aws-eks-alb-ingress](https://github.com/lablabs/terraform-aws-eks-alb-ingress) -- [terraform-aws-eks-metrics-server](https://github.com/lablabs/terraform-aws-eks-metrics-server) -- [terraform-aws-eks-prometheus-node-exporter](https://github.com/lablabs/terraform-aws-eks-prometheus-node-exporter) -- [terraform-aws-eks-kube-state-metrics](https://github.com/lablabs/terraform-aws-eks-kube-state-metrics) -- [terraform-aws-eks-node-problem-detector](https://github.com/lablabs/terraform-aws-eks-node-problem-detector) +## Deployment methods +### Helm +Deploy helm chart by helm (default method, set `enabled = true`) + +### Argo kubernetes +Deploy helm chart as argo application by kubernetes manifest (set `enabled = true` and `argo_enabled = true`) + +### Argo helm +When deploying with ArgoCD application, Kubernetes terraform provider requires access to Kubernetes cluster API during plan time. This introduces potential issue when you want to deploy the cluster with this addon at the same time, during the same Terraform run. + +To overcome this issue, the module deploys the ArgoCD application object using the Helm provider, which does not require API access during plan. If you want to deploy the application using this workaround, you can set the `argo_helm_enabled` variable to `true`. + +Create helm release resource and deploy it as argo application (set `enabled = true`, `argo_enabled = true` and `argo_helm_enabled = true`) + +## AWS IAM resources + +To disable of creation IRSA role and IRSA policy, set `irsa_role_create = false` and `irsa_policy_enabled = false`, respectively + +### Role assuming +To assume role set `irsa_assume_role_enabled = true` and specify `irsa_assume_role_arn` variable ## Examples @@ -58,11 +71,13 @@ No modules. | [aws_iam_policy.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource | | [aws_iam_role.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource | | [aws_iam_role_policy_attachment.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource | +| [aws_iam_role_policy_attachment.this_additional](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource | | [helm_release.argo_application](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource | | [helm_release.this](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource | | [kubernetes_manifest.this](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/manifest) | resource | | [aws_iam_policy_document.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | | [aws_iam_policy_document.this_assume](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | +| [aws_iam_policy_document.this_irsa](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | | [aws_region.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | data source | | [utils_deep_merge_yaml.argo_helm_values](https://registry.terraform.io/providers/cloudposse/utils/latest/docs/data-sources/deep_merge_yaml) | data source | | [utils_deep_merge_yaml.values](https://registry.terraform.io/providers/cloudposse/utils/latest/docs/data-sources/deep_merge_yaml) | data source | @@ -123,6 +138,10 @@ No modules. | [helm\_timeout](#input\_helm\_timeout) | Time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) | `number` | `300` | no | | [helm\_wait](#input\_helm\_wait) | Will wait until all helm release resources are in a ready state before marking the release as successful. It will wait for as long as timeout | `bool` | `false` | no | | [helm\_wait\_for\_jobs](#input\_helm\_wait\_for\_jobs) | If wait is enabled, will wait until all helm Jobs have been completed before marking the release as successful. It will wait for as long as timeout | `bool` | `false` | no | +| [irsa\_additional\_policies](#input\_irsa\_additional\_policies) | Map of the additional policies to be attached to default role. Where key is arbitrary id and value is policy arn. | `map(string)` | `{}` | no | +| [irsa\_assume\_role\_arn](#input\_irsa\_assume\_role\_arn) | Assume role arn. Assume role must be enabled. | `string` | `""` | no | +| [irsa\_assume\_role\_enabled](#input\_irsa\_assume\_role\_enabled) | Whether IRSA is allowed to assume role defined by assume\_role\_arn. Useful for hosted zones in another AWS account. | `bool` | `false` | no | +| [irsa\_policy\_enabled](#input\_irsa\_policy\_enabled) | Whether to create opinionated policy to allow operations on specified zones in `policy_allowed_zone_ids`. | `bool` | `true` | no | | [irsa\_role\_create](#input\_irsa\_role\_create) | Whether to create IRSA role and annotate service account | `bool` | `true` | no | | [irsa\_role\_name\_prefix](#input\_irsa\_role\_name\_prefix) | The IRSA role name prefix for vector | `string` | `"eks-irsa"` | no | | [irsa\_tags](#input\_irsa\_tags) | IRSA resources tags | `map(string)` | `{}` | no | diff --git a/iam.tf b/iam.tf index 112f01a..7a43b71 100644 --- a/iam.tf +++ b/iam.tf @@ -3,7 +3,7 @@ locals { } data "aws_iam_policy_document" "this" { - count = local.irsa_role_create ? 1 : 0 + count = local.irsa_role_create && var.irsa_policy_enabled && !var.irsa_assume_role_enabled ? 1 : 0 statement { sid = "Autoscaling" @@ -28,16 +28,33 @@ data "aws_iam_policy_document" "this" { } +data "aws_iam_policy_document" "this_assume" { + count = local.irsa_role_create && var.irsa_assume_role_enabled ? 1 : 0 + + statement { + sid = "AllowAssumeClusterAutoscalerRole" + effect = "Allow" + actions = [ + "sts:AssumeRole" + ] + resources = [ + var.irsa_assume_role_arn + ] + } +} + resource "aws_iam_policy" "this" { - count = local.irsa_role_create ? 1 : 0 + count = local.irsa_role_create && (var.irsa_policy_enabled || var.irsa_assume_role_enabled) ? 1 : 0 + name = "${var.irsa_role_name_prefix}-${var.helm_chart_name}" path = "/" description = "Policy for cluster-autoscaler service" + policy = var.irsa_assume_role_enabled ? data.aws_iam_policy_document.this_assume[0].json : data.aws_iam_policy_document.this[0].json - policy = data.aws_iam_policy_document.this[0].json + tags = var.irsa_tags } -data "aws_iam_policy_document" "this_assume" { +data "aws_iam_policy_document" "this_irsa" { count = local.irsa_role_create ? 1 : 0 statement { @@ -64,7 +81,7 @@ data "aws_iam_policy_document" "this_assume" { resource "aws_iam_role" "this" { count = local.irsa_role_create ? 1 : 0 name = "${var.irsa_role_name_prefix}-${var.helm_chart_name}" - assume_role_policy = data.aws_iam_policy_document.this_assume[0].json + assume_role_policy = data.aws_iam_policy_document.this_irsa[0].json tags = var.irsa_tags } @@ -73,3 +90,10 @@ resource "aws_iam_role_policy_attachment" "this" { role = aws_iam_role.this[0].name policy_arn = aws_iam_policy.this[0].arn } + +resource "aws_iam_role_policy_attachment" "this_additional" { + for_each = local.irsa_role_create ? var.irsa_additional_policies : {} + + role = aws_iam_role.this[0].name + policy_arn = each.value +} diff --git a/variables.tf b/variables.tf index 57d1a82..477ed7c 100644 --- a/variables.tf +++ b/variables.tf @@ -72,6 +72,29 @@ variable "irsa_role_create" { description = "Whether to create IRSA role and annotate service account" } +variable "irsa_policy_enabled" { + type = bool + default = true + description = "Whether to create opinionated policy to allow operations on specified zones in `policy_allowed_zone_ids`." +} + +variable "irsa_assume_role_enabled" { + type = bool + default = false + description = "Whether IRSA is allowed to assume role defined by assume_role_arn. Useful for hosted zones in another AWS account." +} + +variable "irsa_assume_role_arn" { + default = "" + description = "Assume role arn. Assume role must be enabled." +} + +variable "irsa_additional_policies" { + type = map(string) + default = {} + description = "Map of the additional policies to be attached to default role. Where key is arbitrary id and value is policy arn." +} + variable "irsa_role_name_prefix" { type = string default = "eks-irsa" From 748f0f4e8cd92fca46a0e7b1daa34f1daedf78a3 Mon Sep 17 00:00:00 2001 From: Jaroslav Vojtek Date: Tue, 28 Jun 2022 22:58:22 +0200 Subject: [PATCH 10/15] fix: enabling terraform_checkov --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 89027ad..6b572bb 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -15,7 +15,7 @@ repos: - id: terraform_fmt - id: terraform_tflint - id: terraform_validate - # - id: terraform_checkov + - id: terraform_checkov - id: terraform_docs args: - '--args=--hide providers --sort-by required' From 1e292e6608423c224a6a572faa542e197b631176 Mon Sep 17 00:00:00 2001 From: Jaroslav Vojtek Date: Tue, 28 Jun 2022 23:11:31 +0200 Subject: [PATCH 11/15] fix(README.md): removing old part from docs --- README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/README.md b/README.md index 16904aa..ead4e9b 100644 --- a/README.md +++ b/README.md @@ -43,11 +43,6 @@ To assume role set `irsa_assume_role_enabled = true` and specify `irsa_assume_ro See [Basic example](examples/basic/README.md) for further information. -## Potential issues with running terraform plan - -When deploying with ArgoCD application, Kubernetes terraform provider requires access to Kubernetes cluster API during plan time. This introduces potential issue when you want to deploy the cluster with this addon at the same time, during the same Terraform run. - -To overcome this issue, the module deploys the ArgoCD application object using the Helm provider, which does not require API access during plan. If you want to deploy the application using this workaround, you can set the `argo_helm_enabled` variable to `true`. ## Requirements From 8773b5f3ddbe1f5c6cc6421bfa376827d7ecea3e Mon Sep 17 00:00:00 2001 From: Jaroslav Vojtek Date: Thu, 30 Jun 2022 15:47:24 +0200 Subject: [PATCH 12/15] fix: resolving PR comments --- .pre-commit-config.yaml | 9 +----- README.md | 4 +-- examples/basic/README.md | 4 ++- examples/basic/main.tf | 64 +++++++++++++++++++++++++++++++++++++++- variables.tf | 4 +-- 5 files changed, 71 insertions(+), 14 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 6b572bb..ce47898 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -15,7 +15,7 @@ repos: - id: terraform_fmt - id: terraform_tflint - id: terraform_validate - - id: terraform_checkov + # - id: terraform_checkov - id: terraform_docs args: - '--args=--hide providers --sort-by required' @@ -31,10 +31,3 @@ repos: - id: detect-secrets args: ['--baseline', '.secrets.baseline'] exclude: terraform.tfstate - - - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook - rev: v8.0.0 - hooks: - - id: commitlint - stages: [commit-msg] - additional_dependencies: ['@commitlint/config-conventional'] diff --git a/README.md b/README.md index ead4e9b..9af3558 100644 --- a/README.md +++ b/README.md @@ -135,10 +135,10 @@ No modules. | [helm\_wait\_for\_jobs](#input\_helm\_wait\_for\_jobs) | If wait is enabled, will wait until all helm Jobs have been completed before marking the release as successful. It will wait for as long as timeout | `bool` | `false` | no | | [irsa\_additional\_policies](#input\_irsa\_additional\_policies) | Map of the additional policies to be attached to default role. Where key is arbitrary id and value is policy arn. | `map(string)` | `{}` | no | | [irsa\_assume\_role\_arn](#input\_irsa\_assume\_role\_arn) | Assume role arn. Assume role must be enabled. | `string` | `""` | no | -| [irsa\_assume\_role\_enabled](#input\_irsa\_assume\_role\_enabled) | Whether IRSA is allowed to assume role defined by assume\_role\_arn. Useful for hosted zones in another AWS account. | `bool` | `false` | no | +| [irsa\_assume\_role\_enabled](#input\_irsa\_assume\_role\_enabled) | Whether IRSA is allowed to assume role defined by assume\_role\_arn. | `bool` | `false` | no | | [irsa\_policy\_enabled](#input\_irsa\_policy\_enabled) | Whether to create opinionated policy to allow operations on specified zones in `policy_allowed_zone_ids`. | `bool` | `true` | no | | [irsa\_role\_create](#input\_irsa\_role\_create) | Whether to create IRSA role and annotate service account | `bool` | `true` | no | -| [irsa\_role\_name\_prefix](#input\_irsa\_role\_name\_prefix) | The IRSA role name prefix for vector | `string` | `"eks-irsa"` | no | +| [irsa\_role\_name\_prefix](#input\_irsa\_role\_name\_prefix) | The IRSA role name prefix for vector | `string` | `"cluster-autoscaler-irsa"` | no | | [irsa\_tags](#input\_irsa\_tags) | IRSA resources tags | `map(string)` | `{}` | no | | [namespace](#input\_namespace) | The K8s namespace in which the node-problem-detector service account has been created | `string` | `"cluster-autoscaler"` | no | | [rbac\_create](#input\_rbac\_create) | Whether to create and use RBAC resources | `bool` | `true` | no | diff --git a/examples/basic/README.md b/examples/basic/README.md index 5e415cb..918d18a 100644 --- a/examples/basic/README.md +++ b/examples/basic/README.md @@ -11,7 +11,9 @@ No requirements. | Name | Source | Version | |------|--------|---------| -| [cluster\_autoscaler](#module\_cluster\_autoscaler) | ../../ | n/a | +| [cluster-autoscaler\_argo\_helm](#module\_cluster-autoscaler\_argo\_helm) | ../../ | n/a | +| [cluster-autoscaler\_argo\_manifests](#module\_cluster-autoscaler\_argo\_manifests) | ../../ | n/a | +| [cluster-autoscaler\_helm](#module\_cluster-autoscaler\_helm) | ../../ | n/a | | [eks\_cluster](#module\_eks\_cluster) | cloudposse/eks-cluster/aws | 0.43.2 | | [eks\_node\_group](#module\_eks\_node\_group) | cloudposse/eks-node-group/aws | 0.25.0 | | [vpc](#module\_vpc) | terraform-aws-modules/vpc/aws | 3.6.0 | diff --git a/examples/basic/main.tf b/examples/basic/main.tf index 4c8d66a..64c925d 100644 --- a/examples/basic/main.tf +++ b/examples/basic/main.tf @@ -32,10 +32,72 @@ module "eks_node_group" { depends_on = [module.eks_cluster.kubernetes_config_map_id] } -module "cluster_autoscaler" { +module "cluster-autoscaler_helm" { source = "../../" + enabled = true + argo_enabled = false + argo_helm_enabled = false + + cluster_name = module.eks_cluster.eks_cluster_id + cluster_identity_oidc_issuer = module.eks_cluster.eks_cluster_identity_oidc_issuer + cluster_identity_oidc_issuer_arn = module.eks_cluster.eks_cluster_identity_oidc_issuer_arn + + values = yamlencode({ + "image" : { + "tag" : "v1.21.2" + } + }) + + argo_sync_policy = { + "automated" : {} + "syncOptions" = ["CreateNamespace=true"] + } +} + +module "cluster-autoscaler_argo_manifests" { + source = "../../" + + enabled = true + argo_enabled = true + argo_helm_enabled = false + + cluster_name = module.eks_cluster.eks_cluster_id + cluster_identity_oidc_issuer = module.eks_cluster.eks_cluster_identity_oidc_issuer + cluster_identity_oidc_issuer_arn = module.eks_cluster.eks_cluster_identity_oidc_issuer_arn + + values = yamlencode({ + "image" : { + "tag" : "v1.21.2" + } + }) + + argo_sync_policy = { + "automated" : {} + "syncOptions" = ["CreateNamespace=true"] + } +} + + +module "cluster-autoscaler_argo_helm" { + source = "../../" + + enabled = true + argo_enabled = true + argo_helm_enabled = true + cluster_name = module.eks_cluster.eks_cluster_id cluster_identity_oidc_issuer = module.eks_cluster.eks_cluster_identity_oidc_issuer cluster_identity_oidc_issuer_arn = module.eks_cluster.eks_cluster_identity_oidc_issuer_arn + + values = yamlencode({ + "image" : { + "tag" : "v1.21.2" + } + }) + + argo_sync_policy = { + "automated" : {} + "syncOptions" = ["CreateNamespace=true"] + } } diff --git a/variables.tf b/variables.tf index 477ed7c..e74b3a7 100644 --- a/variables.tf +++ b/variables.tf @@ -81,7 +81,7 @@ variable "irsa_policy_enabled" { variable "irsa_assume_role_enabled" { type = bool default = false - description = "Whether IRSA is allowed to assume role defined by assume_role_arn. Useful for hosted zones in another AWS account." + description = "Whether IRSA is allowed to assume role defined by assume_role_arn." } variable "irsa_assume_role_arn" { @@ -97,7 +97,7 @@ variable "irsa_additional_policies" { variable "irsa_role_name_prefix" { type = string - default = "eks-irsa" + default = "cluster-autoscaler-irsa" description = "The IRSA role name prefix for vector" } From 3eea02d48505c183b93de333d82ac54f415421ad Mon Sep 17 00:00:00 2001 From: Jaroslav Vojtek Date: Thu, 30 Jun 2022 15:48:47 +0200 Subject: [PATCH 13/15] fix: enabling terraform checkov --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index ce47898..b105c2c 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -15,7 +15,7 @@ repos: - id: terraform_fmt - id: terraform_tflint - id: terraform_validate - # - id: terraform_checkov + - id: terraform_checkov - id: terraform_docs args: - '--args=--hide providers --sort-by required' From f1f87a9d1edf63d67ccda7aae8bd61765a8aa4ab Mon Sep 17 00:00:00 2001 From: Jaroslav Vojtek Date: Thu, 30 Jun 2022 15:53:46 +0200 Subject: [PATCH 14/15] fix: increasing terraform required version --- README.md | 2 +- versions.tf | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9af3558..c689e86 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ See [Basic example](examples/basic/README.md) for further information. | Name | Version | |------|---------| -| [terraform](#requirement\_terraform) | >= 0.14 | +| [terraform](#requirement\_terraform) | >= 1.0 | | [aws](#requirement\_aws) | >= 4.19.0 | | [helm](#requirement\_helm) | >= 2.6.0 | | [kubernetes](#requirement\_kubernetes) | >= 2.11.0 | diff --git a/versions.tf b/versions.tf index 30934e5..ea8c3a1 100644 --- a/versions.tf +++ b/versions.tf @@ -1,5 +1,5 @@ terraform { - required_version = ">= 0.14" + required_version = ">= 1.0" required_providers { aws = { From 9f6ffc60200632b3ab6a2b0a9d50be161ab3b2ef Mon Sep 17 00:00:00 2001 From: Jaroslav Vojtek Date: Fri, 1 Jul 2022 11:26:23 +0200 Subject: [PATCH 15/15] fix: removing commitling.config.js --- commitlint.config.js | 23 ----------------------- 1 file changed, 23 deletions(-) delete mode 100644 commitlint.config.js diff --git a/commitlint.config.js b/commitlint.config.js deleted file mode 100644 index d96c749..0000000 --- a/commitlint.config.js +++ /dev/null @@ -1,23 +0,0 @@ -module.exports = { - extends: ['@commitlint/config-conventional'], - rules: { - 'type-enum': [ - 2, - 'always', - [ - 'build', - 'chore', - 'ci', - 'docs', - 'feat', - 'fix', - 'perf', - 'refactor', - 'revert', - 'style', - 'test', - 'conf', - ], - ], - } -}