nyl 0.4.1

Kubernetes manifest generator with Helm integration
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

# Component

`Component` is a chart-backed resource format identified by:

- `apiVersion: components.nyl.niklasrosenstein.github.com/v1`
- dynamic `kind` (not a fixed literal)

Unlike fixed resource kinds, `kind` encodes either:

- a local component path (`<apiVersion>/<kind>`)
- a remote shortcut (`<base>[#<name>][@<version>]`)

## Resource Shape

```yaml
apiVersion: components.nyl.niklasrosenstein.github.com/v1
kind: example/v1/Nginx
metadata:
  name: web
  namespace: default
spec:
  replicaCount: 2
```

## Semantics

- `kind`: chart target (local or remote shortcut)
- `metadata.name`: Helm release name
- `metadata.namespace`: Helm release namespace (defaults to `default`)
- `spec`: Helm values payload

## Local Resolution

With:

```toml
[project]
components_search_paths = ["components"]
```

`kind: example/v1/Nginx` resolves to:

```text
components/example/v1/Nginx/Chart.yaml
```

Nyl checks `components_search_paths` in order and uses the first match.

## Alias Mapping

`project.aliases` can map regular resource types to component targets:

```toml
[project.aliases]
"myapi.io/v1/MyKind" = "oci://registry-1.docker.io/bitnamicharts/nginx@18.2.4"
```

When an alias matches, Nyl resolves directly to the alias target.

## Remote Shortcut Parsing

Shortcut format:

```text
<base>[#<name>][@<version>]
```

Remote bases:

- `http://` or `https://`
- `oci://`
- `git+`

For complete shortcut examples and guidance, see [Remote Shortcuts & Aliases](../../components/remote-shortcuts-and-aliases.md).