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

docs: updated stdlib reference doc

Browse Source 
Signed-off-by: Sam Alba <sam.alba@gmail.com>
This commit is contained in:
Sam Alba 2021-06-15 10:48:54 +02:00
parent 6422b4d36d
commit 7054782547
22 changed files with 116 additions and 63 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