From a580dc65fcfb584f56a7cbf60b57c944e328bf85 Mon Sep 17 00:00:00 2001 From: "Matthew C. Morgan" Date: Tue, 13 Aug 2024 17:14:23 -0400 Subject: [PATCH] =?UTF-8?q?=F0=9F=8E=A8=20style(repo):=20resolve=20lints?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .cz.yaml | 8 +++ .gitignore | 1 - .pre-commit-config.yaml | 99 ++++++++++++++++++++++++++++++ .releaserc.json | 36 +++++++++++ .terraform-docs.yml | 44 +++++++++++++ .tflint.hcl | 21 +++++++ README.md | 71 +++++++++++++++++++++ chart/kiali/Chart.yaml | 1 + chart/kiali/templates/_helpers.tpl | 1 + chart/kiali/templates/kiali.yaml | 1 + chart/kiali/templates/secret.yaml | 1 + chart/kiali/values.yaml | 3 +- copy_images.tf | 12 +--- main.tf | 70 +++++++++------------ outputs.tf | 4 +- requirements.tf | 8 --- variables.tf | 10 +-- version.tf | 4 +- 18 files changed, 324 insertions(+), 71 deletions(-) create mode 100644 .cz.yaml create mode 100644 .pre-commit-config.yaml create mode 100644 .releaserc.json create mode 100644 .terraform-docs.yml create mode 100644 .tflint.hcl diff --git a/.cz.yaml b/.cz.yaml new file mode 100644 index 0000000..b1981ec --- /dev/null +++ b/.cz.yaml @@ -0,0 +1,8 @@ +--- +commitizen: + major_version_zero: true + name: cz_gitmoji + tag_format: $version + update_changelog_on_bump: true + version_provider: scm + version_scheme: semver2 diff --git a/.gitignore b/.gitignore index 7c1cae9..403ffa9 100644 --- a/.gitignore +++ b/.gitignore @@ -35,4 +35,3 @@ override.tf.json # Ignore CLI configuration files .terraformrc terraform.rc - diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..ae5b957 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,99 @@ +repos: +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.6.0 + hooks: + # Git style + - id: check-added-large-files + - id: check-merge-conflict + - id: check-vcs-permalinks + - id: forbid-new-submodules + - id: no-commit-to-branch + + # Common errors + - id: end-of-file-fixer + - id: trailing-whitespace + args: [--markdown-linebreak-ext=md] + exclude: CHANGELOG.md + # - id: check-yaml + - id: check-merge-conflict + - id: check-executables-have-shebangs + + # Cross platform + - id: check-case-conflict + - id: mixed-line-ending + args: [--fix=lf] + + # Security + - id: detect-aws-credentials + args: ['--allow-missing-credentials'] + - id: detect-private-key + +# JSON5 Linter +- repo: https://github.com/pre-commit/mirrors-prettier + rev: v4.0.0-alpha.8 + hooks: + - id: prettier + files: '.json5$' + +# Terraform Hooks +- repo: https://github.com/antonbabenko/pre-commit-terraform + rev: v1.92.1 # Get the latest from: https://github.com/antonbabenko/pre-commit-terraform/releases + hooks: + - id: terraform_fmt + args: + - --hook-config=--parallelism-ci-cpu-cores=2 + - id: terraform_docs + args: + - --hook-config=--parallelism-ci-cpu-cores=2 + - id: terraform_tflint + name: Terraform validate with tflint + description: Validates all Terraform configuration files with TFLint. + require_serial: true + entry: hooks/terraform_tflint.sh + language: script + files: (\.tf|\.tfvars)$ + exclude: \.(terraform/.*|terragrunt-cache)$ + args: + - --hook-config=--parallelism-ci-cpu-cores=2 + - id: terragrunt_fmt + name: Terragrunt fmt + description: Rewrites all Terragrunt configuration files to a canonical format. + entry: hooks/terragrunt_fmt.sh + language: script + files: (\.hcl)$ + exclude: \.(terraform/.*|terragrunt-cache)$ + args: + - --hook-config=--parallelism-ci-cpu-cores=2 + ### DISABLED UNTIL MINIFIED TERRAGRUNT.HCL IS CREATED + # - id: terragrunt_validate + # name: Terragrunt validate + # description: Validates all Terragrunt configuration files. + # entry: hooks/terragrunt_validate.sh + # language: script + # files: (\.hcl)$ + # exclude: \.(terraform/.*|terragrunt-cache)$ + # args: + # - --hook-config=--parallelism-ci-cpu-cores=2 + # - id: terragrunt_validate_inputs + # name: Terragrunt validate inputs + # description: Validates Terragrunt unused and undefined inputs. + # entry: hooks/terragrunt_validate_inputs.sh + # language: script + # files: (\.hcl)$ + # exclude: \.(terraform/.*|terragrunt-cache)$ + # args: + # - --hook-config=--parallelism-ci-cpu-cores=2 + # - id: terragrunt_providers_lock + # name: Terragrunt providers lock + # description: Updates provider signatures in dependency lock files using terragrunt. + # entry: hooks/terragrunt_providers_lock.sh + # language: script + # files: (terragrunt|\.terraform\.lock)\.hcl$ + # exclude: \.(terraform/.*|terragrunt-cache)$ + # args: + # - --hook-config=--parallelism-ci-cpu-cores=2 + +- repo: https://github.com/ljnsn/cz-conventional-gitmoji + rev: v0.3.3 + hooks: + - id: conventional-gitmoji diff --git a/.releaserc.json b/.releaserc.json new file mode 100644 index 0000000..6e39031 --- /dev/null +++ b/.releaserc.json @@ -0,0 +1,36 @@ +{ + "branches": [ + "main", + "master" + ], + "ci": false, + "plugins": [ + "@semantic-release/commit-analyzer", + "@semantic-release/release-notes-generator", + [ + "@semantic-release/github", + { + "successComment": + "This ${issue.pull_request ? 'PR is included' : 'issue has been resolved'} in version ${nextRelease.version} :tada:", + "labels": false, + "releasedLabels": false + } + ], + [ + "@semantic-release/changelog", + { + "changelogFile": "CHANGELOG.md", + "changelogTitle": "# Changelog\n\nAll notable changes to this project will be documented in this file." + } + ], + [ + "@semantic-release/git", + { + "assets": [ + "CHANGELOG.md" + ], + "message": "chore(release): version ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}" + } + ] + ] +} diff --git a/.terraform-docs.yml b/.terraform-docs.yml new file mode 100644 index 0000000..fabfb8d --- /dev/null +++ b/.terraform-docs.yml @@ -0,0 +1,44 @@ +formatter: markdown table + +header-from: main.tf +footer-from: "" + +sections: +## hide: [] + show: + - data-sources + - header + - footer + - inputs + - modules + - outputs + - providers + - requirements + - resources + +output: + file: README.md + mode: inject + template: |- + + {{ .Content }} + + +output-values: + enabled: false + from: "" + +sort: + enabled: true + by: name + +settings: + anchor: true + color: true + default: true + description: true + escape: true + indent: 2 + required: true + sensitive: true + type: true diff --git a/.tflint.hcl b/.tflint.hcl new file mode 100644 index 0000000..684d807 --- /dev/null +++ b/.tflint.hcl @@ -0,0 +1,21 @@ +config { + module = true + force = false + disabled_by_default = false +} + +rule "aws_instance_invalid_type" { + enabled = true +} + +plugin "aws" { + enabled = true + version = "0.32.0" + source = "github.com/terraform-linters/tflint-ruleset-aws" +} + +plugin "terraform" { + enabled = true + version = "0.9.0" + source = "github.com/terraform-linters/tflint-ruleset-terraform" +} diff --git a/README.md b/README.md index b77f977..88a5413 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,75 @@ # tfmod-kiali +## Requirements + +| Name | Version | +|------|---------| +| [terraform](#requirement\_terraform) | >= 0.13 | +| [helm](#requirement\_helm) | >= 2.11.0 | +| [kubernetes](#requirement\_kubernetes) | >= 2.23.0 | + +## Providers + +| Name | Version | +|------|---------| +| [helm](#provider\_helm) | 2.14.1 | +| [kubernetes](#provider\_kubernetes) | 2.31.0 | + +## Modules + +| Name | Source | Version | +|------|--------|---------| +| [images](#module\_images) | git@github.e.it.census.gov:terraform-modules/aws-ecr-copy-images.git/ | tf-upgrade | +| [kiali\_ingress](#module\_kiali\_ingress) | git@github.e.it.census.gov:SCT-Engineering/tfmod-gogatekeeper.git// | n/a | +| [preinstall](#module\_preinstall) | git@github.e.it.census.gov:SCT-Engineering/tfmod-config-job.git//config-job | n/a | +| [service\_account](#module\_service\_account) | git@github.e.it.census.gov:SCT-Engineering/tfmod-config-job.git//service-account | n/a | + +## Resources + +| Name | Type | +|------|------| +| [helm_release.kiali](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource | +| [helm_release.kiali_operator](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource | +| [kubernetes_namespace.ns](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/namespace) | resource | +| [kubernetes_namespace.operators](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/data-sources/namespace) | data source | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [certificate\_issuer](#input\_certificate\_issuer) | The cluster issuer to use to create the grafana SSL certificate. | `string` | n/a | yes | +| [cluster\_domain](#input\_cluster\_domain) | The domain name used to reference ingresses for the cluster | `string` | n/a | yes | +| [cluster\_name](#input\_cluster\_name) | The name of the cluster into which the tools are deployed. | `string` | n/a | yes | +| [gogatekeeper\_chart\_version](#input\_gogatekeeper\_chart\_version) | When SSO information is supplied, use this gogatekeeper chart version to protect kiali/jaeger | `string` | `""` | no | +| [gogatekeeper\_registry](#input\_gogatekeeper\_registry) | When SSO information is supplied, use gogatekeeper in this registry to protect kiali/jaeger | `string` | `""` | no | +| [gogatekeeper\_repository](#input\_gogatekeeper\_repository) | When SSO information is supplied, use gogatekeeper in this repository to protect kiali/jaeger | `string` | `""` | no | +| [gogatekeeper\_tag](#input\_gogatekeeper\_tag) | When SSO information is supplied, use gogatekeeper with this tag to protect kiali/jaeger | `string` | `""` | no | +| [grafana\_internal\_url](#input\_grafana\_internal\_url) | The url within the cluster to use to access grafana. | `string` | n/a | yes | +| [grafana\_namespace](#input\_grafana\_namespace) | The namespace holding the grafana instance, used to look up the grafana password. | `string` | n/a | yes | +| [grafana\_public\_url](#input\_grafana\_public\_url) | The URL incoming traffic from outisde the cluster uses to access grafana. | `string` | n/a | yes | +| [grafana\_secret\_name](#input\_grafana\_secret\_name) | The secret in the holding the grafana admin password. | `string` | n/a | yes | +| [istio\_namespace](#input\_istio\_namespace) | The namespace where istio has been deployed. | `string` | `"istio-system"` | no | +| [jaeger\_internal\_url](#input\_jaeger\_internal\_url) | The url within the cluster to use to query the jaegertracing. | `string` | n/a | yes | +| [keycloak\_namespace](#input\_keycloak\_namespace) | The namespace holding the keycloak instance. | `string` | `""` | no | +| [keycloak\_public\_url](#input\_keycloak\_public\_url) | The hostname used with the cluster domain to access keycloak | `string` | `""` | no | +| [keycloak\_realm](#input\_keycloak\_realm) | The existing keycloak realm in which the client should be created | `string` | `""` | no | +| [kiali\_application\_version](#input\_kiali\_application\_version) | The version of kiali to install | `string` | `"v1.73.0"` | no | +| [kiali\_operator\_version](#input\_kiali\_operator\_version) | The version of kiali to install | `string` | `"1.73.0"` | no | +| [namespace](#input\_namespace) | The namespace to create and into which the tools are deployed. | `string` | `"istio-tools"` | no | +| [operators\_namespace](#input\_operators\_namespace) | The namespace into which all operators are to be deployed. | `string` | n/a | yes | +| [profile](#input\_profile) | The AWS\_PROFILE to use while running the scripts. | `string` | `""` | no | +| [prometheus\_internal\_url](#input\_prometheus\_internal\_url) | The url within the cluster to use to query the prometheus server. | `string` | n/a | yes | +| [public\_hostname](#input\_public\_hostname) | The hostname to use for kiali that will be publicly available | `string` | `"kiali"` | no | +| [sso\_client\_id](#input\_sso\_client\_id) | The client id to use for SSO | `string` | `""` | no | +| [sso\_client\_secret](#input\_sso\_client\_secret) | The secret associated with the sso\_client\_id | `string` | `""` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| [internal\_endpoint](#output\_internal\_endpoint) | The internal endpoint to use to access kiali | +| [module\_name](#output\_module\_name) | The name of this module. | +| [module\_version](#output\_module\_version) | The version of this module. | +| [public\_endpoint](#output\_public\_endpoint) | The public endpoint to use to access kiali | diff --git a/chart/kiali/Chart.yaml b/chart/kiali/Chart.yaml index f6f22a3..f5b6dc8 100644 --- a/chart/kiali/Chart.yaml +++ b/chart/kiali/Chart.yaml @@ -1,3 +1,4 @@ +--- apiVersion: v2 name: kiali description: A Helm chart for Kubernetes diff --git a/chart/kiali/templates/_helpers.tpl b/chart/kiali/templates/_helpers.tpl index 1a082cd..25040c8 100644 --- a/chart/kiali/templates/_helpers.tpl +++ b/chart/kiali/templates/_helpers.tpl @@ -1,3 +1,4 @@ +--- {{/* Expand the name of the chart. */}} diff --git a/chart/kiali/templates/kiali.yaml b/chart/kiali/templates/kiali.yaml index 6d4a312..4b2d47c 100644 --- a/chart/kiali/templates/kiali.yaml +++ b/chart/kiali/templates/kiali.yaml @@ -1,3 +1,4 @@ +--- apiVersion: kiali.io/v1alpha1 kind: Kiali metadata: diff --git a/chart/kiali/templates/secret.yaml b/chart/kiali/templates/secret.yaml index 38ec42d..5b5eb27 100644 --- a/chart/kiali/templates/secret.yaml +++ b/chart/kiali/templates/secret.yaml @@ -1,3 +1,4 @@ +--- {{ if .Values.openid.secret }} apiVersion: v1 kind: Secret diff --git a/chart/kiali/values.yaml b/chart/kiali/values.yaml index 7c31d29..c8fa8b0 100644 --- a/chart/kiali/values.yaml +++ b/chart/kiali/values.yaml @@ -1,4 +1,4 @@ - +--- publicHostname: "kiali" publicDomain: "cluster.domain" @@ -18,4 +18,3 @@ openid: disableRbac: true issuerUri: "https://keycloak.cluster.domain/realms/sso_admin_realm" usernameClaim: "username_claim" - diff --git a/copy_images.tf b/copy_images.tf index 96d815f..418ba95 100644 --- a/copy_images.tf +++ b/copy_images.tf @@ -1,6 +1,6 @@ locals { kiali_operator_key = format("%v#%v", "istio-tools/kiali-operator", var.kiali_application_version) - kiali_key = format("%v#%v", "istio-tools/kiali", var.kiali_application_version) + # kiali_key = format("%v#%v", "istio-tools/kiali", var.kiali_application_version) image_config = [ ## Images for Kiali @@ -33,16 +33,6 @@ module "images" { image_config = local.image_config tags = {} - ### optional - ## account_alias = "" - ## account_id = "" - ## destination_password = "" - ## destination_username = "" - ## override_prefixes = {} - ## region = "" - ## source_password = "" - ## source_username = "" - enable_lifecycle_policy = true lifecycle_policy_all = true force_delete = true diff --git a/main.tf b/main.tf index 239e882..10215b3 100644 --- a/main.tf +++ b/main.tf @@ -1,14 +1,5 @@ locals { - ns = try(kubernetes_namespace.ns[0].metadata[0].name, data.kubernetes_namespace.existing-ns[0].metadata[0].name) - public_hostname = format("kiali.%v", var.cluster_domain) - public_port_number = "80" - public_url = format("https://%v:%v/", local.public_hostname, local.public_port_number) - - internal_hostname = format("kiali.%v.svc.cluster.local", var.namespace) - internal_port_number = "20001" - internal_url = format("http://%v:%v/", local.internal_hostname, local.internal_port_number) - have_keycloak = ( try(length(var.keycloak_namespace), 0) > 0 && try(length(var.sso_client_id), 0) > 0 && @@ -17,20 +8,27 @@ locals { try(length(var.keycloak_realm), 0) > 0 ) ? true : false - keycloak_issuer_uri = ( - local.have_keycloak ? - format("%v/realms/%v", - var.keycloak_public_url, - var.keycloak_realm - ) - : "") + internal_hostname = format("kiali.%v.svc.cluster.local", var.namespace) + internal_port_number = "20001" + internal_url = format("http://%v:%v/", local.internal_hostname, local.internal_port_number) + # keycloak_issuer_uri = ( + # local.have_keycloak ? + # format("%v/realms/%v", + # var.keycloak_public_url, + # var.keycloak_realm + # ) + # : "") kiali_oidc_secret = local.have_keycloak ? "ensure_secret kiali oidc-secret \"${var.sso_client_secret}\"" : ";" preinstall_script = <