Need help with terraform-provider-kubectl?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

gavinbunney
164 Stars 24 Forks Mozilla Public License 2.0 635 Commits 7 Opened issues

Description

Terraform provider to handle raw kubernetes manifest yaml files

Services available

!
?

Need anything else?

Contributors list

# 3,891
Ruby
Terrafo...
Go
terrafo...
155 commits
# 287,054
HTML
kuberne...
Kuberne...
Groovy
137 commits
# 139,461
vscode
Terrafo...
gorouti...
SQL
64 commits
# 33,921
Go
Terrafo...
terrafo...
TypeScr...
30 commits
# 45,390
Go
vanilla...
Terrafo...
garbage...
18 commits
# 10,045
Go
Terrafo...
golang
toml
15 commits
# 65,485
Go
Terrafo...
Groovy
terrafo...
10 commits
# 34,760
Terrafo...
Go
net-fra...
c-sharp
5 commits
# 2,145
Go
Amazon ...
Terrafo...
F#
5 commits
# 246,665
Terrafo...
terrafo...
HTML
Shell
3 commits
# 230,249
logrus
kafka
Terrafo...
HTML
3 commits
# 385,872
Go
terrafo...
Terrafo...
Bash
3 commits
# 54,881
Terrafo...
Go
hcl
hashico...
3 commits
# 263,549
Kuberne...
Apache ...
Scala
Terrafo...
3 commits
# 110,870
Redis
casbin
abac
JavaScr...
3 commits
# 428,120
Shell
terrafo...
Terrafo...
HTML
2 commits
# 9,362
JavaScr...
Symfony
HTML
Terrafo...
2 commits
# 114,515
Ruby
puppet
React
centos
2 commits
# 75,744
Scala
Clojure
aws-cli
Amazon ...
2 commits
# 283,883
Terrafo...
HTML
fips
oauth2
2 commits

Kubernetes "kubectl" Provider

Build Status codecov user guide

This provider is the best way of managing Kubernetes resources in Terraform, by allowing you to use the thing Kubernetes loves best - yaml!

This core of this provider is the

kubectl_manifest
resource, allowing free-form yaml to be processed and applied against Kubernetes. This yaml object is then tracked and handles creation, updates and deleted seamlessly - including drift detection!

A set of helpful data resources to process directories of yaml files and inline templating is available.

This

terraform-provider-kubectl
provider has been used by many large Kubernetes installations to completely manage the lifecycle of Kubernetes resources.

Installation

Terraform 0.13+

The provider can be installed and managed automatically by Terraform. Sample

versions.tf
file :
terraform {
  required_version = ">= 0.13"

required_providers { kubectl = { source = "gavinbunney/kubectl" version = ">= 1.7.0" } } }

Terraform 0.12

Install latest version

The following one-liner script will fetch the latest provider version and download it to your

~/.terraform.d/plugins
directory.
$ mkdir -p ~/.terraform.d/plugins && \
      curl -Ls https://api.github.com/repos/gavinbunney/terraform-provider-kubectl/releases/latest \
      | jq -r ".assets[] | select(.browser_download_url | contains(\"$(uname -s | tr A-Z a-z)\")) | select(.browser_download_url | contains(\"amd64\")) | .browser_download_url" \
      | xargs -n 1 curl -Lo ~/.terraform.d/plugins/terraform-provider-kubectl.zip && \
      pushd ~/.terraform.d/plugins/ && \
      unzip ~/.terraform.d/plugins/terraform-provider-kubectl.zip -d terraform-provider-kubectl-tmp && \
      mv terraform-provider-kubectl-tmp/terraform-provider-kubectl* . && \
      chmod +x terraform-provider-kubectl* && \
      rm -rf terraform-provider-kubectl-tmp && \
      rm -rf terraform-provider-kubectl.zip && \
      popd

Install manually

If you don't want to use the one-liner above, you can download a binary for your system from the release page, then either place it at the root of your Terraform folder or in the Terraform plugin folder on your system.

Quick Start

provider "kubectl" {
  host                   = var.eks_cluster_endpoint
  cluster_ca_certificate = base64decode(var.eks_cluster_ca)
  token                  = data.aws_eks_cluster_auth.main.token
  load_config_file       = false
}

resource "kubectl_manifest" "test" { yaml_body = <

See User Guide for details on installation and all the provided data and resource types.


Development Guide

If you wish to work on the provider, you'll first need Go installed on your machine (version 1.12+ is required). You'll also need to correctly setup a GOPATH, as well as adding

$GOPATH/bin
to your
$PATH
.

To compile the provider, run

make build
. This will build the provider and put the provider binary in the
$GOPATH/bin
directory.

Building The Provider

$ go get github.com/gavinbunney/terraform-provider-kubectl

Enter the provider directory and build the provider

$ cd $GOPATH/src/github.com/gavinbunney/terraform-provider-kubectl
$ make build

Testing

In order to test the provider, you can simply run

make test
.
$ make test

The provider uses k3s to run integration tests. These tests look for any

*.tf
files in the
_examples
folder and run an
plan
,
apply
,
refresh
and
plan
loop over each file.

Inside each file the string

name-here
is replaced with a unique name during test execution. This is a simple string replace before the TF is applied to ensure that tests don't fail due to naming clashes.

Each scenario can be placed in a folder, to help others navigate and use the examples, and added to the README.MD.

Note: The test infrastructure doesn't support multi-file TF configurations so ensure your test scenario is in a single file.

In order to run the full suite of Acceptance tests, run

make testacc
.

Note: Acceptance tests create real resources, and often cost money to run.

$ make testacc

Inspiration

Thanks to the original provider by nabancard and lawrecncegripper on the original base of this provider.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.