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-15 18:10:57 +02:00
parent d1454a9871
commit 5eb40b3176
8 changed files with 60 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -4,7 +4,7 @@ sidebar_label: cloudformation
# dagger.io/aws/cloudformation # dagger.io/aws/cloudformation
AWS Cloud Formation AWS CloudFormation
## #Stack ## #Stack
@ -19,10 +19,13 @@ AWS CloudFormation Stack
|*config.secretKey* | `dagger.#Secret` |AWS secret key | |*config.secretKey* | `dagger.#Secret` |AWS secret key |
|*source* | `string` |Source is the Cloudformation template (JSON/YAML string) | |*source* | `string` |Source is the Cloudformation template (JSON/YAML string) |
|*stackName* | `string` |Stackname is the cloudformation stack | |*stackName* | `string` |Stackname is the cloudformation stack |
|*parameters* | `struct` |Stack parameters |
|*onFailure* | `*"DO_NOTHING" \| "ROLLBACK" \| "DELETE"` |Behavior when failure to create/update the Stack | |*onFailure* | `*"DO_NOTHING" \| "ROLLBACK" \| "DELETE"` |Behavior when failure to create/update the Stack |
|*timeout* | `*10 \| \>=0 & int` |Maximum waiting time until stack creation/update (in minutes) | |*timeout* | `*10 \| \>=0 & int` |Maximum waiting time until stack creation/update (in minutes) |
|*neverUpdate* | `*false \| bool` |Never update the stack if already exists | |*neverUpdate* | `*false \| true` |Never update the stack if already exists |
### #Stack Outputs ### #Stack Outputs
_No output._ | Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*outputs* | `struct` |- |

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

@ -8,7 +8,7 @@ Amazon Elastic Container Registry (ECR)
## #Credentials ## #Credentials
Convert AWS credentials to Docker Registry credentials for ECR Convert ECR credentials to Docker Login format
### #Credentials Inputs ### #Credentials Inputs
@ -23,4 +23,7 @@ Convert AWS credentials to Docker Registry credentials for ECR
### #Credentials Outputs ### #Credentials Outputs
_No output._ | Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*username* | `"AWS"` |ECR registry |
|*secret* | `string` |ECR registry secret |

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

@ -6,11 +6,11 @@ sidebar_label: rds
AWS Relational Database Service (RDS) AWS Relational Database Service (RDS)
## #CreateDB ## #Database
Creates a new Database on an existing RDS Instance Creates a new Database on an existing RDS Instance
### #CreateDB Inputs ### #Database Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
@ -22,36 +22,12 @@ Creates a new Database on an existing RDS Instance
|*secretArn* | `string` |ARN of the database secret (for connecting via rds api) | |*secretArn* | `string` |ARN of the database secret (for connecting via rds api) |
|*dbType* | `string` |Database type MySQL or PostgreSQL (Aurora Serverless only) | |*dbType* | `string` |Database type MySQL or PostgreSQL (Aurora Serverless only) |
### #CreateDB Outputs ### #Database Outputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
|*out* | `string` |Name of the DB created | |*out* | `string` |Name of the DB created |
## #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` |Name of the database to grants access to |
|*dbType* | `string` |Database type MySQL or PostgreSQL (Aurora Serverless only) |
### #CreateUser Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*out* | `string` |Outputed username |
## #Instance ## #Instance
Fetches information on an existing RDS Instance Fetches information on an existing RDS Instance
@ -72,3 +48,27 @@ Fetches information on an existing RDS Instance
|*hostname* | `_\|_` |DB hostname | |*hostname* | `_\|_` |DB hostname |
|*port* | `_\|_` |DB port | |*port* | `_\|_` |DB port |
|*info* | `_\|_` |- | |*info* | `_\|_` |- |
## #User
Creates a new user credentials on an existing RDS Instance
### #User 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` |Name of the database to grants access to |
|*dbType* | `string` |Database type MySQL or PostgreSQL (Aurora Serverless only) |
### #User Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*out* | `string` |Outputed username |

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

@ -33,16 +33,16 @@ S3 Bucket sync
### #Sync Inputs ### #Sync Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
|*config.region* | `string` |AWS region | |*config.region* | `string` |AWS region |
|*config.accessKey* | `dagger.#Secret` |AWS access key | |*config.accessKey* | `dagger.#Secret` |AWS access key |
|*config.secretKey* | `dagger.#Secret` |AWS secret key | |*config.secretKey* | `dagger.#Secret` |AWS secret key |
|*source* | `dagger.#Artifact` |Source Artifact to upload to S3 | |*source* | `dagger.#Artifact` |Source Artifact to upload to S3 |
|*target* | `string` |Target S3 URL (eg. s3://\<bucket-name\>/\<path\>/\<sub-path\>) | |*target* | `string` |Target S3 URL (eg. s3://\<bucket-name\>/\<path\>/\<sub-path\>) |
|*delete* | `*false \| bool` |Files that exist in the destination but not in the source are deleted during sync. | |*delete* | `*false \| bool` |Delete files that already exist on remote destination |
|*contentType* | `*"" \| string` |Object content type | |*contentType* | `*"" \| string` |Object content type |
|*always* | `*true \| bool` |Always write the object to S3 | |*always* | `*true \| bool` |Always write the object to S3 |
### #Sync Outputs ### #Sync Outputs

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

@ -20,6 +20,7 @@ Credentials retriever for GCR
### #Credentials Outputs ### #Credentials Outputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
|*secret* | `string` |- | |*username* | `"oauth2accesstoken"` |GCR registry username |
|*secret* | `string` |GCR registry secret |

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

@ -4,6 +4,8 @@ sidebar_label: helm
# dagger.io/kubernetes/helm # dagger.io/kubernetes/helm
Helm package manager
## #Chart ## #Chart
Install a Helm chart Install a Helm chart

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

@ -25,8 +25,8 @@ import (
// ECR registry secret // ECR registry secret
secret: { secret: {
os.#File & { os.#File & {
from: ctr from: ctr
path: "/out" path: "/out"
} }
}.read.data @dagger(output) }.read.data @dagger(output)
} }

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

@ -8,6 +8,8 @@ import (
) )
// S3 Bucket upload (file or directory) // S3 Bucket upload (file or directory)
// FIXME: rename #Put to use a noun
// FIXME: deprecate in favor of #Sync
#Put: { #Put: {
// AWS Config // AWS Config
@ -93,6 +95,7 @@ import (
} }
// S3 Bucket sync // S3 Bucket sync
// FIXME: rename #Sync to use a noun
#Sync: { #Sync: {
// AWS Config // AWS Config