This repository has been archived on 2024-04-08. You can view files and clone it, but cannot push or open issues or pull requests.
dagger/docs/references/1234-dagger-types-reference.md
Helder Correia 89475e8618
docs: Add types reference
Signed-off-by: Helder Correia <174525+helderco@users.noreply.github.com>
2022-04-15 11:56:43 +00:00

3.5 KiB

slug displayed_sidebar
/1234/dagger-types-reference 0.2

Dagger Types Reference

Dagger Types are primitives that hold internal references to values stored in the Dagger Engine. They extend the CUE type system and can be used in Dagger Actions. Their definitions can be imported from the dagger.io/dagger package.

The following types are available:

Definition File Description
#FS types.cue Reference to a filesystem tree
#Secret types.cue Secure reference to an external secret
#Socket types.cue Reference to a network socket: unix or npipe

And there's a special instance of a Dagger Type:

| Definition | File | Type | Description | | :------------- | :------------------------------------------------------------------------------------------ | : --- | :-------------------------------------------- | | #Scratch | values.cue | #FS | An empty filesystem tree |

Data structures

There's also some data structures that are tightly coupled to core actions. Their definitions are in the dagger.io/dagger/core package.

Definition File Description
#Mount core/exec.cue Transient filesystem mount
#CacheDir core/exec.cue A (best effort) persistent cache dir
#TempDir core/exec.cue A temporary directory for command execution
Definition File Description
#ImageConfig core/image.cue Container image config
#HealthCheck core/image.cue Container health check