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

Merge pull request #642 from samalba/docs-stdlib

Browse Source 
Docs stdlib
This commit is contained in:
Sam Alba 2021-06-15 10:58:52 +02:00 committed by GitHub
commit 5b6080caa4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
45 changed files with 185 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -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._

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

@ -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

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

@ -4,6 +4,8 @@ sidebar_label: cloudformation
# dagger.io/aws/cloudformation
AWS Cloud Formation
## #Stack
AWS CloudFormation Stack

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

@ -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

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

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

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

@ -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

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

@ -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

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

@ -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 |

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

@ -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

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

@ -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

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

@ -4,6 +4,8 @@ sidebar_label: gcp
# dagger.io/gcp
Google Cloud Platform
## #Config
Base Google Cloud Config

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

@ -4,6 +4,8 @@ sidebar_label: gcr
# dagger.io/gcp/gcr
Google Container Registry
## #Credentials
Credentials retriever for GCR

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

@ -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

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

@ -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 |

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

@ -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 |

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

@ -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._

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

@ -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 |

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

@ -4,8 +4,12 @@ sidebar_label: kubernetes
# dagger.io/kubernetes
Kubernetes client operations
## #Kubectl
Kubectl client
### #Kubectl Inputs
_No input._

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

@ -4,6 +4,8 @@ sidebar_label: kustomize
# dagger.io/kubernetes/kustomize
Kustomize config management
## #Kustomization
### #Kustomization Inputs

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

@ -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

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

@ -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

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

@ -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

2
stdlib/alpine/alpine.cue
View File

@ -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

3
stdlib/aws/aws.cue
View File

@ -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)

1
stdlib/aws/cloudformation/cloudformation.cue
View File

@ -1,3 +1,4 @@
// AWS Cloud Formation
package cloudformation
import (

1
stdlib/aws/ecr/ecr.cue
View File

@ -1,3 +1,4 @@
// Amazon Elastic Container Registry (ECR)
package ecr
import (

3
stdlib/aws/ecs/run-task.cue
View File

@ -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

1
stdlib/aws/eks/eks.cue
View File

@ -1,3 +1,4 @@
// AWS Elastic Kubernetes Service (EKS)
package eks
import (

3
stdlib/aws/elb/elb.cue
View File

@ -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

7
stdlib/aws/rds/rds.cue
View File

@ -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

5
stdlib/aws/s3/s3.cue
View File

@ -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

1
stdlib/dagger/dagger.cue
View File

@ -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]

8
stdlib/docker/docker.cue
View File

@ -1,3 +1,4 @@
// Docker container operations
package docker
import (
@ -102,8 +103,11 @@ import (
// Build a Docker image from the provided Dockerfile contents
// FIXME: incorporate into #Build
#ImageFromDockerfile: {
dockerfile: string @dagger(input)
context: dagger.#Artifact @dagger(input)
// Dockerfile passed as a string
dockerfile: string @dagger(input)
// Build context
context: dagger.#Artifact @dagger(input)
#up: [
op.#DockerBuild & {

1
stdlib/gcp/gcp.cue
View File

@ -1,3 +1,4 @@
// Google Cloud Platform
package gcp
import (

1
stdlib/gcp/gcr/gcr.cue
View File

@ -1,3 +1,4 @@
// Google Container Registry
package gcr
import (

1
stdlib/gcp/gke/gke.cue
View File

@ -1,3 +1,4 @@
// Google Kubernetes Engine
package gke
import (

9
stdlib/git/git.cue
View File

@ -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)

9
stdlib/go/go.cue
View File

@ -1,3 +1,4 @@
// Go build operations
package go
import (
@ -10,9 +11,12 @@ import (
// A standalone go environment
#Container: {
// Go version to use
version: *"1.16" | string @dagger(input)
source: dagger.#Artifact @dagger(input)
// Source code
source: dagger.#Artifact @dagger(input)
os.#Container & {
env: CGO_ENABLED: "0"
@ -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)
}

4
stdlib/io/io.cue
View File

@ -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

7
stdlib/js/yarn/yarn.cue
View File

@ -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"

3
stdlib/kubernetes/kubernetes.cue
View File

@ -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: #"""

1
stdlib/kubernetes/kustomize/kustomization.cue
View File

@ -1,3 +1,4 @@
// Kustomize config management
package kustomize
import (

5
stdlib/netlify/netlify.cue
View File

@ -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

14
stdlib/random/string.cue
View File

@ -1,16 +1,4 @@
// Random generation utilities.
//
// Example:
//
// ```cue
// str: random.#String & {
// seed: "str"
// length: 10
// }
// ```
//
//
//
// Random generation utilities
package random
import (

6
stdlib/terraform/terraform.cue
View File

@ -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)
}