technofab/kubenix
1
0
Fork 0
mirror of https://github.com/TECHNOFAB11/kubenix.git synced 2025-12-12 08:00:06 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

init cli docs

Browse source
This commit is contained in:
Bryton Hall 2022-08-15 20:34:03 -04:00
parent 89e1e70bf0
commit 9f0ae6e362
2 changed files with 39 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -10,12 +10,6 @@ Kubernetes resource management with Nix
## Usage
<!-- Apply all resources with
nix run github:hall/kubenix . -- apply
> **HINT**: use ` --help` for more commands -->
A minimal example flake (build with `nix build`):
```nix
@ -53,6 +47,30 @@ Either way the JSON manifests will be written to `./result`.
See [./docs/examples](./docs/examples) for more.
## CLI
> **NOTE**: this is a WIP CLI which currently reads the `k8s` attribute on a local flake
Render all resources with
nix run github:hall/kubenix -- render
> **HINT**: use ` --help` for more commands
### Support
The following table gives a general overview of currently supported functionality.
| | kubectl | kustomize | helm | helmfile |
| ------ | :-----: | :-------: | :---: | :------: |
| render | x | | x[^2] | |
| diff | | | | |
| apply | x[^1] | | | |
| hooks | - | - | | |
[^1]: currently create-only
[^2]: piping rendered helm charts to kubectl is a lossy process (e.g., [hooks](https://helm.sh/docs/topics/charts_hooks/) will not work)
## Attribution
This project was forked from https://github.com/GTrunSec/kubenix which was forked from https://github.com/xtruder/kubenix.