kjuulh/dagger
Archived
1
0
Fork 0
Code Issues 1 Pull Requests 1 Projects Releases Wiki Activity

docs: refreshed stdlib

Browse Source 
Signed-off-by: Sam Alba <sam.alba@gmail.com>
This commit is contained in:
Sam Alba 2021-06-16 12:14:39 +02:00
parent 776814910d
commit c6e3d35899
26 changed files with 293 additions and 189 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/reference/universe/alpine.md
View File

@ -6,14 +6,18 @@ sidebar_label: alpine
Base package for Alpine Linux Base package for Alpine Linux
## #Image ```cue
import "dagger.io/alpine"
```
## alpine.#Image
Base image for Alpine Linux Base image for Alpine Linux
### #Image Inputs ### alpine.#Image Inputs
_No input._ _No input._
### #Image Outputs ### alpine.#Image Outputs
_No output._ _No output._

16
docs/reference/universe/aws/README.md
View File

@ -6,11 +6,15 @@ sidebar_label: aws
AWS base package AWS base package
## #CLI ```cue
import "dagger.io/aws"
```
## aws.#CLI
Re-usable aws-cli component Re-usable aws-cli component
### #CLI Inputs ### aws.#CLI Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -18,15 +22,15 @@ Re-usable aws-cli component
|*config.accessKey* | `dagger.#Secret` |AWS access key | |*config.accessKey* | `dagger.#Secret` |AWS access key |
|*config.secretKey* | `dagger.#Secret` |AWS secret key | |*config.secretKey* | `dagger.#Secret` |AWS secret key |
### #CLI Outputs ### aws.#CLI Outputs
_No output._ _No output._
## #Config ## aws.#Config
AWS Config shared by all AWS packages AWS Config shared by all AWS packages
### #Config Inputs ### aws.#Config Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -34,6 +38,6 @@ AWS Config shared by all AWS packages
|*accessKey* | `dagger.#Secret` |AWS access key | |*accessKey* | `dagger.#Secret` |AWS access key |
|*secretKey* | `dagger.#Secret` |AWS secret key | |*secretKey* | `dagger.#Secret` |AWS secret key |
### #Config Outputs ### aws.#Config Outputs
_No output._ _No output._

10
docs/reference/universe/aws/cloudformation.md
View File

@ -6,11 +6,15 @@ sidebar_label: cloudformation
AWS CloudFormation AWS CloudFormation
## #Stack ```cue
import "dagger.io/aws/cloudformation"
```
## cloudformation.#Stack
AWS CloudFormation Stack AWS CloudFormation Stack
### #Stack Inputs ### cloudformation.#Stack Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -24,7 +28,7 @@ AWS CloudFormation Stack
|*timeout* | `*10 \| \>=0 & int` |Maximum waiting time until stack creation/update (in minutes) | |*timeout* | `*10 \| \>=0 & int` |Maximum waiting time until stack creation/update (in minutes) |
|*neverUpdate* | `*false \| true` |Never update the stack if already exists | |*neverUpdate* | `*false \| true` |Never update the stack if already exists |
### #Stack Outputs ### cloudformation.#Stack Outputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |

10
docs/reference/universe/aws/ecr.md
View File

@ -6,11 +6,15 @@ sidebar_label: ecr
Amazon Elastic Container Registry (ECR) Amazon Elastic Container Registry (ECR)
## #Credentials ```cue
import "dagger.io/aws/ecr"
```
## ecr.#Credentials
Convert ECR credentials to Docker Login format Convert ECR credentials to Docker Login format
### #Credentials Inputs ### ecr.#Credentials Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -21,7 +25,7 @@ Convert ECR credentials to Docker Login format
|*ctr.image.config.accessKey* | `dagger.#Secret` |AWS access key | |*ctr.image.config.accessKey* | `dagger.#Secret` |AWS access key |
|*ctr.image.config.secretKey* | `dagger.#Secret` |AWS secret key | |*ctr.image.config.secretKey* | `dagger.#Secret` |AWS secret key |
### #Credentials Outputs ### ecr.#Credentials Outputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |

4
docs/reference/universe/aws/ecs.md
View File

@ -5,3 +5,7 @@ sidebar_label: ecs
# dagger.io/aws/ecs # dagger.io/aws/ecs
AWS Elastic Container Service (ECS) AWS Elastic Container Service (ECS)
```cue
import "dagger.io/aws/ecs"
```

10
docs/reference/universe/aws/eks.md
View File

@ -6,11 +6,15 @@ sidebar_label: eks
AWS Elastic Kubernetes Service (EKS) AWS Elastic Kubernetes Service (EKS)
## #KubeConfig ```cue
import "dagger.io/aws/eks"
```
## eks.#KubeConfig
KubeConfig config outputs a valid kube-auth-config for kubectl client KubeConfig config outputs a valid kube-auth-config for kubectl client
### #KubeConfig Inputs ### eks.#KubeConfig Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -20,7 +24,7 @@ KubeConfig config outputs a valid kube-auth-config for kubectl client
|*clusterName* | `string` |EKS cluster name | |*clusterName* | `string` |EKS cluster name |
|*version* | `*"v1.19.9" \| string` |Kubectl version | |*version* | `*"v1.19.9" \| string` |Kubectl version |
### #KubeConfig Outputs ### eks.#KubeConfig Outputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |

10
docs/reference/universe/aws/elb.md
View File

@ -6,11 +6,15 @@ sidebar_label: elb
AWS Elastic Load Balancer (ELBv2) AWS Elastic Load Balancer (ELBv2)
## #RandomRulePriority ```cue
import "dagger.io/aws/elb"
```
## elb.#RandomRulePriority
Returns an unused rule priority (randomized in available range) Returns an unused rule priority (randomized in available range)
### #RandomRulePriority Inputs ### elb.#RandomRulePriority Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -19,7 +23,7 @@ Returns an unused rule priority (randomized in available range)
|*config.secretKey* | `dagger.#Secret` |AWS secret key | |*config.secretKey* | `dagger.#Secret` |AWS secret key |
|*listenerArn* | `string` |ListenerArn | |*listenerArn* | `string` |ListenerArn |
### #RandomRulePriority Outputs ### elb.#RandomRulePriority Outputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |

22
docs/reference/universe/aws/rds.md
View File

@ -6,11 +6,15 @@ sidebar_label: rds
AWS Relational Database Service (RDS) AWS Relational Database Service (RDS)
## #Database ```cue
import "dagger.io/aws/rds"
```
## rds.#Database
Creates a new Database on an existing RDS Instance Creates a new Database on an existing RDS Instance
### #Database Inputs ### rds.#Database Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -22,17 +26,17 @@ Creates a new Database on an existing RDS Instance
|*secretArn* | `string` |ARN of the database secret (for connecting via rds api) | |*secretArn* | `string` |ARN of the database secret (for connecting via rds api) |
|*dbType* | `string` |Database type MySQL or PostgreSQL (Aurora Serverless only) | |*dbType* | `string` |Database type MySQL or PostgreSQL (Aurora Serverless only) |
### #Database Outputs ### rds.#Database Outputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
|*out* | `string` |Name of the DB created | |*out* | `string` |Name of the DB created |
## #Instance ## rds.#Instance
Fetches information on an existing RDS Instance Fetches information on an existing RDS Instance
### #Instance Inputs ### rds.#Instance Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -41,7 +45,7 @@ Fetches information on an existing RDS Instance
|*config.secretKey* | `dagger.#Secret` |AWS secret key | |*config.secretKey* | `dagger.#Secret` |AWS secret key |
|*dbArn* | `string` |ARN of the database instance | |*dbArn* | `string` |ARN of the database instance |
### #Instance Outputs ### rds.#Instance Outputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -49,11 +53,11 @@ Fetches information on an existing RDS Instance
|*port* | `_\|_` |DB port | |*port* | `_\|_` |DB port |
|*info* | `_\|_` |- | |*info* | `_\|_` |- |
## #User ## rds.#User
Creates a new user credentials on an existing RDS Instance Creates a new user credentials on an existing RDS Instance
### #User Inputs ### rds.#User Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -67,7 +71,7 @@ Creates a new user credentials on an existing RDS Instance
|*grantDatabase* | `*"" \| string` |Name of the database to grants access to | |*grantDatabase* | `*"" \| string` |Name of the database to grants access to |
|*dbType* | `string` |Database type MySQL or PostgreSQL (Aurora Serverless only) | |*dbType* | `string` |Database type MySQL or PostgreSQL (Aurora Serverless only) |
### #User Outputs ### rds.#User Outputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |

10
docs/reference/universe/aws/s3.md
View File

@ -6,11 +6,15 @@ sidebar_label: s3
AWS Simple Storage Service AWS Simple Storage Service
## #Object ```cue
import "dagger.io/aws/s3"
```
## s3.#Object
S3 Bucket object(s) sync S3 Bucket object(s) sync
### #Object Inputs ### s3.#Object Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -23,7 +27,7 @@ S3 Bucket object(s) sync
|*contentType* | `*"" \| string` |Object content type | |*contentType* | `*"" \| string` |Object content type |
|*always* | `*true \| false` |Always write the object to S3 | |*always* | `*true \| false` |Always write the object to S3 |
### #Object Outputs ### s3.#Object Outputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |

10
docs/reference/universe/dagger/README.md
View File

@ -4,14 +4,18 @@ sidebar_label: dagger
# dagger.io/dagger # dagger.io/dagger
## #Secret ```cue
import "dagger.io/dagger"
```
## dagger.#Secret
Secret value Secret value
### #Secret Inputs ### dagger.#Secret Inputs
_No input._ _No input._
### #Secret Outputs ### dagger.#Secret Outputs
_No output._ _No output._

94
docs/reference/universe/dagger/op.md
View File

@ -6,156 +6,160 @@ sidebar_label: op
op: low-level operations for Dagger processing pipelines op: low-level operations for Dagger processing pipelines
## #Copy ```cue
import "dagger.io/dagger/op"
```
### #Copy Inputs ## op.#Copy
### op.#Copy Inputs
_No input._ _No input._
### #Copy Outputs ### op.#Copy Outputs
_No output._ _No output._
## #DockerBuild ## op.#DockerBuild
### #DockerBuild Inputs ### op.#DockerBuild Inputs
_No input._ _No input._
### #DockerBuild Outputs ### op.#DockerBuild Outputs
_No output._ _No output._
## #DockerLogin ## op.#DockerLogin
### #DockerLogin Inputs ### op.#DockerLogin Inputs
_No input._ _No input._
### #DockerLogin Outputs ### op.#DockerLogin Outputs
_No output._ _No output._
## #Exec ## op.#Exec
### #Exec Inputs ### op.#Exec Inputs
_No input._ _No input._
### #Exec Outputs ### op.#Exec Outputs
_No output._ _No output._
## #Export ## op.#Export
Export a value from fs state to cue Export a value from fs state to cue
### #Export Inputs ### op.#Export Inputs
_No input._ _No input._
### #Export Outputs ### op.#Export Outputs
_No output._ _No output._
## #FetchContainer ## op.#FetchContainer
### #FetchContainer Inputs ### op.#FetchContainer Inputs
_No input._ _No input._
### #FetchContainer Outputs ### op.#FetchContainer Outputs
_No output._ _No output._
## #FetchGit ## op.#FetchGit
### #FetchGit Inputs ### op.#FetchGit Inputs
_No input._ _No input._
### #FetchGit Outputs ### op.#FetchGit Outputs
_No output._ _No output._
## #Load ## op.#Load
### #Load Inputs ### op.#Load Inputs
_No input._ _No input._
### #Load Outputs ### op.#Load Outputs
_No output._ _No output._
## #Local ## op.#Local
### #Local Inputs ### op.#Local Inputs
_No input._ _No input._
### #Local Outputs ### op.#Local Outputs
_No output._ _No output._
## #Mkdir ## op.#Mkdir
### #Mkdir Inputs ### op.#Mkdir Inputs
_No input._ _No input._
### #Mkdir Outputs ### op.#Mkdir Outputs
_No output._ _No output._
## #Op ## op.#Op
One operation in a pipeline One operation in a pipeline
### #Op Inputs ### op.#Op Inputs
_No input._ _No input._
### #Op Outputs ### op.#Op Outputs
_No output._ _No output._
## #PushContainer ## op.#PushContainer
### #PushContainer Inputs ### op.#PushContainer Inputs
_No input._ _No input._
### #PushContainer Outputs ### op.#PushContainer Outputs
_No output._ _No output._
## #Subdir ## op.#Subdir
### #Subdir Inputs ### op.#Subdir Inputs
_No input._ _No input._
### #Subdir Outputs ### op.#Subdir Outputs
_No output._ _No output._
## #Workdir ## op.#Workdir
### #Workdir Inputs ### op.#Workdir Inputs
_No input._ _No input._
### #Workdir Outputs ### op.#Workdir Outputs
_No output._ _No output._
## #WriteFile ## op.#WriteFile
### #WriteFile Inputs ### op.#WriteFile Inputs
_No input._ _No input._
### #WriteFile Outputs ### op.#WriteFile Outputs
_No output._ _No output._

40
docs/reference/universe/docker.md
View File

@ -6,81 +6,85 @@ sidebar_label: docker
Docker container operations Docker container operations
## #Build ```cue
import "dagger.io/docker"
```
## docker.#Build
Build a Docker image from source, using included Dockerfile Build a Docker image from source, using included Dockerfile
### #Build Inputs ### docker.#Build Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
|*source* | `dagger.#Artifact` |- | |*source* | `dagger.#Artifact` |- |
### #Build Outputs ### docker.#Build Outputs
_No output._ _No output._
## #Command ## docker.#Command
A container image that can run any docker command A container image that can run any docker command
### #Command Inputs ### docker.#Command Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
|*command* | `string` |Command to execute | |*command* | `string` |Command to execute |
### #Command Outputs ### docker.#Command Outputs
_No output._ _No output._
## #ImageFromDockerfile ## docker.#ImageFromDockerfile
Build a Docker image from the provided Dockerfile contents Build a Docker image from the provided Dockerfile contents
### #ImageFromDockerfile Inputs ### docker.#ImageFromDockerfile Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
|*dockerfile* | `string` |Dockerfile passed as a string | |*dockerfile* | `string` |Dockerfile passed as a string |
|*context* | `dagger.#Artifact` |Build context | |*context* | `dagger.#Artifact` |Build context |
### #ImageFromDockerfile Outputs ### docker.#ImageFromDockerfile Outputs
_No output._ _No output._
## #Pull ## docker.#Pull
Pull a docker container Pull a docker container
### #Pull Inputs ### docker.#Pull Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
|*from* | `string` |Remote ref (example: "index.docker.io/alpine:latest") | |*from* | `string` |Remote ref (example: "index.docker.io/alpine:latest") |
### #Pull Outputs ### docker.#Pull Outputs
_No output._ _No output._
## #Push ## docker.#Push
Push a docker image Push a docker image
### #Push Inputs ### docker.#Push Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
|*ref* | `string` |Remote ref (example: "index.docker.io/alpine:latest") | |*ref* | `string` |Remote ref (example: "index.docker.io/alpine:latest") |
|*source* | `dagger.#Artifact` |Image | |*source* | `dagger.#Artifact` |Image |
### #Push Outputs ### docker.#Push Outputs
_No output._ _No output._
## #Run ## docker.#Run
### #Run Inputs ### docker.#Run Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -96,6 +100,6 @@ _No output._
|*run.command* | `"""\n # Run detach container\n OPTS=""\n \n if [ ! -z "$CONTAINER_NAME" ]; then\n \tOPTS="$OPTS --name $CONTAINER_NAME"\n fi\n \n docker container run -d $OPTS "$IMAGE_REF"\n """` |Command to execute | |*run.command* | `"""\n # Run detach container\n OPTS=""\n \n if [ ! -z "$CONTAINER_NAME" ]; then\n \tOPTS="$OPTS --name $CONTAINER_NAME"\n fi\n \n docker container run -d $OPTS "$IMAGE_REF"\n """` |Command to execute |
|*run.env.IMAGE_REF* | `string` |- | |*run.env.IMAGE_REF* | `string` |- |
### #Run Outputs ### docker.#Run Outputs
_No output._ _No output._

16
docs/reference/universe/gcp/README.md
View File

@ -6,11 +6,15 @@ sidebar_label: gcp
Google Cloud Platform Google Cloud Platform
## #Config ```cue
import "dagger.io/gcp"
```
## gcp.#Config
Base Google Cloud Config Base Google Cloud Config
### #Config Inputs ### gcp.#Config Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -18,15 +22,15 @@ Base Google Cloud Config
|*project* | `string` |GCP project | |*project* | `string` |GCP project |
|*serviceKey* | `dagger.#Secret` |GCP service key | |*serviceKey* | `dagger.#Secret` |GCP service key |
### #Config Outputs ### gcp.#Config Outputs
_No output._ _No output._
## #GCloud ## gcp.#GCloud
Re-usable gcloud component Re-usable gcloud component
### #GCloud Inputs ### gcp.#GCloud Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -34,6 +38,6 @@ Re-usable gcloud component
|*config.project* | `string` |GCP project | |*config.project* | `string` |GCP project |
|*config.serviceKey* | `dagger.#Secret` |GCP service key | |*config.serviceKey* | `dagger.#Secret` |GCP service key |
### #GCloud Outputs ### gcp.#GCloud Outputs
_No output._ _No output._

10
docs/reference/universe/gcp/gcr.md
View File

@ -6,11 +6,15 @@ sidebar_label: gcr
Google Container Registry Google Container Registry
## #Credentials ```cue
import "dagger.io/gcp/gcr"
```
## gcr.#Credentials
Credentials retriever for GCR Credentials retriever for GCR
### #Credentials Inputs ### gcr.#Credentials Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -18,7 +22,7 @@ Credentials retriever for GCR
|*config.project* | `string` |GCP project | |*config.project* | `string` |GCP project |
|*config.serviceKey* | `dagger.#Secret` |GCP service key | |*config.serviceKey* | `dagger.#Secret` |GCP service key |
### #Credentials Outputs ### gcr.#Credentials Outputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |

10
docs/reference/universe/gcp/gke.md
View File

@ -6,11 +6,15 @@ sidebar_label: gke
Google Kubernetes Engine Google Kubernetes Engine
## #KubeConfig ```cue
import "dagger.io/gcp/gke"
```
## gke.#KubeConfig
KubeConfig config outputs a valid kube-auth-config for kubectl client KubeConfig config outputs a valid kube-auth-config for kubectl client
### #KubeConfig Inputs ### gke.#KubeConfig Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -20,7 +24,7 @@ KubeConfig config outputs a valid kube-auth-config for kubectl client
|*clusterName* | `string` |GKE cluster name | |*clusterName* | `string` |GKE cluster name |
|*version* | `*"v1.19.9" \| string` |Kubectl version | |*version* | `*"v1.19.9" \| string` |Kubectl version |
### #KubeConfig Outputs ### gke.#KubeConfig Outputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |

22
docs/reference/universe/git.md
View File

@ -6,27 +6,31 @@ sidebar_label: git
Git operations Git operations
## #CurrentBranch ```cue
import "dagger.io/git"
```
## git.#CurrentBranch
Get the name of the current checked out branch or tag Get the name of the current checked out branch or tag
### #CurrentBranch Inputs ### git.#CurrentBranch Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
|*repository* | `dagger.#Artifact` |Git repository | |*repository* | `dagger.#Artifact` |Git repository |
### #CurrentBranch Outputs ### git.#CurrentBranch Outputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
|*name* | `string` |Git branch name | |*name* | `string` |Git branch name |
## #Repository ## git.#Repository
A git repository A git repository
### #Repository Inputs ### git.#Repository Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -34,21 +38,21 @@ A git repository
|*ref* | `string` |Git ref: can be a commit, tag or branch. Example: "main" | |*ref* | `string` |Git ref: can be a commit, tag or branch. Example: "main" |
|*subdir* | `*null \| string` |(optional) Subdirectory | |*subdir* | `*null \| string` |(optional) Subdirectory |
### #Repository Outputs ### git.#Repository Outputs
_No output._ _No output._
## #Tags ## git.#Tags
List tags of a repository List tags of a repository
### #Tags Inputs ### git.#Tags Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
|*repository* | `dagger.#Artifact` |Git repository | |*repository* | `dagger.#Artifact` |Git repository |
### #Tags Outputs ### git.#Tags Outputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |

28
docs/reference/universe/go.md
View File

@ -6,11 +6,15 @@ sidebar_label: go
Go build operations Go build operations
## #Build ```cue
import "dagger.io/go"
```
## go.#Build
Go application builder Go application builder
### #Build Inputs ### go.#Build Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -22,17 +26,17 @@ Go application builder
|*tags* | `*"" \| string` |Build tags to use for building | |*tags* | `*"" \| string` |Build tags to use for building |
|*ldflags* | `*"" \| string` |LDFLAGS to use for linking | |*ldflags* | `*"" \| string` |LDFLAGS to use for linking |
### #Build Outputs ### go.#Build Outputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
|*output* | `string` |Specify the targeted binary name | |*output* | `string` |Specify the targeted binary name |
## #Container ## go.#Container
A standalone go environment A standalone go environment
### #Container Inputs ### go.#Container Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -40,15 +44,15 @@ A standalone go environment
|*source* | `dagger.#Artifact` |Source code | |*source* | `dagger.#Artifact` |Source code |
|*image.from* | `"docker.io/golang:1.16-alpine"` |Remote ref (example: "index.docker.io/alpine:latest") | |*image.from* | `"docker.io/golang:1.16-alpine"` |Remote ref (example: "index.docker.io/alpine:latest") |
### #Container Outputs ### go.#Container Outputs
_No output._ _No output._
## #Go ## go.#Go
Re-usable component for the Go compiler Re-usable component for the Go compiler
### #Go Inputs ### go.#Go Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -56,13 +60,13 @@ Re-usable component for the Go compiler
|*args* | `[]` |Arguments to the Go binary | |*args* | `[]` |Arguments to the Go binary |
|*source* | `dagger.#Artifact` |Source Directory to build | |*source* | `dagger.#Artifact` |Source Directory to build |
### #Go Outputs ### go.#Go Outputs
_No output._ _No output._
## #Test ## go.#Test
### #Test Inputs ### go.#Test Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -71,6 +75,6 @@ _No output._
|*packages* | `*"." \| string` |Packages to test | |*packages* | `*"." \| string` |Packages to test |
|*args* | `["test", "-v", *"." \| string]` |Arguments to the Go binary | |*args* | `["test", "-v", *"." \| string]` |Arguments to the Go binary |
### #Test Outputs ### go.#Test Outputs
_No output._ _No output._

34
docs/reference/universe/io.md
View File

@ -6,62 +6,66 @@ sidebar_label: io
IO operations IO operations
## #Dir ```cue
import "dagger.io/io"
```
## io.#Dir
Standard interface for directory operations in cue Standard interface for directory operations in cue
### #Dir Inputs ### io.#Dir Inputs
_No input._ _No input._
### #Dir Outputs ### io.#Dir Outputs
_No output._ _No output._
## #File ## io.#File
Standard interface for file operations in cue Standard interface for file operations in cue
### #File Inputs ### io.#File Inputs
_No input._ _No input._
### #File Outputs ### io.#File Outputs
_No output._ _No output._
## #ReadWriter ## io.#ReadWriter
Standard ReadWriter interface Standard ReadWriter interface
### #ReadWriter Inputs ### io.#ReadWriter Inputs
_No input._ _No input._
### #ReadWriter Outputs ### io.#ReadWriter Outputs
_No output._ _No output._
## #Reader ## io.#Reader
Standard Reader interface Standard Reader interface
### #Reader Inputs ### io.#Reader Inputs
_No input._ _No input._
### #Reader Outputs ### io.#Reader Outputs
_No output._ _No output._
## #Writer ## io.#Writer
Standard Writer interface Standard Writer interface
### #Writer Inputs ### io.#Writer Inputs
_No input._ _No input._
### #Writer Outputs ### io.#Writer Outputs
_No output._ _No output._

10
docs/reference/universe/js/yarn.md
View File

@ -6,11 +6,15 @@ sidebar_label: yarn
Yarn is a package manager for Javascript applications Yarn is a package manager for Javascript applications
## #Package ```cue
import "dagger.io/js/yarn"
```
## yarn.#Package
A Yarn package A Yarn package
### #Package Inputs ### yarn.#Package Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -23,7 +27,7 @@ A Yarn package
|*script* | `*"build" \| string` |Run this yarn script | |*script* | `*"build" \| string` |Run this yarn script |
|*args* | `*[] \| []` |Optional arguments for the script | |*args* | `*[] \| []` |Optional arguments for the script |
### #Package Outputs ### yarn.#Package Outputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |

16
docs/reference/universe/kubernetes/README.md
View File

@ -6,23 +6,27 @@ sidebar_label: kubernetes
Kubernetes client operations Kubernetes client operations
## #Kubectl ```cue
import "dagger.io/kubernetes"
```
## kubernetes.#Kubectl
Kubectl client Kubectl client
### #Kubectl Inputs ### kubernetes.#Kubectl Inputs
_No input._ _No input._
### #Kubectl Outputs ### kubernetes.#Kubectl Outputs
_No output._ _No output._
## #Resources ## kubernetes.#Resources
Apply Kubernetes resources Apply Kubernetes resources
### #Resources Inputs ### kubernetes.#Resources Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -30,6 +34,6 @@ Apply Kubernetes resources
|*version* | `*"v1.19.9" \| string` |Version of kubectl client | |*version* | `*"v1.19.9" \| string` |Version of kubectl client |
|*kubeconfig* | `dagger.#Secret` |Kube config file | |*kubeconfig* | `dagger.#Secret` |Kube config file |
### #Resources Outputs ### kubernetes.#Resources Outputs
_No output._ _No output._

10
docs/reference/universe/kubernetes/helm.md
View File

@ -6,11 +6,15 @@ sidebar_label: helm
Helm package manager Helm package manager
## #Chart ```cue
import "dagger.io/kubernetes/helm"
```
## helm.#Chart
Install a Helm chart Install a Helm chart
### #Chart Inputs ### helm.#Chart Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -24,6 +28,6 @@ Install a Helm chart
|*version* | `*"3.5.2" \| string` |Helm version | |*version* | `*"3.5.2" \| string` |Helm version |
|*kubectlVersion* | `*"v1.19.9" \| string` |Kubectl version | |*kubectlVersion* | `*"v1.19.9" \| string` |Kubectl version |
### #Chart Outputs ### helm.#Chart Outputs
_No output._ _No output._

16
docs/reference/universe/kubernetes/kustomize.md
View File

@ -6,23 +6,27 @@ sidebar_label: kustomize
Kustomize config management Kustomize config management
## #Kustomization ```cue
import "dagger.io/kubernetes/kustomize"
```
### #Kustomization Inputs ## kustomize.#Kustomization
### kustomize.#Kustomization Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
|*version* | `*"v3.8.7" \| string` |Kustomize binary version | |*version* | `*"v3.8.7" \| string` |Kustomize binary version |
### #Kustomization Outputs ### kustomize.#Kustomization Outputs
_No output._ _No output._
## #Kustomize ## kustomize.#Kustomize
Apply a Kubernetes Kustomize folder Apply a Kubernetes Kustomize folder
### #Kustomize Inputs ### kustomize.#Kustomize Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -30,6 +34,6 @@ Apply a Kubernetes Kustomize folder
|*kustomization* | `string` |Optional Kustomization file | |*kustomization* | `string` |Optional Kustomization file |
|*version* | `*"v3.8.7" \| string` |Kustomize binary version | |*version* | `*"v3.8.7" \| string` |Kustomize binary version |
### #Kustomize Outputs ### kustomize.#Kustomize Outputs
_No output._ _No output._

16
docs/reference/universe/netlify.md
View File

@ -6,26 +6,30 @@ sidebar_label: netlify
Netlify client operations Netlify client operations
## #Account ```cue
import "dagger.io/netlify"
```
## netlify.#Account
Netlify account credentials Netlify account credentials
### #Account Inputs ### netlify.#Account Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
|*name* | `*"" \| string` |Use this Netlify account name (also referred to as "team" in the Netlify docs) | |*name* | `*"" \| string` |Use this Netlify account name (also referred to as "team" in the Netlify docs) |
|*token* | `dagger.#Secret` |Netlify authentication token | |*token* | `dagger.#Secret` |Netlify authentication token |
### #Account Outputs ### netlify.#Account Outputs
_No output._ _No output._
## #Site ## netlify.#Site
Netlify site Netlify site
### #Site Inputs ### netlify.#Site Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -35,7 +39,7 @@ Netlify site
|*name* | `string` |Deploy to this Netlify site | |*name* | `string` |Deploy to this Netlify site |
|*create* | `*true \| bool` |Create the Netlify site if it doesn't exist? | |*create* | `*true \| bool` |Create the Netlify site if it doesn't exist? |
### #Site Outputs ### netlify.#Site Outputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |

28
docs/reference/universe/os.md
View File

@ -4,46 +4,50 @@ sidebar_label: os
# dagger.io/os # dagger.io/os
## #Container ```cue
import "dagger.io/os"
```
## os.#Container
Built-in container implementation, using buildkit Built-in container implementation, using buildkit
### #Container Inputs ### os.#Container Inputs
_No input._ _No input._
### #Container Outputs ### os.#Container Outputs
_No output._ _No output._
## #Dir ## os.#Dir
### #Dir Inputs ### os.#Dir Inputs
_No input._ _No input._
### #Dir Outputs ### os.#Dir Outputs
_No output._ _No output._
## #File ## os.#File
Built-in file implementation, using buildkit Built-in file implementation, using buildkit
### #File Inputs ### os.#File Inputs
_No input._ _No input._
### #File Outputs ### os.#File Outputs
_No output._ _No output._
## #ReadDir ## os.#ReadDir
### #ReadDir Inputs ### os.#ReadDir Inputs
_No input._ _No input._
### #ReadDir Outputs ### os.#ReadDir Outputs
_No output._ _No output._

10
docs/reference/universe/random.md
View File

@ -6,18 +6,22 @@ sidebar_label: random
Random generation utilities Random generation utilities
## #String ```cue
import "dagger.io/random"
```
## random.#String
Generate a random string Generate a random string
### #String Inputs ### random.#String Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
|*seed* | `string` |Seed of the random string to generate. When using the same `seed`, the same random string will be generated because of caching. | |*seed* | `string` |Seed of the random string to generate. When using the same `seed`, the same random string will be generated because of caching. |
|*length* | `*12 \| number` |length of the string | |*length* | `*12 \| number` |length of the string |
### #String Outputs ### random.#String Outputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |

10
docs/reference/universe/terraform.md
View File

@ -6,18 +6,22 @@ sidebar_label: terraform
Terraform operations Terraform operations
## #Configuration ```cue
import "dagger.io/terraform"
```
## terraform.#Configuration
Terraform configuration Terraform configuration
### #Configuration Inputs ### terraform.#Configuration Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
|*version* | `*"latest" \| string` |Terraform version | |*version* | `*"latest" \| string` |Terraform version |
|*source* | `dagger.#Artifact` |Source configuration | |*source* | `dagger.#Artifact` |Source configuration |
### #Configuration Outputs ### terraform.#Configuration Outputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |