d20ffbe8be
O.1 docs is deprecated. Let's inform user to switch the the latest version Signed-off-by: user.email <jf@dagger.io>
7.7 KiB
| slug | displayed_sidebar |
|---|---|
| /1213/api | 0.2 |
Dagger CUE API
As of Dagger 0.2, the Dagger CUE API can be imported via dagger.io/dagger & dagger.io/dagger/core
The Dagger CUE API is the set of CUE packages released alongside the Dagger engine.
Developers of other Dagger packages are expected to build on top of these core packages.
Plan definition
#Plan defines the structure of a Dagger plan - a complete configuration executable by dagger do
| Definition | File | Description |
|---|---|---|
#Plan |
plan.cue | A special kind of program which dagger can execute |
Core types
Dagger extends the CUE type system with the following core types:
| Definition | File | Description |
|---|---|---|
#Address |
types.cue | Network service address |
#CacheDir |
exec.cue | A (best effort) persistent cache dir |
#FS |
types.cue | Reference to a filesystem tree |
#HealthCheck |
image.cue | Container health check |
#ImageConfig |
image.cue | Container image config |
#Mount |
exec.cue | Transient filesystem mount |
#Ref |
image.cue | An address for a remote container image |
#Scratch |
types.cue | An empty directory |
#Secret |
types.cue | Secure reference to an external secret |
#Socket |
types.cue | Reference to a network socket: unix, tcp/udp or npipe |
#TempDir |
exec.cue | A temporary directory for command execution |
Core actions
Dagger works by executing actions in a certain order and passing data between actions in a certain layout.
Developers can combine actions into higher-level actions, which in turn can be combined into even higher-level actions, and so on at arbitrary levels of depth. At the bottom of this abstraction stack are core actions: these are implemented by Dagger itself, and are always available.
The following core actions are available:
| Definition | File | Description |
|---|---|---|
#Copy |
fs.cue | Copy files between two filesystem trees |
#DecodeSecret |
secrets.cue | Decode a secret without leaking its contents |
#Diff |
fs.cue | Extract the difference between two filesystems as its own file system |
#Dockerfile |
image.cue | Build a container image using a Dockerfile |
#Exec |
exec.cue | Execute a command in a docker-compatible container |
#Export |
image.cue | Export an image as a tar archive |
#GitPull |
git.cue | Download a repository from a remote git server |
#HTTPFetch |
http.cue | Get a file from an HTTP server |
#Merge |
fs.cue | Merge multiple filesystem trees |
#Mkdir |
fs.cue | Create a directory in a filesystem tree |
#NewSecret |
secrets.cue | Create a new a secret from a filesystem tree |
#Pull |
image.cue | Download an image from a docker registry |
#Push |
image.cue | Upload an image to a docker registry |
#ReadFile |
fs.cue | Read a file from a filesystem tree |
#Scratch |
fs.cue | Create an empty filesystem tree |
#Set |
image.cue | Modify a docker image |
#Source |
fs.cue | Access the source for the current CUE package |
#Subdir |
fs.cue | Read a subdirectory from a filesystem tree |
#TrimSecret |
secrets.cue | Trim leading and trailing space characters from a secret |
#WriteFile |
fs.cue | Write a file to a filesystem tree |