Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add sections for missing blockTypes #388

Merged
merged 2 commits into from
Jul 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions docs/reference/blocktypes.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,3 +82,68 @@ _Note: while the implementation is the same as `functions`, the semantics are di
```nix
{{#include ../../src/std/fwlib/blockTypes/anything.nix}}
```

## Kubectl

Block type for rendering deployment manifests for the [Kubernetes] Cluster scheduler.
Each named attribtute-set under the block contains a set of deployment manifests.

[Kubernetes]: https://kubernetes.io

```nix
{{#include ../../src/std/fwlib/blockTypes/kubectl.nix}}
```

## Files (todo: vs data)

```nix
{{#include ../../src/std/fwlib/blockTypes/files.nix}}
```

## Microvms

Block type for managing [microvm.nix] configuration for declaring lightweight NixOS virtual machines.

[microvm.nix]: https://astro.github.io/microvm.nix

```nix
{{#include ../../src/std/fwlib/blockTypes/microvms.nix}}
```

## Namaka

Block type for declaring [Namaka] snapshot tests.

[Namaka]: https://github.com/nix-community/namaka

```nix
{{#include ../../src/std/fwlib/blockTypes/namaka.nix}}
```

## Nixostests

Block type for declaring VM-based tests for NixOS.

```nix
{{#include ../../src/std/fwlib/blockTypes/nixostests.nix}}
```

## Nomad

Block type for rendering job descriptions for the [Nomad] Cluster scheduler.

[Nomad]: https://www.nomadproject.io/

```nix
{{#include ../../src/std/fwlib/blockTypes/nomad.nix}}
```

## Nvfetcher

Block type for managing [nvfetcher] configuration for updating package definition sources.

[nvfetcher]: https://github.com/berberman/nvfetcher

```nix
{{#include ../../src/std/fwlib/blockTypes/nvfetcher.nix}}
```
2 changes: 1 addition & 1 deletion src/std/fwlib/blockTypes/nvfetcher.nix
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
super,
}:
/*
Use the nvfetcher Blocktype in order to instrucement sources
Use the nvfetcher Blocktype in order to generate package sources
with nvfetcher. See its docs for more details.

Available actions:
Expand Down
Loading