Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jrhouston/tfk8s
A tool for converting Kubernetes YAML manifests to Terraform HCL
https://github.com/jrhouston/tfk8s
converter hcl kubernetes terraform yaml
Last synced: 5 days ago
JSON representation
A tool for converting Kubernetes YAML manifests to Terraform HCL
- Host: GitHub
- URL: https://github.com/jrhouston/tfk8s
- Owner: jrhouston
- License: mit
- Created: 2020-04-28T22:47:47.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-17T23:39:43.000Z (11 months ago)
- Last Synced: 2024-11-30T10:11:49.157Z (12 days ago)
- Topics: converter, hcl, kubernetes, terraform, yaml
- Language: Go
- Size: 103 KB
- Stars: 982
- Watchers: 6
- Forks: 61
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-ops - jrhouston/tfk8s - 04-28|2024-01-17 | 一个用于将 Kubernetes 的 YAML 清单转换为 Terraform 的 HCL 的工具。 | (K8S-Tools)
- awesome-repositories - jrhouston/tfk8s - A tool for converting Kubernetes YAML manifests to Terraform HCL (Go)
README
tfk8s [](https://goreportcard.com/report/github.com/jrhouston/tfk8s) 
---
`tfk8s` is a tool that makes it easier to work with the [Terraform Kubernetes Provider](https://github.com/hashicorp/terraform-provider-kubernetes).
If you want to copy examples from the Kubernetes documentation or migrate existing YAML manifests and use them with Terraform without having to convert YAML to HCL by hand, this tool is for you.
- [Demo](#demo)
- [Features](#features)
- [Install](#install)
- [Usage](#usage)
- [Examples](#examples)
- [Create Terraform configuration from YAML files](#create-terraform-configuration-from-yaml-files)
- [Use with kubectl to output maps instead of YAML](#use-with-kubectl-to-output-maps-instead-of-yaml)
- [Convert a Helm chart to Terraform](#convert-a-helm-chart-to-terraform)
- [Convert a directory tree of manifests to Terraform](#convert-a-directory-tree-of-manifests-to-terraform)
## Demo
[
](https://asciinema.org/a/jSmyAg4Ar6EcwKCTCXN8iAJM2)
## Features
- Convert a YAML file containing multiple manifests
- Strip out server side fields when piping `kubectl get $R -o yaml | tfk8s --strip`
## Install
```
go install github.com/jrhouston/tfk8s@latest
```
Alternatively, clone this repo and run:
```
make install
```
If Go's bin directory is not in your `PATH` you will need to add it:
```
export PATH=$PATH:$(go env GOPATH)/bin
```
Or you can install via [brew](https://formulae.brew.sh/formula/tfk8s) for macOS/Linux:
```
brew install tfk8s
```
On macOS, you can also install via [MacPorts](https://www.macports.org):
```
sudo port install tfk8s
```
## Usage
```
Usage of tfk8s:
-f, --file string Input file containing Kubernetes YAML manifests (default "-")
-M, --map-only Output only an HCL map structure
-o, --output string Output file to write Terraform config (default "-")
-p, --provider provider Provider alias to populate the provider attribute
-s, --strip Strip out server side fields - use if you are piping from kubectl get
-Q, --strip-key-quotes Strip out quotes from HCL map keys unless they are required.
-V, --version Show tool version
```
## Examples
### Create Terraform configuration from YAML files
```
tfk8s -f input.yaml -o output.tf
```
or, using pipes:
```
cat input.yaml | tfk8s > output.tf
```
**input.yaml**:
```yaml
---
apiVersion: v1
kind: ConfigMap
metadata:
name: test
data:
TEST: test
```
✨✨ magically becomes ✨✨
**output.tf**:
```hcl
resource "kubernetes_manifest" "configmap_test" {
manifest = {
"apiVersion" = "v1"
"data" = {
"TEST" = "test"
}
"kind" = "ConfigMap"
"metadata" = {
"name" = "test"
}
}
}
```
### Use with kubectl to output maps instead of YAML
```
kubectl get ns default -o yaml | tfk8s -M
```
```hcl
{
"apiVersion" = "v1"
"kind" = "Namespace"
"metadata" = {
"creationTimestamp" = "2020-05-02T15:01:32Z"
"name" = "default"
"resourceVersion" = "147"
"selfLink" = "/api/v1/namespaces/default"
"uid" = "6ac3424c-07a4-4a69-86ae-cc7a4ae72be3"
}
"spec" = {
"finalizers" = [
"kubernetes",
]
}
"status" = {
"phase" = "Active"
}
}
```
### Convert a Helm chart to Terraform
You can use `helm template` to generate a manifest from the chart, then pipe it into tfk8s:
```
helm template ./chart-path -f values.yaml | tfk8s
```
## Convert a directory tree of manifests to Terraform
You can use `tfk8s` in conjunction with `find` to convert an entire directory recursively:
```bash
find dirname/ -name '*.yaml' -type f -exec sh -c 'tfk8s -f {} -o $(echo {} | sed "s/\.[^.]*$//").tf' \;
```