Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jsonnet-libs/k8s
Code generator for Jsonnet Kubernetes libraries.
https://github.com/jsonnet-libs/k8s
jsonnet
Last synced: 3 months ago
JSON representation
Code generator for Jsonnet Kubernetes libraries.
- Host: GitHub
- URL: https://github.com/jsonnet-libs/k8s
- Owner: jsonnet-libs
- License: apache-2.0
- Created: 2020-02-24T22:14:39.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T11:46:06.000Z (3 months ago)
- Last Synced: 2024-10-28T13:38:02.270Z (3 months ago)
- Topics: jsonnet
- Language: Jsonnet
- Homepage:
- Size: 919 KB
- Stars: 171
- Watchers: 9
- Forks: 98
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# k8s-gen
Code generator for Jsonnet Kubernetes libraries.
This repository contains the generator code and relevant bits to generate the jsonnet
libraries. It can generate libraries directly from OpenAPI spec v2 (Swagger) or by
providing CustomResourceDefinitions.
The CI job is set up to generate and update the content of a corresponding Github
repository for each library. The management of these repositories is done through
Terraform.
## Usage
### Create or update a new lib
Create a folder in `libs/`:
```bash
mkdir libs/
```
Setup `config.jsonnet`, this example is for rendering a lib from CRDs:
```jsonnet
# libs//config.jsonnet
local config = import 'jsonnet/config.jsonnet';
config.new(
name='',
specs=[
{
# output directory, usually the version of the upstream application/CRD
output: '',
# crds Endpoints of the CRD manifests, should be omitted if there is an openapi spec
# Only resources of kind CustomResourceDefintion are applied; the default policy is to just
# pass in the CRDs here though.
crds: ['https://url.to.crd.manifest//manifests/crd-all.gen.yaml'],
# openapi spec v2 endpoint
# No need to define this if `crds` is defined
openapi: 'http://localhost:8001/openapi/v2',
# prefix Regex that should match the reverse of the CRDs spec.group
# for example `group: networking.istio.io`
# would become ^io\\.istio\\.networking\\..*"
prefix: '^\\.\\..*',
# localName used in the docs for the example(s)
localName: '',
},
]
)
```
Dry run the generate process:
```bash
$ make build # Build the image
$ make libs/ # Generate the library
```
Set up CI and Terraform code:
```
$ make configure
```
That is it, commit the changes to a branch and make a PR to get things rolling. The CI
should take care of the rest.
## Customizing
Because the generator only creates the most minimal yet functional code, more
sophisticated utilities like constructors (`deployment.new(name, replicas,
containers)`, etc) are not created.
For that, there are two methods for extending:
### `custom` patches
The [`custom/`](https://github.com/jsonnet-libs/k8s/tree/master/libs/k8s/custom)
directory contains a set of `.libsonnet` files, that are _automatically merged_
with the generated result in `main.libsonnet`, so they become part of the
exported API.
For example the patches in `libs/k8s`:
```
libs/k8s/
├── config.jsonnet # Config to generate the k8s jsonnet libraries
├── README.md.tmpl # Template for the index of the generated docs
└── custom
└── core
├── apps.libsonnet # Constructors for `core/v1`, ported from `ksonnet-gen` and `kausal.libsonnet`
├── autoscaling.libsonnet # Extends `autoscaling/v2beta2`
├── batch.libsonnet # Constructors for `batch/v1beta1`, `batch/v2alpha1`, ported from `kausal.libsonnet`
├── core.libsonnet # Constructors for `apps/v1`, `apps/v1beta1`, ported from `ksonnet-gen` and `kausal.libsonnet`
├── list.libsonnet # Adds `core.v1.List`
├── mapContainers.libsonnet # Adds `mapContainers` functions for fields that support them
├── rbac.libsonnet # Adds helper functions to rbac objects
└── volumeMounts.libsonnet # Adds helper functions to mount volumes
```
A reference for these must also be made in the `config.jsonnet`:
```jsonnet
# libs/k8s/config.jsonnet
local config = import 'jsonnet/config.jsonnet';
config.new(
name='k8s',
specs=[
{
...
patchDir: 'custom/core',
},
]
)
```
### Extensions
Extensions serve a similar purpose as `custom/` patches, but are **not
automatically applied**. However, they are still part of the final artifact, but
need to added by the user themselves.
Extensions can be applied as so:
```jsonnet
(import "github.com/jsonnet-libs/k8s-libsonnet/1.21/main.libsonnet")
+ (import "github.com/jsonnet-libs/k8s-libsonnet/extensions/.libsonnet")
```
A reference for these must also be made in the `config.jsonnet`:
```jsonnet
# libs/k8s/config.jsonnet
local config = import 'jsonnet/config.jsonnet';
config.new(
name='k8s',
specs=[
{
...
extensionsDir: 'extensions/core',
},
]
)
```