stdlib: added package doc strings
Signed-off-by: Sam Alba <sam.alba@gmail.com>
This commit is contained in:
parent
36b287c9d5
commit
9281967e16
@ -1,3 +1,4 @@
|
|||||||
|
// Base package for Alpine Linux
|
||||||
package alpine
|
package alpine
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@ -6,6 +7,7 @@ import (
|
|||||||
|
|
||||||
let defaultVersion = "3.13.5@sha256:69e70a79f2d41ab5d637de98c1e0b055206ba40a8145e7bddb55ccc04e13cf8f"
|
let defaultVersion = "3.13.5@sha256:69e70a79f2d41ab5d637de98c1e0b055206ba40a8145e7bddb55ccc04e13cf8f"
|
||||||
|
|
||||||
|
// Base image for Alpine Linux
|
||||||
#Image: {
|
#Image: {
|
||||||
package: [string]: true | false | string
|
package: [string]: true | false | string
|
||||||
version: string | *defaultVersion
|
version: string | *defaultVersion
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
// AWS base package
|
||||||
package aws
|
package aws
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@ -6,7 +7,7 @@ import (
|
|||||||
"dagger.io/alpine"
|
"dagger.io/alpine"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Base AWS Config
|
// AWS Config shared by all AWS packages
|
||||||
#Config: {
|
#Config: {
|
||||||
// AWS region
|
// AWS region
|
||||||
region: string @dagger(input)
|
region: string @dagger(input)
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
// AWS Cloud Formation
|
||||||
package cloudformation
|
package cloudformation
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
// Amazon Elastic Container Registry (ECR)
|
||||||
package ecr
|
package ecr
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
@ -1,10 +1,11 @@
|
|||||||
|
// AWS Elastic Container Service (ECS)
|
||||||
package ecs
|
package ecs
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"dagger.io/aws"
|
"dagger.io/aws"
|
||||||
)
|
)
|
||||||
|
|
||||||
// RunTask implement ecs run-task
|
// RunTask implements ecs run-task for running a single container on ECS
|
||||||
#RunTask: {
|
#RunTask: {
|
||||||
|
|
||||||
// AWS Config
|
// AWS Config
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
// AWS Elastic Kubernetes Service (EKS)
|
||||||
package eks
|
package eks
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
// AWS Elastic Load Balancer (ELBv2)
|
||||||
package elb
|
package elb
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@ -5,7 +6,7 @@ import (
|
|||||||
"dagger.io/aws"
|
"dagger.io/aws"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Returns a non-taken rule priority (randomized)
|
// Returns an unused rule priority (randomized in available range)
|
||||||
#RandomRulePriority: {
|
#RandomRulePriority: {
|
||||||
// AWS Config
|
// AWS Config
|
||||||
config: aws.#Config
|
config: aws.#Config
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
// AWS Relational Database Service (RDS)
|
||||||
package rds
|
package rds
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@ -6,6 +7,7 @@ import (
|
|||||||
"dagger.io/aws"
|
"dagger.io/aws"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// Creates a new Database on an existing RDS Instance
|
||||||
#CreateDB: {
|
#CreateDB: {
|
||||||
// AWS Config
|
// AWS Config
|
||||||
config: aws.#Config
|
config: aws.#Config
|
||||||
@ -19,6 +21,7 @@ import (
|
|||||||
// ARN of the database secret (for connecting via rds api)
|
// ARN of the database secret (for connecting via rds api)
|
||||||
secretArn: string @dagger(input)
|
secretArn: string @dagger(input)
|
||||||
|
|
||||||
|
// Database type MySQL or PostgreSQL (Aurora Serverless only)
|
||||||
dbType: "mysql" | "postgres" @dagger(input)
|
dbType: "mysql" | "postgres" @dagger(input)
|
||||||
|
|
||||||
// Name of the DB created
|
// Name of the DB created
|
||||||
@ -79,6 +82,7 @@ import (
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Creates a new user credentials on an existing RDS Instance
|
||||||
#CreateUser: {
|
#CreateUser: {
|
||||||
// AWS Config
|
// AWS Config
|
||||||
config: aws.#Config
|
config: aws.#Config
|
||||||
@ -95,8 +99,10 @@ import (
|
|||||||
// ARN of the database secret (for connecting via rds api)
|
// ARN of the database secret (for connecting via rds api)
|
||||||
secretArn: string @dagger(input)
|
secretArn: string @dagger(input)
|
||||||
|
|
||||||
|
// Name of the database to grants access to
|
||||||
grantDatabase: string | *"" @dagger(input)
|
grantDatabase: string | *"" @dagger(input)
|
||||||
|
|
||||||
|
// Database type MySQL or PostgreSQL (Aurora Serverless only)
|
||||||
dbType: "mysql" | "postgres" @dagger(input)
|
dbType: "mysql" | "postgres" @dagger(input)
|
||||||
|
|
||||||
// Outputed username
|
// Outputed username
|
||||||
@ -185,6 +191,7 @@ import (
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Fetches information on an existing RDS Instance
|
||||||
#Instance: {
|
#Instance: {
|
||||||
// AWS Config
|
// AWS Config
|
||||||
config: aws.#Config
|
config: aws.#Config
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
// AWS Simple Storage Service
|
||||||
package s3
|
package s3
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@ -6,7 +7,7 @@ import (
|
|||||||
"dagger.io/aws"
|
"dagger.io/aws"
|
||||||
)
|
)
|
||||||
|
|
||||||
// S3 file or Directory upload
|
// S3 Bucket upload (file or directory)
|
||||||
#Put: {
|
#Put: {
|
||||||
|
|
||||||
// AWS Config
|
// AWS Config
|
||||||
@ -91,7 +92,7 @@ import (
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// S3 Sync
|
// S3 Bucket sync
|
||||||
#Sync: {
|
#Sync: {
|
||||||
// AWS Config
|
// AWS Config
|
||||||
config: aws.#Config
|
config: aws.#Config
|
||||||
|
@ -6,7 +6,6 @@ import (
|
|||||||
|
|
||||||
// An artifact such as source code checkout, container image, binary archive...
|
// An artifact such as source code checkout, container image, binary archive...
|
||||||
// May be passed as user input, or computed by a buildkit pipeline
|
// May be passed as user input, or computed by a buildkit pipeline
|
||||||
|
|
||||||
#Artifact: {
|
#Artifact: {
|
||||||
@dagger(artifact)
|
@dagger(artifact)
|
||||||
#up: [...op.#Op]
|
#up: [...op.#Op]
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
// Docker container operations
|
||||||
package docker
|
package docker
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@ -102,7 +103,10 @@ import (
|
|||||||
// Build a Docker image from the provided Dockerfile contents
|
// Build a Docker image from the provided Dockerfile contents
|
||||||
// FIXME: incorporate into #Build
|
// FIXME: incorporate into #Build
|
||||||
#ImageFromDockerfile: {
|
#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: [
|
#up: [
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
// Google Cloud Platform
|
||||||
package gcp
|
package gcp
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
// Google Container Registry
|
||||||
package gcr
|
package gcr
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
// Google Kubernetes Engine
|
||||||
package gke
|
package gke
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
// Git operations
|
||||||
package git
|
package git
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@ -35,7 +36,11 @@ import (
|
|||||||
|
|
||||||
// Get the name of the current checked out branch or tag
|
// Get the name of the current checked out branch or tag
|
||||||
#CurrentBranch: {
|
#CurrentBranch: {
|
||||||
|
|
||||||
|
// Git repository
|
||||||
repository: dagger.#Artifact @dagger(input)
|
repository: dagger.#Artifact @dagger(input)
|
||||||
|
|
||||||
|
// Git branch name
|
||||||
name: {
|
name: {
|
||||||
string
|
string
|
||||||
@dagger(output)
|
@dagger(output)
|
||||||
@ -74,7 +79,11 @@ import (
|
|||||||
|
|
||||||
// List tags of a repository
|
// List tags of a repository
|
||||||
#Tags: {
|
#Tags: {
|
||||||
|
|
||||||
|
// Git repository
|
||||||
repository: dagger.#Artifact @dagger(input)
|
repository: dagger.#Artifact @dagger(input)
|
||||||
|
|
||||||
|
// Repository tags
|
||||||
tags: {
|
tags: {
|
||||||
[...string]
|
[...string]
|
||||||
@dagger(output)
|
@dagger(output)
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
// Go build operations
|
||||||
package go
|
package go
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@ -10,8 +11,11 @@ import (
|
|||||||
|
|
||||||
// A standalone go environment
|
// A standalone go environment
|
||||||
#Container: {
|
#Container: {
|
||||||
|
|
||||||
// Go version to use
|
// Go version to use
|
||||||
version: *"1.16" | string @dagger(input)
|
version: *"1.16" | string @dagger(input)
|
||||||
|
|
||||||
|
// Source code
|
||||||
source: dagger.#Artifact @dagger(input)
|
source: dagger.#Artifact @dagger(input)
|
||||||
|
|
||||||
os.#Container & {
|
os.#Container & {
|
||||||
@ -36,6 +40,7 @@ import (
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Re-usable component for the Go compiler
|
||||||
#Go: {
|
#Go: {
|
||||||
// Go version to use
|
// Go version to use
|
||||||
version: *"1.16" | string @dagger(input)
|
version: *"1.16" | string @dagger(input)
|
||||||
@ -70,6 +75,7 @@ import (
|
|||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Go application builder
|
||||||
#Build: {
|
#Build: {
|
||||||
// Go version to use
|
// Go version to use
|
||||||
version: *#Go.version | string @dagger(input)
|
version: *#Go.version | string @dagger(input)
|
||||||
@ -95,6 +101,7 @@ import (
|
|||||||
// Specify the targeted binary name
|
// Specify the targeted binary name
|
||||||
output: string @dagger(output)
|
output: string @dagger(output)
|
||||||
|
|
||||||
|
// Environment variables
|
||||||
env: {
|
env: {
|
||||||
[string]: string @dagger(input)
|
[string]: string @dagger(input)
|
||||||
}
|
}
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
// IO operations
|
||||||
package io
|
package io
|
||||||
|
|
||||||
// Standard interface for directory operations in cue
|
// Standard interface for directory operations in cue
|
||||||
@ -13,8 +14,10 @@ package io
|
|||||||
...
|
...
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Standard ReadWriter interface
|
||||||
#ReadWriter: #Reader & #Writer
|
#ReadWriter: #Reader & #Writer
|
||||||
|
|
||||||
|
// Standard Reader interface
|
||||||
#Reader: {
|
#Reader: {
|
||||||
read: {
|
read: {
|
||||||
// FIXME: support different data schemas for different formats
|
// FIXME: support different data schemas for different formats
|
||||||
@ -26,6 +29,7 @@ package io
|
|||||||
...
|
...
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Standard Writer interface
|
||||||
#Writer: {
|
#Writer: {
|
||||||
write: *null | {
|
write: *null | {
|
||||||
// FIXME: support writing in multiple formats
|
// FIXME: support writing in multiple formats
|
||||||
|
@ -9,7 +9,7 @@ import (
|
|||||||
"dagger.io/os"
|
"dagger.io/os"
|
||||||
)
|
)
|
||||||
|
|
||||||
// A Yarn package.
|
// A Yarn package
|
||||||
#Package: {
|
#Package: {
|
||||||
// Application source code
|
// Application source code
|
||||||
source: dagger.#Artifact @dagger(input)
|
source: dagger.#Artifact @dagger(input)
|
||||||
@ -28,11 +28,11 @@ import (
|
|||||||
} @dagger(input)
|
} @dagger(input)
|
||||||
|
|
||||||
// Write the contents of `environment` to this file,
|
// Write the contents of `environment` to this file,
|
||||||
// in the "envfile" format.
|
// in the "envfile" format
|
||||||
writeEnvFile: string | *"" @dagger(input)
|
writeEnvFile: string | *"" @dagger(input)
|
||||||
|
|
||||||
// Read build output from this directory
|
// 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)
|
buildDir: string | *"build" @dagger(input)
|
||||||
|
|
||||||
// Run this yarn script
|
// Run this yarn script
|
||||||
@ -41,6 +41,7 @@ import (
|
|||||||
// Optional arguments for the script
|
// Optional arguments for the script
|
||||||
args: [...string] | *[] @dagger(input)
|
args: [...string] | *[] @dagger(input)
|
||||||
|
|
||||||
|
// Build output directory
|
||||||
build: os.#Dir & {
|
build: os.#Dir & {
|
||||||
from: ctr
|
from: ctr
|
||||||
path: "/build"
|
path: "/build"
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
// Kubernetes client operations
|
||||||
package kubernetes
|
package kubernetes
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@ -6,8 +7,10 @@ import (
|
|||||||
"dagger.io/alpine"
|
"dagger.io/alpine"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// Kubectl client
|
||||||
#Kubectl: {
|
#Kubectl: {
|
||||||
|
|
||||||
|
// Kubectl version
|
||||||
version: *"v1.19.9" | string
|
version: *"v1.19.9" | string
|
||||||
|
|
||||||
#code: #"""
|
#code: #"""
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
// Kustomize config management
|
||||||
package kustomize
|
package kustomize
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
// Netlify client operations
|
||||||
package netlify
|
package netlify
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@ -6,7 +7,7 @@ import (
|
|||||||
"dagger.io/os"
|
"dagger.io/os"
|
||||||
)
|
)
|
||||||
|
|
||||||
// A Netlify account
|
// Netlify account credentials
|
||||||
#Account: {
|
#Account: {
|
||||||
// Use this Netlify account name
|
// Use this Netlify account name
|
||||||
// (also referred to as "team" in the Netlify docs)
|
// (also referred to as "team" in the Netlify docs)
|
||||||
@ -16,7 +17,7 @@ import (
|
|||||||
token: dagger.#Secret @dagger(input)
|
token: dagger.#Secret @dagger(input)
|
||||||
}
|
}
|
||||||
|
|
||||||
// A Netlify site
|
// Netlify site
|
||||||
#Site: {
|
#Site: {
|
||||||
// Netlify account this site is attached to
|
// Netlify account this site is attached to
|
||||||
account: #Account
|
account: #Account
|
||||||
|
@ -1,16 +1,4 @@
|
|||||||
// Random generation utilities.
|
// Random generation utilities
|
||||||
//
|
|
||||||
// Example:
|
|
||||||
//
|
|
||||||
// ```cue
|
|
||||||
// str: random.#String & {
|
|
||||||
// seed: "str"
|
|
||||||
// length: 10
|
|
||||||
// }
|
|
||||||
// ```
|
|
||||||
//
|
|
||||||
//
|
|
||||||
//
|
|
||||||
package random
|
package random
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
// Terraform operations
|
||||||
package terraform
|
package terraform
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@ -7,15 +8,20 @@ import (
|
|||||||
"dagger.io/dagger/op"
|
"dagger.io/dagger/op"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// Terraform configuration
|
||||||
#Configuration: {
|
#Configuration: {
|
||||||
|
|
||||||
|
// Terraform version
|
||||||
version: string | *"latest" @dagger(input)
|
version: string | *"latest" @dagger(input)
|
||||||
|
|
||||||
|
// Source configuration
|
||||||
source: dagger.#Artifact @dagger(input)
|
source: dagger.#Artifact @dagger(input)
|
||||||
|
|
||||||
tfvars?: {
|
tfvars?: {
|
||||||
...
|
...
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Environment variables
|
||||||
env: {
|
env: {
|
||||||
[string]: string @dagger(input)
|
[string]: string @dagger(input)
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user