equinix-labs/terraform-equinix-kubernetes-addons

Collection of Terraform modules to configure and manage Kubernetes clusters on Equinix Metal servers

Equinix Labs

• See Getting Started for a quick guide to creating a repo.
• See Purpose and Governance to learn about Equinix Labs and to find out how you can contribute to it.
• See Uniform Standards to learn about the tiers of project fitness.
• See Terraform Modules to learn how to prepare, review, and publish Terraform Modules for Equinix Terraform providers.

terraform-equinix-kubernetes-addons's Issues

Longhorn example readme.md

Auto generate example readme.mds

For some reason the terraform-doc code errors out when set to recursive. This prevents it from auto generating readme.md's for the examples.

add prometheus add-on

Metallb example readme.md

modify modules using Remote-Exec to use the standard method in all modules

While the Metallb and CPEM addons perform kubectl command execution from a remote server, the other modules use local-exec. This can cause confusion among users, especially in configurations where different addons are enabled. While we can't offer both options for all modules, I think it's better to just leave local execution, which could even be wrapped in the future with another module to execute everything remotely.

This will generally require two options:

• users to have kubectl installed locally, as well as having the kubeconfig file locally.
• users to have terraform installed in the remote server, and clone an execute the terraform template from there

Update GH actions to commit and push terraform_docs changes

Update Kube-vip addon to support HA clusters

More details of the feature in https://kube-vip.io/docs/usage/equinix/#creating-ha-clusters-in-equinix-metal

In addition @ctreatma pointed out in #59 (review) some missing configuration to allow users to fine-tune their installation, such as namespace

Adopt the Contributing preamble from @dcallao's [template PR](https://github.com/equinix-labs/terraform-equinix-template/pull/4/files#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055R1-R6) here

    We could adopt the preamble from @dcallao's [template PR](https://github.com/equinix-labs/terraform-equinix-template/pull/4/files#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055R1-R6) here

Originally posted by @ctreatma in #5 (comment)

Investigate using the `kubernetes` (or similar) provider for add-ons

As a first pass, we are using null_resource with remote-exec to install & configure Kubernetes add-ons. We should consider using the kubernetes provider (or kubectl, or...) instead in order to provide a more terraform-native experience for add-ons.
With null_resource over SSH, we need to be more explicit about the resource lifecycle, rather than letting the provider determine whether an add-on needs to be updated or deleted.

It's possible that we would run into problems trying to adopt the kubernetes provider, based on Hashicorp's recommendations for the kubernetes provider:

The most reliable way to configure the Kubernetes provider is to ensure that the cluster itself and the Kubernetes provider resources can be managed with separate apply operations. Data-sources can be used to convey values between the two stages as needed.

However, AWS EKS Blueprints use the helm and kubernetes providers successfully without splitting the cluster resources and Kubernetes provider resources into separate root modules: https://github.com/aws-ia/terraform-aws-eks-blueprints/tree/main/examples/complete-kubernetes-addons

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

github-actions

.github/workflows/documentation.yaml

• actions/checkout v3
• terraform-docs/gh-actions v1.0.0
• peter-evans/create-pull-request v5

.github/workflows/pre-commit.yaml

• actions/checkout v3
• actions/cache v3

terraform

main.tf

modules/cloud_provider_equinix_metal/versions.tf

• cloudinit >= 2.2.0
• null >= 3.1
• hashicorp/terraform >= 1.0.0

modules/kube-vip/versions.tf

• http >=3.1.0
• kubectl >= 1.7.0
• hashicorp/terraform >= 1.0.0

modules/longhorn/main.tf

modules/longhorn/versions.tf

• equinix >= 1.11.1
• helm >= 2.8.0
• hashicorp/terraform >= 1.0.0

modules/metallb/versions.tf

• equinix >= 1.11.1
• null >= 3.2.1
• hashicorp/terraform >= 1.0.0

modules/portworx-data-services/main.tf

modules/portworx-data-services/versions.tf

• equinix >= 1.11.1
• external >=2.0
• helm >=2.8.0
• http >=3.1.0
• kubernetes >=2.17.0
• local >= 2.0
• null >=3.0
• template >= 2.0
• hashicorp/terraform >= 1.0.0

modules/portworx/versions.tf

• equinix >= 1.11.1
• external >=2.0
• local >= 2.0
• null >=3.0
• template >= 2.0
• hashicorp/terraform >= 1.0.0

modules/rook/main.tf

modules/rook/versions.tf

• equinix >= 1.11.1
• helm >= 2.8.0
• hashicorp/terraform >= 1.0.0

versions.tf

• equinix ~> 1.14
• helm >= 2.8.0
• kubernetes >=2.17.0
• hashicorp/terraform >= 1.0.0

---

• Check this box to trigger a request for Renovate to run again on this repository

remove the dependency lock file

Remove the.teraform.lock.hcl file and add it to .gitignore to be in line with the Equinix terraform module standards

https://github.com/equinix-labs/equinix-labs/blob/7f04358f109e53ddbfcb08ba0cd68b0b7016c227/terraform-module-standards.md?plain=1#L25

Add storage (CSI) providers

CSI Providers are a common add-on for Equinix Metal Kubernetes clusters. https://deploy.equinix.com/developers/guides/kubernetes-intro/#kubernetes-storage

There are a number of eligible providers. This issue is a stub for offering any provider. One avenue to accomplish this could be to offer an abstract storage module enabling argument, as in https://github.com/equinix/terraform-metal-anthos-on-baremetal/tree/main/modules/storage.

Kubernetes Modules should then adopt this addon module, for example:

• equinix-labs/terraform-equinix-metal-eks-anywhere#64
• equinix/terraform-metal-anthos-on-baremetal#24
• https://github.com/equinix/terraform-metal-multiarch-k8s/blob/cc74f1e324a954db23ba0fcf43847bac71f869e8/variables.tf#L115-L119
• equinix-labs/terraform-equinix-metal-k3s@2466321

Rook example readme.md