diff --git a/docs/reference/universe/alpine.md b/docs/reference/universe/alpine.md index a517876e..d500a881 100644 --- a/docs/reference/universe/alpine.md +++ b/docs/reference/universe/alpine.md @@ -4,8 +4,12 @@ sidebar_label: alpine # dagger.io/alpine +Base package for Alpine Linux + ## #Image +Base image for Alpine Linux + ### #Image Inputs _No input._ diff --git a/docs/reference/universe/aws/README.md b/docs/reference/universe/aws/README.md index 09b49682..a3e918b4 100644 --- a/docs/reference/universe/aws/README.md +++ b/docs/reference/universe/aws/README.md @@ -4,6 +4,8 @@ sidebar_label: aws # dagger.io/aws +AWS base package + ## #CLI Re-usable aws-cli component @@ -22,7 +24,7 @@ _No output._ ## #Config -Base AWS Config +AWS Config shared by all AWS packages ### #Config Inputs diff --git a/docs/reference/universe/aws/cloudformation.md b/docs/reference/universe/aws/cloudformation.md index c448310e..38cf4d24 100644 --- a/docs/reference/universe/aws/cloudformation.md +++ b/docs/reference/universe/aws/cloudformation.md @@ -4,6 +4,8 @@ sidebar_label: cloudformation # dagger.io/aws/cloudformation +AWS Cloud Formation + ## #Stack AWS CloudFormation Stack diff --git a/docs/reference/universe/aws/ecr.md b/docs/reference/universe/aws/ecr.md index 4bb7d777..0abf3ad4 100644 --- a/docs/reference/universe/aws/ecr.md +++ b/docs/reference/universe/aws/ecr.md @@ -4,6 +4,8 @@ sidebar_label: ecr # dagger.io/aws/ecr +Amazon Elastic Container Registry (ECR) + ## #Credentials Convert AWS credentials to Docker Registry credentials for ECR diff --git a/docs/reference/universe/aws/ecs.md b/docs/reference/universe/aws/ecs.md index 89716b3f..c300297c 100644 --- a/docs/reference/universe/aws/ecs.md +++ b/docs/reference/universe/aws/ecs.md @@ -3,3 +3,5 @@ sidebar_label: ecs --- # dagger.io/aws/ecs + +AWS Elastic Container Service (ECS) diff --git a/docs/reference/universe/aws/eks.md b/docs/reference/universe/aws/eks.md index 458f527d..8b1abbad 100644 --- a/docs/reference/universe/aws/eks.md +++ b/docs/reference/universe/aws/eks.md @@ -4,6 +4,8 @@ sidebar_label: eks # dagger.io/aws/eks +AWS Elastic Kubernetes Service (EKS) + ## #KubeConfig KubeConfig config outputs a valid kube-auth-config for kubectl client diff --git a/docs/reference/universe/aws/elb.md b/docs/reference/universe/aws/elb.md index 78ce0178..79bcf381 100644 --- a/docs/reference/universe/aws/elb.md +++ b/docs/reference/universe/aws/elb.md @@ -4,9 +4,11 @@ sidebar_label: elb # dagger.io/aws/elb +AWS Elastic Load Balancer (ELBv2) + ## #RandomRulePriority -Returns a non-taken rule priority (randomized) +Returns an unused rule priority (randomized in available range) ### #RandomRulePriority Inputs diff --git a/docs/reference/universe/aws/rds.md b/docs/reference/universe/aws/rds.md index 2fc1603e..334b4f64 100644 --- a/docs/reference/universe/aws/rds.md +++ b/docs/reference/universe/aws/rds.md @@ -4,19 +4,23 @@ sidebar_label: rds # dagger.io/aws/rds +AWS Relational Database Service (RDS) + ## #CreateDB +Creates a new Database on an existing RDS Instance + ### #CreateDB Inputs -| Name | Type | Description | -| ------------- |:-------------: |:-------------: | -|*config.region* | `string` |AWS region | -|*config.accessKey* | `dagger.#Secret` |AWS access key | -|*config.secretKey* | `dagger.#Secret` |AWS secret key | -|*name* | `string` |DB name | -|*dbArn* | `string` |ARN of the database instance | -|*secretArn* | `string` |ARN of the database secret (for connecting via rds api) | -|*dbType* | `string` |- | +| Name | Type | Description | +| ------------- |:-------------: |:-------------: | +|*config.region* | `string` |AWS region | +|*config.accessKey* | `dagger.#Secret` |AWS access key | +|*config.secretKey* | `dagger.#Secret` |AWS secret key | +|*name* | `string` |DB name | +|*dbArn* | `string` |ARN of the database instance | +|*secretArn* | `string` |ARN of the database secret (for connecting via rds api) | +|*dbType* | `string` |Database type MySQL or PostgreSQL (Aurora Serverless only) | ### #CreateDB Outputs @@ -26,19 +30,21 @@ sidebar_label: rds ## #CreateUser +Creates a new user credentials on an existing RDS Instance + ### #CreateUser Inputs -| Name | Type | Description | -| ------------- |:-------------: |:-------------: | -|*config.region* | `string` |AWS region | -|*config.accessKey* | `dagger.#Secret` |AWS access key | -|*config.secretKey* | `dagger.#Secret` |AWS secret key | -|*username* | `string` |Username | -|*password* | `string` |Password | -|*dbArn* | `string` |ARN of the database instance | -|*secretArn* | `string` |ARN of the database secret (for connecting via rds api) | -|*grantDatabase* | `*"" \| string` |- | -|*dbType* | `string` |- | +| Name | Type | Description | +| ------------- |:-------------: |:-------------: | +|*config.region* | `string` |AWS region | +|*config.accessKey* | `dagger.#Secret` |AWS access key | +|*config.secretKey* | `dagger.#Secret` |AWS secret key | +|*username* | `string` |Username | +|*password* | `string` |Password | +|*dbArn* | `string` |ARN of the database instance | +|*secretArn* | `string` |ARN of the database secret (for connecting via rds api) | +|*grantDatabase* | `*"" \| string` |Name of the database to grants access to | +|*dbType* | `string` |Database type MySQL or PostgreSQL (Aurora Serverless only) | ### #CreateUser Outputs @@ -48,6 +54,8 @@ sidebar_label: rds ## #Instance +Fetches information on an existing RDS Instance + ### #Instance Inputs | Name | Type | Description | diff --git a/docs/reference/universe/aws/s3.md b/docs/reference/universe/aws/s3.md index c57b17ed..2882e13e 100644 --- a/docs/reference/universe/aws/s3.md +++ b/docs/reference/universe/aws/s3.md @@ -4,9 +4,11 @@ sidebar_label: s3 # dagger.io/aws/s3 +AWS Simple Storage Service + ## #Put -S3 file or Directory upload +S3 Bucket upload (file or directory) ### #Put Inputs @@ -27,7 +29,7 @@ S3 file or Directory upload ## #Sync -S3 Sync +S3 Bucket sync ### #Sync Inputs diff --git a/docs/reference/universe/docker.md b/docs/reference/universe/docker.md index 2b1cd51b..ff80f48c 100644 --- a/docs/reference/universe/docker.md +++ b/docs/reference/universe/docker.md @@ -4,6 +4,8 @@ sidebar_label: docker # dagger.io/docker +Docker container operations + ## #Build Build a Docker image from source, using included Dockerfile @@ -38,10 +40,10 @@ Build a Docker image from the provided Dockerfile contents ### #ImageFromDockerfile Inputs -| Name | Type | Description | -| ------------- |:-------------: |:-------------: | -|*dockerfile* | `string` |- | -|*context* | `dagger.#Artifact` |- | +| Name | Type | Description | +| ------------- |:-------------: |:-------------: | +|*dockerfile* | `string` |Dockerfile passed as a string | +|*context* | `dagger.#Artifact` |Build context | ### #ImageFromDockerfile Outputs diff --git a/docs/reference/universe/gcp/README.md b/docs/reference/universe/gcp/README.md index 09183ef1..04e975be 100644 --- a/docs/reference/universe/gcp/README.md +++ b/docs/reference/universe/gcp/README.md @@ -4,6 +4,8 @@ sidebar_label: gcp # dagger.io/gcp +Google Cloud Platform + ## #Config Base Google Cloud Config diff --git a/docs/reference/universe/gcp/gcr.md b/docs/reference/universe/gcp/gcr.md index 737b2c23..883d9e14 100644 --- a/docs/reference/universe/gcp/gcr.md +++ b/docs/reference/universe/gcp/gcr.md @@ -4,6 +4,8 @@ sidebar_label: gcr # dagger.io/gcp/gcr +Google Container Registry + ## #Credentials Credentials retriever for GCR diff --git a/docs/reference/universe/gcp/gke.md b/docs/reference/universe/gcp/gke.md index edb4b5e8..a7b87641 100644 --- a/docs/reference/universe/gcp/gke.md +++ b/docs/reference/universe/gcp/gke.md @@ -4,6 +4,8 @@ sidebar_label: gke # dagger.io/gcp/gke +Google Kubernetes Engine + ## #KubeConfig KubeConfig config outputs a valid kube-auth-config for kubectl client diff --git a/docs/reference/universe/git.md b/docs/reference/universe/git.md index b390e0d7..68f62324 100644 --- a/docs/reference/universe/git.md +++ b/docs/reference/universe/git.md @@ -4,6 +4,8 @@ sidebar_label: git # dagger.io/git +Git operations + ## #CurrentBranch Get the name of the current checked out branch or tag @@ -12,13 +14,13 @@ Get the name of the current checked out branch or tag | Name | Type | Description | | ------------- |:-------------: |:-------------: | -|*repository* | `dagger.#Artifact` |- | +|*repository* | `dagger.#Artifact` |Git repository | ### #CurrentBranch Outputs | Name | Type | Description | | ------------- |:-------------: |:-------------: | -|*name* | `string` |- | +|*name* | `string` |Git branch name | ## #Repository @@ -44,10 +46,10 @@ List tags of a repository | Name | Type | Description | | ------------- |:-------------: |:-------------: | -|*repository* | `dagger.#Artifact` |- | +|*repository* | `dagger.#Artifact` |Git repository | ### #Tags Outputs | Name | Type | Description | | ------------- |:-------------: |:-------------: | -|*tags* | `[]` |- | +|*tags* | `[]` |Repository tags | diff --git a/docs/reference/universe/go.md b/docs/reference/universe/go.md index f128366e..dc0458c9 100644 --- a/docs/reference/universe/go.md +++ b/docs/reference/universe/go.md @@ -4,8 +4,12 @@ sidebar_label: go # dagger.io/go +Go build operations + ## #Build +Go application builder + ### #Build Inputs | Name | Type | Description | @@ -33,7 +37,7 @@ A standalone go environment | Name | Type | Description | | ------------- |:-------------: |:-------------: | |*version* | `*"1.16" \| string` |Go version to use | -|*source* | `dagger.#Artifact` |- | +|*source* | `dagger.#Artifact` |Source code | |*image.from* | `"docker.io/golang:1.16-alpine"` |Remote ref (example: "index.docker.io/alpine:latest") | ### #Container Outputs @@ -42,6 +46,8 @@ _No output._ ## #Go +Re-usable component for the Go compiler + ### #Go Inputs | Name | Type | Description | diff --git a/docs/reference/universe/io.md b/docs/reference/universe/io.md index 6e66b9b3..e6a07530 100644 --- a/docs/reference/universe/io.md +++ b/docs/reference/universe/io.md @@ -4,6 +4,8 @@ sidebar_label: io # dagger.io/io +IO operations + ## #Dir Standard interface for directory operations in cue @@ -30,6 +32,8 @@ _No output._ ## #ReadWriter +Standard ReadWriter interface + ### #ReadWriter Inputs _No input._ @@ -40,6 +44,8 @@ _No output._ ## #Reader +Standard Reader interface + ### #Reader Inputs _No input._ @@ -50,6 +56,8 @@ _No output._ ## #Writer +Standard Writer interface + ### #Writer Inputs _No input._ diff --git a/docs/reference/universe/js/yarn.md b/docs/reference/universe/js/yarn.md index 913fcd7e..a78e7db8 100644 --- a/docs/reference/universe/js/yarn.md +++ b/docs/reference/universe/js/yarn.md @@ -8,23 +8,23 @@ Yarn is a package manager for Javascript applications ## #Package -A Yarn package. +A Yarn package ### #Package Inputs -| Name | Type | Description | -| ------------- |:-------------: |:-------------: | -|*source* | `dagger.#Artifact` |Application source code | -|*package* | `struct` |Extra alpine packages to install | -|*cwd* | `*"." \| string` |working directory to use | -|*env* | `struct` |Environment variables | -|*writeEnvFile* | `*"" \| string` |Write the contents of `environment` to this file, in the "envfile" format. | -|*buildDir* | `*"build" \| string` |Read build output from this directory (path must be relative to working directory). | -|*script* | `*"build" \| string` |Run this yarn script | -|*args* | `*[] \| []` |Optional arguments for the script | +| Name | Type | Description | +| ------------- |:-------------: |:-------------: | +|*source* | `dagger.#Artifact` |Application source code | +|*package* | `struct` |Extra alpine packages to install | +|*cwd* | `*"." \| string` |working directory to use | +|*env* | `struct` |Environment variables | +|*writeEnvFile* | `*"" \| string` |Write the contents of `environment` to this file, in the "envfile" format | +|*buildDir* | `*"build" \| string` |Read build output from this directory (path must be relative to working directory) | +|*script* | `*"build" \| string` |Run this yarn script | +|*args* | `*[] \| []` |Optional arguments for the script | ### #Package Outputs -| Name | Type | Description | -| ------------- |:-------------: |:-------------: | -|*build* | `struct` |- | +| Name | Type | Description | +| ------------- |:-------------: |:-------------: | +|*build* | `struct` |Build output directory | diff --git a/docs/reference/universe/kubernetes/README.md b/docs/reference/universe/kubernetes/README.md index 53365ef7..107475fa 100644 --- a/docs/reference/universe/kubernetes/README.md +++ b/docs/reference/universe/kubernetes/README.md @@ -4,8 +4,12 @@ sidebar_label: kubernetes # dagger.io/kubernetes +Kubernetes client operations + ## #Kubectl +Kubectl client + ### #Kubectl Inputs _No input._ diff --git a/docs/reference/universe/kubernetes/kustomize.md b/docs/reference/universe/kubernetes/kustomize.md index 739bfa99..cd54225b 100644 --- a/docs/reference/universe/kubernetes/kustomize.md +++ b/docs/reference/universe/kubernetes/kustomize.md @@ -4,6 +4,8 @@ sidebar_label: kustomize # dagger.io/kubernetes/kustomize +Kustomize config management + ## #Kustomization ### #Kustomization Inputs diff --git a/docs/reference/universe/netlify.md b/docs/reference/universe/netlify.md index 6b689ef1..7af16c3b 100644 --- a/docs/reference/universe/netlify.md +++ b/docs/reference/universe/netlify.md @@ -4,9 +4,11 @@ sidebar_label: netlify # dagger.io/netlify +Netlify client operations + ## #Account -A Netlify account +Netlify account credentials ### #Account Inputs @@ -21,7 +23,7 @@ _No output._ ## #Site -A Netlify site +Netlify site ### #Site Inputs diff --git a/docs/reference/universe/random.md b/docs/reference/universe/random.md index 4a75dfe0..1aa830d0 100644 --- a/docs/reference/universe/random.md +++ b/docs/reference/universe/random.md @@ -4,16 +4,7 @@ sidebar_label: random # dagger.io/random -Random generation utilities. - -Example: - -```cue -str: random.#String & { - seed: "str" - length: 10 -} -``` +Random generation utilities ## #String diff --git a/docs/reference/universe/terraform.md b/docs/reference/universe/terraform.md index 2b7f39c8..2fa3f900 100644 --- a/docs/reference/universe/terraform.md +++ b/docs/reference/universe/terraform.md @@ -4,14 +4,18 @@ sidebar_label: terraform # dagger.io/terraform +Terraform operations + ## #Configuration +Terraform configuration + ### #Configuration Inputs -| Name | Type | Description | -| ------------- |:-------------: |:-------------: | -|*version* | `*"latest" \| string` |- | -|*source* | `dagger.#Artifact` |- | +| Name | Type | Description | +| ------------- |:-------------: |:-------------: | +|*version* | `*"latest" \| string` |Terraform version | +|*source* | `dagger.#Artifact` |Source configuration | ### #Configuration Outputs