kdwils / splinter Goto Github PK

CLI to split kubernetes manifests into their own manifests separated by resource kind, or alternatively merge manifests into a single file.

Go 100.00%

cli golang kubernetes-manifest-files

splinter's Introduction

Splinter

Simple tool to split or flatten kubernetes manifests.

It is often the case that I will use helm template where certain values are not supported and end up with a single massive manifest which is messy to work with.

Instead, I would prefer to have multiple smaller manifests separated by resource kind.

Usage

Commands

Command	Subcommand	Description
splinter	split	split a single manifest into multiple manifests organized by resource kind
splinter	merge	merge individual manifests into a single manifest

Flags

Flag	Required	Description	Command
--include, -i	false	optional flag to set what files or directories to include	all
--kustomize, -k	false	spit out a kustomization.yaml for the splintered or merged manifest(s)	all
--output, -o	false	directory to write manifest(s) to	all
--delete, -d	false	delete all files used when merging manifests	merge
--std-out	false	print to stdout instead of writing to disk	merge

Examples

splinter split --input examples/metallb.yaml --output examples/split/

splinter split examples/metallb.yaml -o examples/split/

splinter merge examples/split/ -o examples/flatten/my-manifest.yaml

You can also pipe from stdin

helm template my-release sealed-secrets/sealed-secrets | splinter split -o my-dir/
helm template my-release sealed-secrets/sealed-secrets | splinter split -i anotherfile.yaml -o my-dir/

Installation

Go:

go install github.com/kdwils/splinter@latest

Github:

check out the latest release

splinter's People

Contributors

Stargazers

Watchers

splinter's Issues

💡 [REQUEST] - add merge flag to support writing to stdout instead of writing to disk

Reference Issues

No response

Summary

Instead of always writing to disk during a merge, there should be an option to write to stdout instead. This allows more flexibility for users to consume the output.

Basic Example

splinter merge my-dir --std-out would instead write to stdout rather than to disk

💡 [REQUEST] - add flag to delete resources that have been merged into a single manifest

Reference Issues

No response

Summary

add a flag to delete any resources that are merged into a single manifest so they do not have to be deleted manually

Basic Example

splinter --merge . -d deletes all merged resources

🐛 [BUG] - merge flag causes command to fail due to defaulting output path to a directory instead of a file path

Description

merge flag causes command to fail due to defaulting output path to a directory instead of a file path

Reproduction steps

go run main.go split --merge examples/split

results in an exit code of 1 as we attempt to write to a directory instead of a file

Logs

Error: open /Users/kylewilson/go-work/src/github.com/kdwils/splinter: is a directory
Usage:
  splinter [flags]

Flags:
      --config string        config file (default is $HOME/.splinter.yaml)
  -e, --exclusions strings   files or directories to exclude
  -h, --help                 help for splinter
  -i, --input strings        provide /path/to/input/ or input.yaml
  -k, --kustomize            spit out a kustomization.yaml
      --merge                merge splintered manifests back together
  -o, --output string        provide /path/to/output/dir (default "/Users/kylewilson/go-work/src/github.com/kdwils/splinter")
  -t, --toggle               Help message for toggle

open /Users/kylewilson/go-work/src/github.com/kdwils/splinter: is a directory

OS

Mac

🐛 [BUG] - merge flag includes kustomization when flattening manifests

Description

merge flag includes kustomization when flattening manifests, creating an invalid manifest

Reproduction steps

merge a split manifest that has a kustomization already created

Logs

No response

OS

Linux

🐛 [BUG] - splinter includes yaml files that are not kubernetes manifests

Description

splinter includes yaml files that are not kubernetes manifests, and therefore creates invalid manifests

instead, splinter should ignore any files that are not valid kubernetes manifests

Reproduction steps

run splinter in a directory where yaml files exists but are not kuberentes resources

Logs

No response

OS

Linux

kdwils / splinter Goto Github PK

splinter's Introduction

Splinter

Usage

Commands

Flags

Examples

Installation

splinter's People

Contributors

Stargazers

Watchers

splinter's Issues

Reference Issues

Summary

Basic Example

Reference Issues

Summary

Basic Example

Description

Reproduction steps

Logs

OS

Description

Reproduction steps

Logs

OS

Description

Reproduction steps

Logs

OS

Recommend Projects

Recommend Topics

Recommend Org