Merge branch 'main' into cloudrun-support
This commit is contained in:
31
docs/reference/universe/README.md
Normal file
31
docs/reference/universe/README.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Index
|
||||
|
||||
- [alpine](./alpine.md) - Base package for Alpine Linux
|
||||
- [aws](./aws/README.md) - AWS base package
|
||||
- [aws/cloudformation](./aws/cloudformation.md) - AWS CloudFormation
|
||||
- [aws/ecr](./aws/ecr.md) - Amazon Elastic Container Registry (ECR)
|
||||
- [aws/ecs](./aws/ecs.md) - AWS Elastic Container Service (ECS)
|
||||
- [aws/eks](./aws/eks.md) - AWS Elastic Kubernetes Service (EKS)
|
||||
- [aws/elb](./aws/elb.md) - AWS Elastic Load Balancer (ELBv2)
|
||||
- [aws/rds](./aws/rds.md) - AWS Relational Database Service (RDS)
|
||||
- [aws/s3](./aws/s3.md) - AWS Simple Storage Service
|
||||
- [dagger](./dagger/README.md) - Dagger core types
|
||||
- [dagger/op](./dagger/op.md) - op: low-level operations for Dagger processing pipelines
|
||||
- [docker](./docker/README.md) - Docker container operations
|
||||
- [docker/compose](./docker/compose.md) - Docker-compose operations
|
||||
- [gcp](./gcp/README.md) - Google Cloud Platform
|
||||
- [gcp/gcr](./gcp/gcr.md) - Google Container Registry
|
||||
- [gcp/gcs](./gcp/gcs.md) - Google Cloud Storage
|
||||
- [gcp/gke](./gcp/gke.md) - Google Kubernetes Engine
|
||||
- [git](./git.md) - Git operations
|
||||
- [go](./go.md) - Go build operations
|
||||
- [io](./io.md) - IO operations
|
||||
- [java/maven](./java/maven.md) - Maven is a build automation tool for Java
|
||||
- [js/yarn](./js/yarn.md) - Yarn is a package manager for Javascript applications
|
||||
- [kubernetes](./kubernetes/README.md) - Kubernetes client operations
|
||||
- [kubernetes/helm](./kubernetes/helm.md) - Helm package manager
|
||||
- [kubernetes/kustomize](./kubernetes/kustomize.md) - Kustomize config management
|
||||
- [netlify](./netlify.md) - Netlify client operations
|
||||
- [os](./os.md) - OS operations
|
||||
- [random](./random.md) - Random generation utilities
|
||||
- [terraform](./terraform.md) - Terraform operations
|
@@ -2,12 +2,12 @@
|
||||
sidebar_label: alpine
|
||||
---
|
||||
|
||||
# dagger.io/alpine
|
||||
# alpha.dagger.io/alpine
|
||||
|
||||
Base package for Alpine Linux
|
||||
|
||||
```cue
|
||||
import "dagger.io/alpine"
|
||||
import "alpha.dagger.io/alpine"
|
||||
```
|
||||
|
||||
## alpine.#Image
|
||||
|
@@ -2,12 +2,12 @@
|
||||
sidebar_label: aws
|
||||
---
|
||||
|
||||
# dagger.io/aws
|
||||
# alpha.dagger.io/aws
|
||||
|
||||
AWS base package
|
||||
|
||||
```cue
|
||||
import "dagger.io/aws"
|
||||
import "alpha.dagger.io/aws"
|
||||
```
|
||||
|
||||
## aws.#CLI
|
||||
|
@@ -2,12 +2,12 @@
|
||||
sidebar_label: cloudformation
|
||||
---
|
||||
|
||||
# dagger.io/aws/cloudformation
|
||||
# alpha.dagger.io/aws/cloudformation
|
||||
|
||||
AWS CloudFormation
|
||||
|
||||
```cue
|
||||
import "dagger.io/aws/cloudformation"
|
||||
import "alpha.dagger.io/aws/cloudformation"
|
||||
```
|
||||
|
||||
## cloudformation.#Stack
|
||||
@@ -30,6 +30,4 @@ AWS CloudFormation Stack
|
||||
|
||||
### cloudformation.#Stack Outputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*outputs* | `struct` |- |
|
||||
_No output._
|
||||
|
@@ -2,12 +2,12 @@
|
||||
sidebar_label: ecr
|
||||
---
|
||||
|
||||
# dagger.io/aws/ecr
|
||||
# alpha.dagger.io/aws/ecr
|
||||
|
||||
Amazon Elastic Container Registry (ECR)
|
||||
|
||||
```cue
|
||||
import "dagger.io/aws/ecr"
|
||||
import "alpha.dagger.io/aws/ecr"
|
||||
```
|
||||
|
||||
## ecr.#Credentials
|
||||
|
@@ -2,10 +2,10 @@
|
||||
sidebar_label: ecs
|
||||
---
|
||||
|
||||
# dagger.io/aws/ecs
|
||||
# alpha.dagger.io/aws/ecs
|
||||
|
||||
AWS Elastic Container Service (ECS)
|
||||
|
||||
```cue
|
||||
import "dagger.io/aws/ecs"
|
||||
import "alpha.dagger.io/aws/ecs"
|
||||
```
|
||||
|
@@ -2,12 +2,12 @@
|
||||
sidebar_label: eks
|
||||
---
|
||||
|
||||
# dagger.io/aws/eks
|
||||
# alpha.dagger.io/aws/eks
|
||||
|
||||
AWS Elastic Kubernetes Service (EKS)
|
||||
|
||||
```cue
|
||||
import "dagger.io/aws/eks"
|
||||
import "alpha.dagger.io/aws/eks"
|
||||
```
|
||||
|
||||
## eks.#KubeConfig
|
||||
|
@@ -2,12 +2,12 @@
|
||||
sidebar_label: elb
|
||||
---
|
||||
|
||||
# dagger.io/aws/elb
|
||||
# alpha.dagger.io/aws/elb
|
||||
|
||||
AWS Elastic Load Balancer (ELBv2)
|
||||
|
||||
```cue
|
||||
import "dagger.io/aws/elb"
|
||||
import "alpha.dagger.io/aws/elb"
|
||||
```
|
||||
|
||||
## elb.#RandomRulePriority
|
||||
|
@@ -2,12 +2,12 @@
|
||||
sidebar_label: rds
|
||||
---
|
||||
|
||||
# dagger.io/aws/rds
|
||||
# alpha.dagger.io/aws/rds
|
||||
|
||||
AWS Relational Database Service (RDS)
|
||||
|
||||
```cue
|
||||
import "dagger.io/aws/rds"
|
||||
import "alpha.dagger.io/aws/rds"
|
||||
```
|
||||
|
||||
## rds.#Database
|
||||
|
@@ -2,12 +2,12 @@
|
||||
sidebar_label: s3
|
||||
---
|
||||
|
||||
# dagger.io/aws/s3
|
||||
# alpha.dagger.io/aws/s3
|
||||
|
||||
AWS Simple Storage Service
|
||||
|
||||
```cue
|
||||
import "dagger.io/aws/s3"
|
||||
import "alpha.dagger.io/aws/s3"
|
||||
```
|
||||
|
||||
## s3.#Object
|
||||
|
@@ -2,10 +2,12 @@
|
||||
sidebar_label: dagger
|
||||
---
|
||||
|
||||
# dagger.io/dagger
|
||||
# alpha.dagger.io/dagger
|
||||
|
||||
Dagger core types
|
||||
|
||||
```cue
|
||||
import "dagger.io/dagger"
|
||||
import "alpha.dagger.io/dagger"
|
||||
```
|
||||
|
||||
## dagger.#Secret
|
||||
|
@@ -2,12 +2,12 @@
|
||||
sidebar_label: op
|
||||
---
|
||||
|
||||
# dagger.io/dagger/op
|
||||
# alpha.dagger.io/dagger/op
|
||||
|
||||
op: low-level operations for Dagger processing pipelines
|
||||
|
||||
```cue
|
||||
import "dagger.io/dagger/op"
|
||||
import "alpha.dagger.io/dagger/op"
|
||||
```
|
||||
|
||||
## op.#Copy
|
||||
|
@@ -2,12 +2,12 @@
|
||||
sidebar_label: docker
|
||||
---
|
||||
|
||||
# dagger.io/docker
|
||||
# alpha.dagger.io/docker
|
||||
|
||||
Docker container operations
|
||||
|
||||
```cue
|
||||
import "dagger.io/docker"
|
||||
import "alpha.dagger.io/docker"
|
||||
```
|
||||
|
||||
## docker.#Build
|
||||
@@ -33,6 +33,7 @@ A container image that can run any docker command
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*command* | `string` |Command to execute |
|
||||
|*registries* | `[]` |Image registries |
|
||||
|
||||
### docker.#Command Outputs
|
||||
|
||||
@@ -99,6 +100,7 @@ _No output._
|
||||
|*run.ssh.key* | `dagger.#Secret` |private key |
|
||||
|*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.registries* | `[]` |Image registries |
|
||||
|
||||
### docker.#Run Outputs
|
||||
|
40
docs/reference/universe/docker/compose.md
Normal file
40
docs/reference/universe/docker/compose.md
Normal file
@@ -0,0 +1,40 @@
|
||||
---
|
||||
sidebar_label: compose
|
||||
---
|
||||
|
||||
# alpha.dagger.io/docker/compose
|
||||
|
||||
Docker-compose operations
|
||||
|
||||
```cue
|
||||
import "alpha.dagger.io/docker/compose"
|
||||
```
|
||||
|
||||
## compose.#App
|
||||
|
||||
### compose.#App Inputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*name* | `*"source" \| string` |App name (use as COMPOSE_PROJECT_NAME) |
|
||||
|*registries* | `[]` |Image registries |
|
||||
|*run.command* | `"""\n if [ -n "$DOCKER_HOSTNAME" ]; then\n \tssh -i /key -fNT -o "StreamLocalBindUnlink=yes" -L "$(pwd)"/docker.sock:/var/run/docker.sock -p "$DOCKER_PORT" "$DOCKER_USERNAME"@"$DOCKER_HOSTNAME"\n \texport DOCKER_HOST="unix://$(pwd)/docker.sock"\n fi\n \n # Extend session duration\n echo "Host *\\nServerAliveInterval 240" \>\> "$HOME"/.ssh/config\n chmod 600 "$HOME"/.ssh/config\n \n # Move compose\n if [ -d "$SOURCE_DIR" ]; then\n \tif [ -f docker-compose.yaml ]; then\n \t\tcp docker-compose.yaml "$SOURCE_DIR"/docker-compose.yaml\n \tfi\n \tcd "$SOURCE_DIR"\n fi\n \n docker-compose build\n docker-compose up -d\n """` |Command to execute |
|
||||
|*run.env.COMPOSE_PROJECT_NAME* | `*"source" \| string` |- |
|
||||
|*run.package."docker-compose"* | `true` |- |
|
||||
|*run.registries* | `[]` |Image registries |
|
||||
|
||||
### compose.#App Outputs
|
||||
|
||||
_No output._
|
||||
|
||||
## compose.#Client
|
||||
|
||||
A container image to run the docker-compose client
|
||||
|
||||
### compose.#Client Inputs
|
||||
|
||||
_No input._
|
||||
|
||||
### compose.#Client Outputs
|
||||
|
||||
_No output._
|
@@ -1,84 +0,0 @@
|
||||
---
|
||||
sidebar_label: file
|
||||
---
|
||||
|
||||
# dagger.io/file
|
||||
|
||||
DEPRECATED: see dagger.io/os
|
||||
|
||||
## #Append
|
||||
|
||||
### #Append Inputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*filename* | `string` |- |
|
||||
|*permissions* | `*0o644 \| int` |- |
|
||||
|*contents* | `(string\|bytes)` |- |
|
||||
|*from* | `dagger.#Artifact` |- |
|
||||
|
||||
### #Append Outputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*orig* | `string` |- |
|
||||
|
||||
## #Create
|
||||
|
||||
### #Create Inputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*filename* | `string` |- |
|
||||
|*permissions* | `*0o644 \| int` |- |
|
||||
|*contents* | `(string\|bytes)` |- |
|
||||
|
||||
### #Create Outputs
|
||||
|
||||
_No output._
|
||||
|
||||
## #Glob
|
||||
|
||||
### #Glob Inputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*glob* | `string` |- |
|
||||
|*from* | `dagger.#Artifact` |- |
|
||||
|
||||
### #Glob Outputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*filenames* | `_\|_` |trim suffix because ls always ends with newline |
|
||||
|*files* | `string` |- |
|
||||
|
||||
## #Read
|
||||
|
||||
### #Read Inputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*filename* | `string` |- |
|
||||
|*from* | `dagger.#Artifact` |- |
|
||||
|
||||
### #Read Outputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*contents* | `string` |- |
|
||||
|
||||
## #read
|
||||
|
||||
### #read Inputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*path* | `string` |- |
|
||||
|*from* | `dagger.#Artifact` |- |
|
||||
|
||||
### #read Outputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*data* | `string` |- |
|
@@ -2,12 +2,12 @@
|
||||
sidebar_label: gcp
|
||||
---
|
||||
|
||||
# dagger.io/gcp
|
||||
# alpha.dagger.io/gcp
|
||||
|
||||
Google Cloud Platform
|
||||
|
||||
```cue
|
||||
import "dagger.io/gcp"
|
||||
import "alpha.dagger.io/gcp"
|
||||
```
|
||||
|
||||
## gcp.#Config
|
||||
|
@@ -2,12 +2,12 @@
|
||||
sidebar_label: gcr
|
||||
---
|
||||
|
||||
# dagger.io/gcp/gcr
|
||||
# alpha.dagger.io/gcp/gcr
|
||||
|
||||
Google Container Registry
|
||||
|
||||
```cue
|
||||
import "dagger.io/gcp/gcr"
|
||||
import "alpha.dagger.io/gcp/gcr"
|
||||
```
|
||||
|
||||
## gcr.#Credentials
|
||||
|
34
docs/reference/universe/gcp/gcs.md
Normal file
34
docs/reference/universe/gcp/gcs.md
Normal file
@@ -0,0 +1,34 @@
|
||||
---
|
||||
sidebar_label: gcs
|
||||
---
|
||||
|
||||
# alpha.dagger.io/gcp/gcs
|
||||
|
||||
Google Cloud Storage
|
||||
|
||||
```cue
|
||||
import "alpha.dagger.io/gcp/gcs"
|
||||
```
|
||||
|
||||
## gcs.#Object
|
||||
|
||||
GCS Bucket object(s) sync
|
||||
|
||||
### gcs.#Object Inputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*config.region* | `string` |GCP region |
|
||||
|*config.project* | `string` |GCP project |
|
||||
|*config.serviceKey* | `dagger.#Secret` |GCP service key |
|
||||
|*source* | `dagger.#Artifact` |Source Artifact to upload to GCS |
|
||||
|*target* | `string` |Target GCS URL (eg. gs://\<bucket-name\>/\<path\>/\<sub-path\>) |
|
||||
|*delete* | `*false \| true` |Delete files that already exist on remote destination |
|
||||
|*contentType* | `*"" \| string` |Object content type |
|
||||
|*always* | `*true \| false` |Always write the object to GCS |
|
||||
|
||||
### gcs.#Object Outputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*url* | `string` |URL of the uploaded GCS object |
|
@@ -2,12 +2,12 @@
|
||||
sidebar_label: gke
|
||||
---
|
||||
|
||||
# dagger.io/gcp/gke
|
||||
# alpha.dagger.io/gcp/gke
|
||||
|
||||
Google Kubernetes Engine
|
||||
|
||||
```cue
|
||||
import "dagger.io/gcp/gke"
|
||||
import "alpha.dagger.io/gcp/gke"
|
||||
```
|
||||
|
||||
## gke.#KubeConfig
|
||||
|
@@ -2,12 +2,12 @@
|
||||
sidebar_label: git
|
||||
---
|
||||
|
||||
# dagger.io/git
|
||||
# alpha.dagger.io/git
|
||||
|
||||
Git operations
|
||||
|
||||
```cue
|
||||
import "dagger.io/git"
|
||||
import "alpha.dagger.io/git"
|
||||
```
|
||||
|
||||
## git.#CurrentBranch
|
||||
|
@@ -2,12 +2,12 @@
|
||||
sidebar_label: go
|
||||
---
|
||||
|
||||
# dagger.io/go
|
||||
# alpha.dagger.io/go
|
||||
|
||||
Go build operations
|
||||
|
||||
```cue
|
||||
import "dagger.io/go"
|
||||
import "alpha.dagger.io/go"
|
||||
```
|
||||
|
||||
## go.#Build
|
||||
|
@@ -2,12 +2,12 @@
|
||||
sidebar_label: io
|
||||
---
|
||||
|
||||
# dagger.io/io
|
||||
# alpha.dagger.io/io
|
||||
|
||||
IO operations
|
||||
|
||||
```cue
|
||||
import "dagger.io/io"
|
||||
import "alpha.dagger.io/io"
|
||||
```
|
||||
|
||||
## io.#Dir
|
||||
|
32
docs/reference/universe/java/maven.md
Normal file
32
docs/reference/universe/java/maven.md
Normal file
@@ -0,0 +1,32 @@
|
||||
---
|
||||
sidebar_label: maven
|
||||
---
|
||||
|
||||
# alpha.dagger.io/java/maven
|
||||
|
||||
Maven is a build automation tool for Java
|
||||
|
||||
```cue
|
||||
import "alpha.dagger.io/java/maven"
|
||||
```
|
||||
|
||||
## maven.#Project
|
||||
|
||||
A Maven project
|
||||
|
||||
### maven.#Project Inputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*source* | `dagger.#Artifact` |Application source code |
|
||||
|*package* | `struct` |Extra alpine packages to install |
|
||||
|*env* | `struct` |Environment variables |
|
||||
|*phases* | `*["package"] \| []` |- |
|
||||
|*goals* | `*[] \| []` |- |
|
||||
|*args* | `*[] \| []` |Optional arguments for the script |
|
||||
|
||||
### maven.#Project Outputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*build* | `struct` |Build output directory |
|
@@ -2,12 +2,12 @@
|
||||
sidebar_label: yarn
|
||||
---
|
||||
|
||||
# dagger.io/js/yarn
|
||||
# alpha.dagger.io/js/yarn
|
||||
|
||||
Yarn is a package manager for Javascript applications
|
||||
|
||||
```cue
|
||||
import "dagger.io/js/yarn"
|
||||
import "alpha.dagger.io/js/yarn"
|
||||
```
|
||||
|
||||
## yarn.#Package
|
||||
|
@@ -2,12 +2,12 @@
|
||||
sidebar_label: kubernetes
|
||||
---
|
||||
|
||||
# dagger.io/kubernetes
|
||||
# alpha.dagger.io/kubernetes
|
||||
|
||||
Kubernetes client operations
|
||||
|
||||
```cue
|
||||
import "dagger.io/kubernetes"
|
||||
import "alpha.dagger.io/kubernetes"
|
||||
```
|
||||
|
||||
## kubernetes.#Kubectl
|
||||
|
@@ -2,12 +2,12 @@
|
||||
sidebar_label: helm
|
||||
---
|
||||
|
||||
# dagger.io/kubernetes/helm
|
||||
# alpha.dagger.io/kubernetes/helm
|
||||
|
||||
Helm package manager
|
||||
|
||||
```cue
|
||||
import "dagger.io/kubernetes/helm"
|
||||
import "alpha.dagger.io/kubernetes/helm"
|
||||
```
|
||||
|
||||
## helm.#Chart
|
||||
|
@@ -2,12 +2,12 @@
|
||||
sidebar_label: kustomize
|
||||
---
|
||||
|
||||
# dagger.io/kubernetes/kustomize
|
||||
# alpha.dagger.io/kubernetes/kustomize
|
||||
|
||||
Kustomize config management
|
||||
|
||||
```cue
|
||||
import "dagger.io/kubernetes/kustomize"
|
||||
import "alpha.dagger.io/kubernetes/kustomize"
|
||||
```
|
||||
|
||||
## kustomize.#Kustomization
|
||||
|
@@ -2,12 +2,12 @@
|
||||
sidebar_label: netlify
|
||||
---
|
||||
|
||||
# dagger.io/netlify
|
||||
# alpha.dagger.io/netlify
|
||||
|
||||
Netlify client operations
|
||||
|
||||
```cue
|
||||
import "dagger.io/netlify"
|
||||
import "alpha.dagger.io/netlify"
|
||||
```
|
||||
|
||||
## netlify.#Account
|
||||
|
@@ -2,10 +2,12 @@
|
||||
sidebar_label: os
|
||||
---
|
||||
|
||||
# dagger.io/os
|
||||
# alpha.dagger.io/os
|
||||
|
||||
OS operations
|
||||
|
||||
```cue
|
||||
import "dagger.io/os"
|
||||
import "alpha.dagger.io/os"
|
||||
```
|
||||
|
||||
## os.#Container
|
||||
@@ -32,7 +34,7 @@ _No output._
|
||||
|
||||
## os.#File
|
||||
|
||||
Built-in file implementation, using buildkit
|
||||
Built-in file implementation, using buildkit A single file
|
||||
|
||||
### os.#File Inputs
|
||||
|
||||
|
@@ -2,12 +2,12 @@
|
||||
sidebar_label: random
|
||||
---
|
||||
|
||||
# dagger.io/random
|
||||
# alpha.dagger.io/random
|
||||
|
||||
Random generation utilities
|
||||
|
||||
```cue
|
||||
import "dagger.io/random"
|
||||
import "alpha.dagger.io/random"
|
||||
```
|
||||
|
||||
## random.#String
|
||||
|
@@ -2,12 +2,12 @@
|
||||
sidebar_label: terraform
|
||||
---
|
||||
|
||||
# dagger.io/terraform
|
||||
# alpha.dagger.io/terraform
|
||||
|
||||
Terraform operations
|
||||
|
||||
```cue
|
||||
import "dagger.io/terraform"
|
||||
import "alpha.dagger.io/terraform"
|
||||
```
|
||||
|
||||
## terraform.#Configuration
|
||||
|
Reference in New Issue
Block a user