Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/krisnova/naml
Convert Kubernetes YAML to Golang
https://github.com/krisnova/naml
go kubernetes programming-language yaml-templating
Last synced: 5 days ago
JSON representation
Convert Kubernetes YAML to Golang
- Host: GitHub
- URL: https://github.com/krisnova/naml
- Owner: krisnova
- License: apache-2.0
- Created: 2021-06-12T02:40:30.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-21T08:28:22.000Z (over 1 year ago)
- Last Synced: 2024-10-30T17:04:01.789Z (about 1 month ago)
- Topics: go, kubernetes, programming-language, yaml-templating
- Language: Go
- Homepage:
- Size: 77.2 MB
- Stars: 1,257
- Watchers: 21
- Forks: 37
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-repositories - krisnova/naml - Convert Kubernetes YAML to Golang (Go)
README
[](https://pkg.go.dev/github.com/kris-nova/naml)
# Not Another Markup Language.
---
Please help me become an independent programmer by donating directly below.
[](https://ko-fi.com/D1D8CXLHZ)
---
> NAML is a Go library and command line tool that can be used as a framework to develop and deploy Kubernetes applications.
Replace Kubernetes YAML with raw Go!
Say so long 👋 to YAML and start using the Go 🎉 programming language to represent and deploy applications with Kubernetes.
Kubernetes applications are complicated, so lets use a proper Turing complete language to reason about them.
✅ Take advantage of all the lovely features of Go (Syntax highlighting, Cross compiling, Code generation, Documentation)
✅ Test your code directly in local Kubernetes using [kind](https://github.com/kubernetes-sigs/kind). Yes you can really deploy your applications to Kubernetes.
✅ Get your application directly into Go instead of YAML and use it in controllers, operators, CRs/CRDs easily. Use the Go compiler to your advantage.
## Convert YAML to Go
```bash
cat deploy.yaml | naml codify > main.go
```
Turn existing YAML into formatted and syntactically correct Go that implements the `Deployable` interface.
```bash
mkdir out
# Get started quickly with all objects in a namespace
kubectl get all -n default -o yaml | naml codify > out/main.go
# Overload the template with your information
cat app.yaml | naml codify \
--author-name="Charlie" \
--author-email="" > out/main.go
# Combine files in one command
printf "\n\n---\n\n" | cat file1.yaml - file2.yaml - file3.yaml | naml codify > out/main.go
```
Then compile and run your application against Kubernetes.
```bash
cd out
naml build -o app
./app -o yaml
./app install
./app uninstall
```
Use `make help` for more. Happy coding 🎉.
## Example Projects
There is a "repository" of examples to borrow/fork:
- [simple](https://github.com/naml-examples/simple) quick and simple example.
- [examples](https://github.com/naml-examples) GitHub organization.
### The Deployable Interface
As long as there is a Go system that implements this interface it can be used with `naml`. See examples for how to include an implementation in your project.
```go
// Deployable is an interface that can be implemented
// for deployable applications.
type Deployable interface {
// Install will attempt to install in Kubernetes
Install(client kubernetes.Interface) error
// Uninstall will attempt to uninstall in Kubernetes
Uninstall(client kubernetes.Interface) error
// Meta returns a NAML Meta structure which embed Kubernetes *metav1.ObjectMeta
Meta() *AppMeta
// Objects will return the runtime objects defined for each application
Objects() []runtime.Object
}
```
In order to get the raw Kubernetes objects in Go without installing them anywhere, you pass in `nil` in place of an authenticated Kubernetes `Clientset`.
Then you can access the objects in memory.
```go
app.Install(nil)
objects := app.Objects()
```
## Nothing fancy
There isn't anything special here. 🤷♀ We use the same client the rest of Kubernetes does.
❎ No new complex tools.
❎ No charts.
❎ No templating at runtime.
❎ No vague error messages.
❎ No more YAML guessing/checking.
✅ Just Go. 🎉
## Features
- Express applications in 🎉 Go instead of YAML.
- Use the Go compiler to check your syntax.
- Write **real tests** 🤓 using Go to check and validate your deployments.
- Test your applications in Kubernetes using [kind](https://github.com/kubernetes-sigs/kind).
- Define custom installation logic. What happens if it fails? What about logical concerns at runtime?
- Define custom application registries. Multiple apps of the same flavor? No problem.
- Use the latest client (the same client the rest of Kubernetes uses).