From b874fce232e08ec3216e3f8d22c5d954e0a8923c Mon Sep 17 00:00:00 2001 From: Bryton Hall Date: Thu, 11 Aug 2022 23:07:20 -0400 Subject: [PATCH] docs reset --- CONTRIBUTING.md | 24 +++ README.md | 65 ++++--- {examples => docs/examples}/default.nix | 0 .../examples}/nginx-deployment/README.md | 0 .../examples}/nginx-deployment/default.nix | 0 .../examples}/nginx-deployment/image.nix | 0 .../examples}/nginx-deployment/module.nix | 0 .../examples}/nginx-deployment/test.nix | 0 docs/logo.svg | 162 ++++++++++++++++++ flake.nix | 2 +- 10 files changed, 225 insertions(+), 28 deletions(-) create mode 100644 CONTRIBUTING.md rename {examples => docs/examples}/default.nix (100%) rename {examples => docs/examples}/nginx-deployment/README.md (100%) rename {examples => docs/examples}/nginx-deployment/default.nix (100%) rename {examples => docs/examples}/nginx-deployment/image.nix (100%) rename {examples => docs/examples}/nginx-deployment/module.nix (100%) rename {examples => docs/examples}/nginx-deployment/test.nix (100%) create mode 100644 docs/logo.svg diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..81348e7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# Contributing + +## Kubernetes versions + +Edit [`./jobs/generators/default.nix`](./jobs/generators/default.nix) and add a block for the new version of Kubernetes in `generate.k8s`. For example: + +```nix +{ + name = "v1.23.nix"; + path = generateK8S "v1.23" (builtins.fetchurl { + url = "https://github.com/kubernetes/kubernetes/raw/v1.23.0/api/openapi-spec/swagger.json"; + sha256 = "0jivg8nlxka1y7gzqpcxkmbvhcbxynyrxmjn0blky30q5064wx2a"; + }); +} +``` + +Then build and copy all specs to [`modules/generated/`](./modules/generated/): + + nix build '.#jobs.x86_64-linux.generators.k8s' + cp ./result/* modules/generated/ + +## Tests + +Tests are executed through GitHub actions; see the [workflow definition](../kubenix/.github/workflows/ci.yml) for commands. diff --git a/README.md b/README.md index 7869d09..635bb65 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,52 @@ -**Kubenix 2.0 is in still work in progress, expect breaking changes** +# kubenix -# KubeNix +Kubernetes resource management with Nix -> Kubernetes resource builder written in nix +nixos logo in kubernetes blue -[![Build Status](https://travis-ci.com/xtruder/kubenix.svg?branch=master)](https://travis-ci.com/xtruder/kubenix) +> **WARN**: this is a work in progress, expect breaking changes -## About +## Usage -KubeNix is a kubernetes resource builder, that uses nix module system for -definition of kubernetes resources and nix build system for building complex -kubernetes resources very easily. +See [./docs/examples/](./docs/examples/) for now. -## Development + -**Debugging e2e test** +## Attribution -``` -nix-build release.nix -A tests.k8s-1_21.testsByName.k8s-crd.test.driver -nix-build release.nix -A tests.k8s-1_21.testsByName..test.driver -resut/bin/nixos-test-driver -testScript; -``` +This project was forked from https://github.com/GTrunSec/kubenix which was forked from https://github.com/xtruder/kubenix. -## License - -[MIT](LICENSE) © [Jaka Hudoklin](https://x-truder.net) +Logo is a mishmash of the [Kubernetes wheel](https://github.com/kubernetes/kubernetes/blob/master/logo/logo.svg) and the [NixOs snowflake](https://github.com/NixOS/nixos-artwork/blob/master/logo/white.svg). diff --git a/examples/default.nix b/docs/examples/default.nix similarity index 100% rename from examples/default.nix rename to docs/examples/default.nix diff --git a/examples/nginx-deployment/README.md b/docs/examples/nginx-deployment/README.md similarity index 100% rename from examples/nginx-deployment/README.md rename to docs/examples/nginx-deployment/README.md diff --git a/examples/nginx-deployment/default.nix b/docs/examples/nginx-deployment/default.nix similarity index 100% rename from examples/nginx-deployment/default.nix rename to docs/examples/nginx-deployment/default.nix diff --git a/examples/nginx-deployment/image.nix b/docs/examples/nginx-deployment/image.nix similarity index 100% rename from examples/nginx-deployment/image.nix rename to docs/examples/nginx-deployment/image.nix diff --git a/examples/nginx-deployment/module.nix b/docs/examples/nginx-deployment/module.nix similarity index 100% rename from examples/nginx-deployment/module.nix rename to docs/examples/nginx-deployment/module.nix diff --git a/examples/nginx-deployment/test.nix b/docs/examples/nginx-deployment/test.nix similarity index 100% rename from examples/nginx-deployment/test.nix rename to docs/examples/nginx-deployment/test.nix diff --git a/docs/logo.svg b/docs/logo.svg new file mode 100644 index 0000000..84d5968 --- /dev/null +++ b/docs/logo.svg @@ -0,0 +1,162 @@ + + + +image/svg+xml diff --git a/flake.nix b/flake.nix index 99b65ab..cb6a8db 100644 --- a/flake.nix +++ b/flake.nix @@ -83,7 +83,7 @@ then pkgs.runCommandNoCC "testing-suite-config-assertions-for-${suite.name}-succeeded" {} "echo success > $out" else pkgs.runCommandNoCC "testing-suite-config-assertions-for-${suite.name}-failed" {} "exit 1"; mkExamples = attrs: - (import ./examples {inherit evalModules;}) + (import ./docs/examples {inherit evalModules;}) ({registry = "docker.io/gatehub";} // attrs); mkK8STests = attrs: (import ./tests {inherit evalModules;})