From 9281967e16cbc09ddad9887003efbe83161759e6 Mon Sep 17 00:00:00 2001 From: Sam Alba Date: Tue, 15 Jun 2021 10:46:56 +0200 Subject: [PATCH 1/3] stdlib: added package doc strings Signed-off-by: Sam Alba --- stdlib/alpine/alpine.cue | 2 ++ stdlib/aws/aws.cue | 3 ++- stdlib/aws/cloudformation/cloudformation.cue | 1 + stdlib/aws/ecr/ecr.cue | 1 + stdlib/aws/ecs/run-task.cue | 3 ++- stdlib/aws/eks/eks.cue | 1 + stdlib/aws/elb/elb.cue | 3 ++- stdlib/aws/rds/rds.cue | 7 +++++++ stdlib/aws/s3/s3.cue | 5 +++-- stdlib/dagger/dagger.cue | 1 - stdlib/docker/docker.cue | 4 ++++ stdlib/gcp/gcp.cue | 1 + stdlib/gcp/gcr/gcr.cue | 1 + stdlib/gcp/gke/gke.cue | 1 + stdlib/git/git.cue | 9 +++++++++ stdlib/go/go.cue | 7 +++++++ stdlib/io/io.cue | 4 ++++ stdlib/js/yarn/yarn.cue | 7 ++++--- stdlib/kubernetes/kubernetes.cue | 3 +++ stdlib/kubernetes/kustomize/kustomization.cue | 1 + stdlib/netlify/netlify.cue | 5 +++-- stdlib/random/string.cue | 14 +------------- stdlib/terraform/terraform.cue | 6 ++++++ 23 files changed, 66 insertions(+), 24 deletions(-) diff --git a/stdlib/alpine/alpine.cue b/stdlib/alpine/alpine.cue index a3013780..071c8f20 100644 --- a/stdlib/alpine/alpine.cue +++ b/stdlib/alpine/alpine.cue @@ -1,3 +1,4 @@ +// Base package for Alpine Linux package alpine import ( @@ -6,6 +7,7 @@ import ( let defaultVersion = "3.13.5@sha256:69e70a79f2d41ab5d637de98c1e0b055206ba40a8145e7bddb55ccc04e13cf8f" +// Base image for Alpine Linux #Image: { package: [string]: true | false | string version: string | *defaultVersion diff --git a/stdlib/aws/aws.cue b/stdlib/aws/aws.cue index d48e1d7d..91648e54 100644 --- a/stdlib/aws/aws.cue +++ b/stdlib/aws/aws.cue @@ -1,3 +1,4 @@ +// AWS base package package aws import ( @@ -6,7 +7,7 @@ import ( "dagger.io/alpine" ) -// Base AWS Config +// AWS Config shared by all AWS packages #Config: { // AWS region region: string @dagger(input) diff --git a/stdlib/aws/cloudformation/cloudformation.cue b/stdlib/aws/cloudformation/cloudformation.cue index c2175f33..17c0ece9 100644 --- a/stdlib/aws/cloudformation/cloudformation.cue +++ b/stdlib/aws/cloudformation/cloudformation.cue @@ -1,3 +1,4 @@ +// AWS Cloud Formation package cloudformation import ( diff --git a/stdlib/aws/ecr/ecr.cue b/stdlib/aws/ecr/ecr.cue index 267fceab..cf2cd5a2 100644 --- a/stdlib/aws/ecr/ecr.cue +++ b/stdlib/aws/ecr/ecr.cue @@ -1,3 +1,4 @@ +// Amazon Elastic Container Registry (ECR) package ecr import ( diff --git a/stdlib/aws/ecs/run-task.cue b/stdlib/aws/ecs/run-task.cue index c86907eb..3e6e0b0e 100644 --- a/stdlib/aws/ecs/run-task.cue +++ b/stdlib/aws/ecs/run-task.cue @@ -1,10 +1,11 @@ +// AWS Elastic Container Service (ECS) package ecs import ( "dagger.io/aws" ) -// RunTask implement ecs run-task +// RunTask implements ecs run-task for running a single container on ECS #RunTask: { // AWS Config diff --git a/stdlib/aws/eks/eks.cue b/stdlib/aws/eks/eks.cue index 150fe5f8..c7be43ec 100644 --- a/stdlib/aws/eks/eks.cue +++ b/stdlib/aws/eks/eks.cue @@ -1,3 +1,4 @@ +// AWS Elastic Kubernetes Service (EKS) package eks import ( diff --git a/stdlib/aws/elb/elb.cue b/stdlib/aws/elb/elb.cue index 6d29e1b6..5c26099e 100644 --- a/stdlib/aws/elb/elb.cue +++ b/stdlib/aws/elb/elb.cue @@ -1,3 +1,4 @@ +// AWS Elastic Load Balancer (ELBv2) package elb import ( @@ -5,7 +6,7 @@ import ( "dagger.io/aws" ) -// Returns a non-taken rule priority (randomized) +// Returns an unused rule priority (randomized in available range) #RandomRulePriority: { // AWS Config config: aws.#Config diff --git a/stdlib/aws/rds/rds.cue b/stdlib/aws/rds/rds.cue index 484d482b..9145c308 100644 --- a/stdlib/aws/rds/rds.cue +++ b/stdlib/aws/rds/rds.cue @@ -1,3 +1,4 @@ +// AWS Relational Database Service (RDS) package rds import ( @@ -6,6 +7,7 @@ import ( "dagger.io/aws" ) +// Creates a new Database on an existing RDS Instance #CreateDB: { // AWS Config config: aws.#Config @@ -19,6 +21,7 @@ import ( // ARN of the database secret (for connecting via rds api) secretArn: string @dagger(input) + // Database type MySQL or PostgreSQL (Aurora Serverless only) dbType: "mysql" | "postgres" @dagger(input) // Name of the DB created @@ -79,6 +82,7 @@ import ( } } +// Creates a new user credentials on an existing RDS Instance #CreateUser: { // AWS Config config: aws.#Config @@ -95,8 +99,10 @@ import ( // ARN of the database secret (for connecting via rds api) secretArn: string @dagger(input) + // Name of the database to grants access to grantDatabase: string | *"" @dagger(input) + // Database type MySQL or PostgreSQL (Aurora Serverless only) dbType: "mysql" | "postgres" @dagger(input) // Outputed username @@ -185,6 +191,7 @@ import ( } } +// Fetches information on an existing RDS Instance #Instance: { // AWS Config config: aws.#Config diff --git a/stdlib/aws/s3/s3.cue b/stdlib/aws/s3/s3.cue index 99e8a20e..e4fa19ed 100644 --- a/stdlib/aws/s3/s3.cue +++ b/stdlib/aws/s3/s3.cue @@ -1,3 +1,4 @@ +// AWS Simple Storage Service package s3 import ( @@ -6,7 +7,7 @@ import ( "dagger.io/aws" ) -// S3 file or Directory upload +// S3 Bucket upload (file or directory) #Put: { // AWS Config @@ -91,7 +92,7 @@ import ( } } -// S3 Sync +// S3 Bucket sync #Sync: { // AWS Config config: aws.#Config diff --git a/stdlib/dagger/dagger.cue b/stdlib/dagger/dagger.cue index e7afc6d5..8dc76711 100644 --- a/stdlib/dagger/dagger.cue +++ b/stdlib/dagger/dagger.cue @@ -6,7 +6,6 @@ import ( // An artifact such as source code checkout, container image, binary archive... // May be passed as user input, or computed by a buildkit pipeline - #Artifact: { @dagger(artifact) #up: [...op.#Op] diff --git a/stdlib/docker/docker.cue b/stdlib/docker/docker.cue index 9d7bbdb2..6652d5ed 100644 --- a/stdlib/docker/docker.cue +++ b/stdlib/docker/docker.cue @@ -1,3 +1,4 @@ +// Docker container operations package docker import ( @@ -102,7 +103,10 @@ import ( // Build a Docker image from the provided Dockerfile contents // FIXME: incorporate into #Build #ImageFromDockerfile: { + // Dockerfile passed as a string dockerfile: string @dagger(input) + + // Build context context: dagger.#Artifact @dagger(input) #up: [ diff --git a/stdlib/gcp/gcp.cue b/stdlib/gcp/gcp.cue index 45f79624..ea0e055e 100644 --- a/stdlib/gcp/gcp.cue +++ b/stdlib/gcp/gcp.cue @@ -1,3 +1,4 @@ +// Google Cloud Platform package gcp import ( diff --git a/stdlib/gcp/gcr/gcr.cue b/stdlib/gcp/gcr/gcr.cue index aebc1149..f3381a9d 100644 --- a/stdlib/gcp/gcr/gcr.cue +++ b/stdlib/gcp/gcr/gcr.cue @@ -1,3 +1,4 @@ +// Google Container Registry package gcr import ( diff --git a/stdlib/gcp/gke/gke.cue b/stdlib/gcp/gke/gke.cue index 69438fea..6ded54f0 100644 --- a/stdlib/gcp/gke/gke.cue +++ b/stdlib/gcp/gke/gke.cue @@ -1,3 +1,4 @@ +// Google Kubernetes Engine package gke import ( diff --git a/stdlib/git/git.cue b/stdlib/git/git.cue index f4eb40fe..b9b8e588 100644 --- a/stdlib/git/git.cue +++ b/stdlib/git/git.cue @@ -1,3 +1,4 @@ +// Git operations package git import ( @@ -35,7 +36,11 @@ import ( // Get the name of the current checked out branch or tag #CurrentBranch: { + + // Git repository repository: dagger.#Artifact @dagger(input) + + // Git branch name name: { string @dagger(output) @@ -74,7 +79,11 @@ import ( // List tags of a repository #Tags: { + + // Git repository repository: dagger.#Artifact @dagger(input) + + // Repository tags tags: { [...string] @dagger(output) diff --git a/stdlib/go/go.cue b/stdlib/go/go.cue index 0fc62547..5a836eb4 100644 --- a/stdlib/go/go.cue +++ b/stdlib/go/go.cue @@ -1,3 +1,4 @@ +// Go build operations package go import ( @@ -10,8 +11,11 @@ import ( // A standalone go environment #Container: { + // Go version to use version: *"1.16" | string @dagger(input) + + // Source code source: dagger.#Artifact @dagger(input) os.#Container & { @@ -36,6 +40,7 @@ import ( } } +// Re-usable component for the Go compiler #Go: { // Go version to use version: *"1.16" | string @dagger(input) @@ -70,6 +75,7 @@ import ( ] } +// Go application builder #Build: { // Go version to use version: *#Go.version | string @dagger(input) @@ -95,6 +101,7 @@ import ( // Specify the targeted binary name output: string @dagger(output) + // Environment variables env: { [string]: string @dagger(input) } diff --git a/stdlib/io/io.cue b/stdlib/io/io.cue index 5804cb49..a1fec92e 100644 --- a/stdlib/io/io.cue +++ b/stdlib/io/io.cue @@ -1,3 +1,4 @@ +// IO operations package io // Standard interface for directory operations in cue @@ -13,8 +14,10 @@ package io ... } +// Standard ReadWriter interface #ReadWriter: #Reader & #Writer +// Standard Reader interface #Reader: { read: { // FIXME: support different data schemas for different formats @@ -26,6 +29,7 @@ package io ... } +// Standard Writer interface #Writer: { write: *null | { // FIXME: support writing in multiple formats diff --git a/stdlib/js/yarn/yarn.cue b/stdlib/js/yarn/yarn.cue index 20887bc7..f9471215 100644 --- a/stdlib/js/yarn/yarn.cue +++ b/stdlib/js/yarn/yarn.cue @@ -9,7 +9,7 @@ import ( "dagger.io/os" ) -// A Yarn package. +// A Yarn package #Package: { // Application source code source: dagger.#Artifact @dagger(input) @@ -28,11 +28,11 @@ import ( } @dagger(input) // Write the contents of `environment` to this file, - // in the "envfile" format. + // in the "envfile" format writeEnvFile: string | *"" @dagger(input) // Read build output from this directory - // (path must be relative to working directory). + // (path must be relative to working directory) buildDir: string | *"build" @dagger(input) // Run this yarn script @@ -41,6 +41,7 @@ import ( // Optional arguments for the script args: [...string] | *[] @dagger(input) + // Build output directory build: os.#Dir & { from: ctr path: "/build" diff --git a/stdlib/kubernetes/kubernetes.cue b/stdlib/kubernetes/kubernetes.cue index 55aa4c5f..1073ddc1 100644 --- a/stdlib/kubernetes/kubernetes.cue +++ b/stdlib/kubernetes/kubernetes.cue @@ -1,3 +1,4 @@ +// Kubernetes client operations package kubernetes import ( @@ -6,8 +7,10 @@ import ( "dagger.io/alpine" ) +// Kubectl client #Kubectl: { + // Kubectl version version: *"v1.19.9" | string #code: #""" diff --git a/stdlib/kubernetes/kustomize/kustomization.cue b/stdlib/kubernetes/kustomize/kustomization.cue index bcf02a10..4a8b323d 100644 --- a/stdlib/kubernetes/kustomize/kustomization.cue +++ b/stdlib/kubernetes/kustomize/kustomization.cue @@ -1,3 +1,4 @@ +// Kustomize config management package kustomize import ( diff --git a/stdlib/netlify/netlify.cue b/stdlib/netlify/netlify.cue index b209b34e..3710a225 100644 --- a/stdlib/netlify/netlify.cue +++ b/stdlib/netlify/netlify.cue @@ -1,3 +1,4 @@ +// Netlify client operations package netlify import ( @@ -6,7 +7,7 @@ import ( "dagger.io/os" ) -// A Netlify account +// Netlify account credentials #Account: { // Use this Netlify account name // (also referred to as "team" in the Netlify docs) @@ -16,7 +17,7 @@ import ( token: dagger.#Secret @dagger(input) } -// A Netlify site +// Netlify site #Site: { // Netlify account this site is attached to account: #Account diff --git a/stdlib/random/string.cue b/stdlib/random/string.cue index 882e2650..a15891e1 100644 --- a/stdlib/random/string.cue +++ b/stdlib/random/string.cue @@ -1,16 +1,4 @@ -// Random generation utilities. -// -// Example: -// -// ```cue -// str: random.#String & { -// seed: "str" -// length: 10 -// } -// ``` -// -// -// +// Random generation utilities package random import ( diff --git a/stdlib/terraform/terraform.cue b/stdlib/terraform/terraform.cue index 9ce68852..703a7113 100644 --- a/stdlib/terraform/terraform.cue +++ b/stdlib/terraform/terraform.cue @@ -1,3 +1,4 @@ +// Terraform operations package terraform import ( @@ -7,15 +8,20 @@ import ( "dagger.io/dagger/op" ) +// Terraform configuration #Configuration: { + + // Terraform version version: string | *"latest" @dagger(input) + // Source configuration source: dagger.#Artifact @dagger(input) tfvars?: { ... } + // Environment variables env: { [string]: string @dagger(input) } From 6422b4d36dfd5086896c3839993f2aa0f3c3c000 Mon Sep 17 00:00:00 2001 From: Sam Alba Date: Tue, 15 Jun 2021 10:47:39 +0200 Subject: [PATCH 2/3] stdlib: cue fmt Signed-off-by: Sam Alba --- stdlib/docker/docker.cue | 4 ++-- stdlib/go/go.cue | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/stdlib/docker/docker.cue b/stdlib/docker/docker.cue index 6652d5ed..642d1a59 100644 --- a/stdlib/docker/docker.cue +++ b/stdlib/docker/docker.cue @@ -104,10 +104,10 @@ import ( // FIXME: incorporate into #Build #ImageFromDockerfile: { // Dockerfile passed as a string - dockerfile: string @dagger(input) + dockerfile: string @dagger(input) // Build context - context: dagger.#Artifact @dagger(input) + context: dagger.#Artifact @dagger(input) #up: [ op.#DockerBuild & { diff --git a/stdlib/go/go.cue b/stdlib/go/go.cue index 5a836eb4..f0de9b20 100644 --- a/stdlib/go/go.cue +++ b/stdlib/go/go.cue @@ -16,7 +16,7 @@ import ( version: *"1.16" | string @dagger(input) // Source code - source: dagger.#Artifact @dagger(input) + source: dagger.#Artifact @dagger(input) os.#Container & { env: CGO_ENABLED: "0" From 7054782547cee096f3f3ae16b974d014f1ac1f1d Mon Sep 17 00:00:00 2001 From: Sam Alba Date: Tue, 15 Jun 2021 10:48:54 +0200 Subject: [PATCH 3/3] docs: updated stdlib reference doc Signed-off-by: Sam Alba --- docs/reference/universe/alpine.md | 4 ++ docs/reference/universe/aws/README.md | 4 +- docs/reference/universe/aws/cloudformation.md | 2 + docs/reference/universe/aws/ecr.md | 2 + docs/reference/universe/aws/ecs.md | 2 + docs/reference/universe/aws/eks.md | 2 + docs/reference/universe/aws/elb.md | 4 +- docs/reference/universe/aws/rds.md | 48 +++++++++++-------- docs/reference/universe/aws/s3.md | 6 ++- docs/reference/universe/docker.md | 10 ++-- docs/reference/universe/gcp/README.md | 2 + docs/reference/universe/gcp/gcr.md | 2 + docs/reference/universe/gcp/gke.md | 2 + docs/reference/universe/git.md | 10 ++-- docs/reference/universe/go.md | 8 +++- docs/reference/universe/io.md | 8 ++++ docs/reference/universe/js/yarn.md | 28 +++++------ docs/reference/universe/kubernetes/README.md | 4 ++ .../universe/kubernetes/kustomize.md | 2 + docs/reference/universe/netlify.md | 6 ++- docs/reference/universe/random.md | 11 +---- docs/reference/universe/terraform.md | 12 +++-- 22 files changed, 116 insertions(+), 63 deletions(-) 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