From 5eb40b3176b8c95b0e532686f7e0decc8ae54559 Mon Sep 17 00:00:00 2001 From: Sam Alba Date: Tue, 15 Jun 2021 18:10:57 +0200 Subject: [PATCH] docs: refreshed stdlib Signed-off-by: Sam Alba --- docs/reference/universe/aws/cloudformation.md | 9 ++-- docs/reference/universe/aws/ecr.md | 7 ++- docs/reference/universe/aws/rds.md | 54 +++++++++---------- docs/reference/universe/aws/s3.md | 20 +++---- docs/reference/universe/gcp/gcr.md | 7 +-- docs/reference/universe/kubernetes/helm.md | 2 + stdlib/aws/ecr/ecr.cue | 6 +-- stdlib/aws/s3/s3.cue | 3 ++ 8 files changed, 60 insertions(+), 48 deletions(-) diff --git a/docs/reference/universe/aws/cloudformation.md b/docs/reference/universe/aws/cloudformation.md index 38cf4d24..a16640de 100644 --- a/docs/reference/universe/aws/cloudformation.md +++ b/docs/reference/universe/aws/cloudformation.md @@ -4,7 +4,7 @@ sidebar_label: cloudformation # dagger.io/aws/cloudformation -AWS Cloud Formation +AWS CloudFormation ## #Stack @@ -19,10 +19,13 @@ AWS CloudFormation Stack |*config.secretKey* | `dagger.#Secret` |AWS secret key | |*source* | `string` |Source is the Cloudformation template (JSON/YAML string) | |*stackName* | `string` |Stackname is the cloudformation stack | +|*parameters* | `struct` |Stack parameters | |*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) | -|*neverUpdate* | `*false \| bool` |Never update the stack if already exists | +|*neverUpdate* | `*false \| true` |Never update the stack if already exists | ### #Stack Outputs -_No output._ +| Name | Type | Description | +| ------------- |:-------------: |:-------------: | +|*outputs* | `struct` |- | diff --git a/docs/reference/universe/aws/ecr.md b/docs/reference/universe/aws/ecr.md index 0abf3ad4..2091c5f0 100644 --- a/docs/reference/universe/aws/ecr.md +++ b/docs/reference/universe/aws/ecr.md @@ -8,7 +8,7 @@ Amazon Elastic Container Registry (ECR) ## #Credentials -Convert AWS credentials to Docker Registry credentials for ECR +Convert ECR credentials to Docker Login format ### #Credentials Inputs @@ -23,4 +23,7 @@ Convert AWS credentials to Docker Registry credentials for ECR ### #Credentials Outputs -_No output._ +| Name | Type | Description | +| ------------- |:-------------: |:-------------: | +|*username* | `"AWS"` |ECR registry | +|*secret* | `string` |ECR registry secret | diff --git a/docs/reference/universe/aws/rds.md b/docs/reference/universe/aws/rds.md index 334b4f64..d913e955 100644 --- a/docs/reference/universe/aws/rds.md +++ b/docs/reference/universe/aws/rds.md @@ -6,11 +6,11 @@ sidebar_label: rds AWS Relational Database Service (RDS) -## #CreateDB +## #Database Creates a new Database on an existing RDS Instance -### #CreateDB Inputs +### #Database Inputs | 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) | |*dbType* | `string` |Database type MySQL or PostgreSQL (Aurora Serverless only) | -### #CreateDB Outputs +### #Database Outputs | Name | Type | Description | | ------------- |:-------------: |:-------------: | |*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 Fetches information on an existing RDS Instance @@ -72,3 +48,27 @@ Fetches information on an existing RDS Instance |*hostname* | `_\|_` |DB hostname | |*port* | `_\|_` |DB port | |*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 | diff --git a/docs/reference/universe/aws/s3.md b/docs/reference/universe/aws/s3.md index 2882e13e..91de6fd1 100644 --- a/docs/reference/universe/aws/s3.md +++ b/docs/reference/universe/aws/s3.md @@ -33,16 +33,16 @@ S3 Bucket sync ### #Sync Inputs -| Name | Type | Description | -| ------------- |:-------------: |:-------------: | -|*config.region* | `string` |AWS region | -|*config.accessKey* | `dagger.#Secret` |AWS access key | -|*config.secretKey* | `dagger.#Secret` |AWS secret key | -|*source* | `dagger.#Artifact` |Source Artifact to upload to S3 | -|*target* | `string` |Target S3 URL (eg. s3://\/\/\) | -|*delete* | `*false \| bool` |Files that exist in the destination but not in the source are deleted during sync. | -|*contentType* | `*"" \| string` |Object content type | -|*always* | `*true \| bool` |Always write the object to S3 | +| Name | Type | Description | +| ------------- |:-------------: |:-------------: | +|*config.region* | `string` |AWS region | +|*config.accessKey* | `dagger.#Secret` |AWS access key | +|*config.secretKey* | `dagger.#Secret` |AWS secret key | +|*source* | `dagger.#Artifact` |Source Artifact to upload to S3 | +|*target* | `string` |Target S3 URL (eg. s3://\/\/\) | +|*delete* | `*false \| bool` |Delete files that already exist on remote destination | +|*contentType* | `*"" \| string` |Object content type | +|*always* | `*true \| bool` |Always write the object to S3 | ### #Sync Outputs diff --git a/docs/reference/universe/gcp/gcr.md b/docs/reference/universe/gcp/gcr.md index 883d9e14..88b86853 100644 --- a/docs/reference/universe/gcp/gcr.md +++ b/docs/reference/universe/gcp/gcr.md @@ -20,6 +20,7 @@ Credentials retriever for GCR ### #Credentials Outputs -| Name | Type | Description | -| ------------- |:-------------: |:-------------: | -|*secret* | `string` |- | +| Name | Type | Description | +| ------------- |:-------------: |:-------------: | +|*username* | `"oauth2accesstoken"` |GCR registry username | +|*secret* | `string` |GCR registry secret | diff --git a/docs/reference/universe/kubernetes/helm.md b/docs/reference/universe/kubernetes/helm.md index 15c2e983..be9b8abe 100644 --- a/docs/reference/universe/kubernetes/helm.md +++ b/docs/reference/universe/kubernetes/helm.md @@ -4,6 +4,8 @@ sidebar_label: helm # dagger.io/kubernetes/helm +Helm package manager + ## #Chart Install a Helm chart diff --git a/stdlib/aws/ecr/ecr.cue b/stdlib/aws/ecr/ecr.cue index dd9fa446..2ee4d7cc 100644 --- a/stdlib/aws/ecr/ecr.cue +++ b/stdlib/aws/ecr/ecr.cue @@ -25,8 +25,8 @@ import ( // ECR registry secret secret: { os.#File & { - from: ctr - path: "/out" - } + from: ctr + path: "/out" + } }.read.data @dagger(output) } diff --git a/stdlib/aws/s3/s3.cue b/stdlib/aws/s3/s3.cue index 21a2ae35..2312f89e 100644 --- a/stdlib/aws/s3/s3.cue +++ b/stdlib/aws/s3/s3.cue @@ -8,6 +8,8 @@ import ( ) // S3 Bucket upload (file or directory) +// FIXME: rename #Put to use a noun +// FIXME: deprecate in favor of #Sync #Put: { // AWS Config @@ -93,6 +95,7 @@ import ( } // S3 Bucket sync +// FIXME: rename #Sync to use a noun #Sync: { // AWS Config