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

docs: refreshed stdlib

Browse Source 
Signed-off-by: Sam Alba <sam.alba@gmail.com>
This commit is contained in:
Sam Alba
2021-06-16 12:14:39 +02:00
parent 776814910d
commit c6e3d35899
26 changed files with 293 additions and 189 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -6,11 +6,15 @@ sidebar_label: aws
AWS base package
## #CLI
```cue
import "dagger.io/aws"
```
## aws.#CLI
Re-usable aws-cli component
### #CLI Inputs
### aws.#CLI Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
@@ -18,15 +22,15 @@ Re-usable aws-cli component
|*config.accessKey* | `dagger.#Secret` |AWS access key |
|*config.secretKey* | `dagger.#Secret` |AWS secret key |
### #CLI Outputs
### aws.#CLI Outputs
_No output._
## #Config
## aws.#Config
AWS Config shared by all AWS packages
### #Config Inputs
### aws.#Config Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
@@ -34,6 +38,6 @@ AWS Config shared by all AWS packages
|*accessKey* | `dagger.#Secret` |AWS access key |
|*secretKey* | `dagger.#Secret` |AWS secret key |
### #Config Outputs
### aws.#Config Outputs
_No output._

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

@@ -6,11 +6,15 @@ sidebar_label: cloudformation
AWS CloudFormation
## #Stack
```cue
import "dagger.io/aws/cloudformation"
```
## cloudformation.#Stack
AWS CloudFormation Stack
### #Stack Inputs
### cloudformation.#Stack Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
@@ -24,7 +28,7 @@ AWS CloudFormation Stack
|*timeout* | `*10 \| \>=0 & int` |Maximum waiting time until stack creation/update (in minutes) |
|*neverUpdate* | `*false \| true` |Never update the stack if already exists |
### #Stack Outputs
### cloudformation.#Stack Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |

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

@@ -6,11 +6,15 @@ sidebar_label: ecr
Amazon Elastic Container Registry (ECR)
## #Credentials
```cue
import "dagger.io/aws/ecr"
```
## ecr.#Credentials
Convert ECR credentials to Docker Login format
### #Credentials Inputs
### ecr.#Credentials Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
@@ -21,7 +25,7 @@ Convert ECR credentials to Docker Login format
|*ctr.image.config.accessKey* | `dagger.#Secret` |AWS access key |
|*ctr.image.config.secretKey* | `dagger.#Secret` |AWS secret key |
### #Credentials Outputs
### ecr.#Credentials Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |

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

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

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

@@ -6,11 +6,15 @@ sidebar_label: eks
AWS Elastic Kubernetes Service (EKS)
## #KubeConfig
```cue
import "dagger.io/aws/eks"
```
## eks.#KubeConfig
KubeConfig config outputs a valid kube-auth-config for kubectl client
### #KubeConfig Inputs
### eks.#KubeConfig Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
@@ -20,7 +24,7 @@ KubeConfig config outputs a valid kube-auth-config for kubectl client
|*clusterName* | `string` |EKS cluster name |
|*version* | `*"v1.19.9" \| string` |Kubectl version |
### #KubeConfig Outputs
### eks.#KubeConfig Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |

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

@@ -6,11 +6,15 @@ sidebar_label: elb
AWS Elastic Load Balancer (ELBv2)
## #RandomRulePriority
```cue
import "dagger.io/aws/elb"
```
## elb.#RandomRulePriority
Returns an unused rule priority (randomized in available range)
### #RandomRulePriority Inputs
### elb.#RandomRulePriority Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
@@ -19,7 +23,7 @@ Returns an unused rule priority (randomized in available range)
|*config.secretKey* | `dagger.#Secret` |AWS secret key |
|*listenerArn* | `string` |ListenerArn |
### #RandomRulePriority Outputs
### elb.#RandomRulePriority Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |

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

@@ -6,11 +6,15 @@ sidebar_label: rds
AWS Relational Database Service (RDS)
## #Database
```cue
import "dagger.io/aws/rds"
```
## rds.#Database
Creates a new Database on an existing RDS Instance
### #Database Inputs
### rds.#Database Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
@@ -22,17 +26,17 @@ Creates a new Database on an existing RDS Instance
|*secretArn* | `string` |ARN of the database secret (for connecting via rds api) |
|*dbType* | `string` |Database type MySQL or PostgreSQL (Aurora Serverless only) |
### #Database Outputs
### rds.#Database Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*out* | `string` |Name of the DB created |
## #Instance
## rds.#Instance
Fetches information on an existing RDS Instance
### #Instance Inputs
### rds.#Instance Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
@@ -41,7 +45,7 @@ Fetches information on an existing RDS Instance
|*config.secretKey* | `dagger.#Secret` |AWS secret key |
|*dbArn* | `string` |ARN of the database instance |
### #Instance Outputs
### rds.#Instance Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
@@ -49,11 +53,11 @@ Fetches information on an existing RDS Instance
|*port* | `_\|_` |DB port |
|*info* | `_\|_` |- |
## #User
## rds.#User
Creates a new user credentials on an existing RDS Instance
### #User Inputs
### rds.#User Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
@@ -67,7 +71,7 @@ Creates a new user credentials on an existing RDS Instance
|*grantDatabase* | `*"" \| string` |Name of the database to grants access to |
|*dbType* | `string` |Database type MySQL or PostgreSQL (Aurora Serverless only) |
### #User Outputs
### rds.#User Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |

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

@@ -6,11 +6,15 @@ sidebar_label: s3
AWS Simple Storage Service
## #Object
```cue
import "dagger.io/aws/s3"
```
## s3.#Object
S3 Bucket object(s) sync
### #Object Inputs
### s3.#Object Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
@@ -23,7 +27,7 @@ S3 Bucket object(s) sync
|*contentType* | `*"" \| string` |Object content type |
|*always* | `*true \| false` |Always write the object to S3 |
### #Object Outputs
### s3.#Object Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |