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

make docs

Browse Source 
Signed-off-by: Joel Longtine <joel@dagger.io>
This commit is contained in:
Joel Longtine
2022-02-18 16:30:58 -07:00
parent a839ab124a
commit b32e2da0a5
34 changed files with 88 additions and 575 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
docs/reference/aws/README.md
View File

@@ -14,13 +14,7 @@ import "alpha.dagger.io/aws"
### aws.#CLI Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.region* | `string` |AWS region |
|*config.accessKey* | `dagger.#Secret` |AWS access key |
|*config.secretKey* | `dagger.#Secret` |AWS secret key |
|*config.localMode* | `*false \| bool` |AWS localstack mode |
|*version* | `*"1.19" \| string` |- |
_No input._
### aws.#CLI Outputs
@@ -32,12 +26,7 @@ AWS Config shared by all AWS packages
### aws.#Config Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*region* | `string` |AWS region |
|*accessKey* | `dagger.#Secret` |AWS access key |
|*secretKey* | `dagger.#Secret` |AWS secret key |
|*localMode* | `*false \| bool` |AWS localstack mode |
_No input._
### aws.#Config Outputs
@@ -49,13 +38,7 @@ Configuration specific to CLI v1
### aws.#V1 Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.region* | `string` |AWS region |
|*config.accessKey* | `dagger.#Secret` |AWS access key |
|*config.secretKey* | `dagger.#Secret` |AWS secret key |
|*config.localMode* | `*false \| bool` |AWS localstack mode |
|*version* | `*"1.19" \| string` |- |
_No input._
### aws.#V1 Outputs
@@ -67,13 +50,7 @@ Configuration specific to CLI v2
### aws.#V2 Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.region* | `string` |AWS region |
|*config.accessKey* | `dagger.#Secret` |AWS access key |
|*config.secretKey* | `dagger.#Secret` |AWS secret key |
|*config.localMode* | `*false \| bool` |AWS localstack mode |
|*version* | `*"2.1.29" \| string` |- |
_No input._
### aws.#V2 Outputs

13
docs/reference/aws/cloudformation.md
View File

@@ -16,18 +16,7 @@ AWS CloudFormation Stack
### cloudformation.#Stack Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.region* | `string` |AWS region |
|*config.accessKey* | `dagger.#Secret` |AWS access key |
|*config.secretKey* | `dagger.#Secret` |AWS secret key |
|*config.localMode* | `*false \| bool` |AWS localstack mode |
|*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 \| true` |Never update the stack if already exists |
_No input._
### cloudformation.#Stack Outputs

17
docs/reference/aws/ecr.md
View File

@@ -16,21 +16,8 @@ Convert ECR credentials to Docker Login format
### ecr.#Credentials Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.region* | `string` |AWS region |
|*config.accessKey* | `dagger.#Secret` |AWS access key |
|*config.secretKey* | `dagger.#Secret` |AWS secret key |
|*config.localMode* | `*false \| bool` |AWS localstack mode |
|*ctr.image.config.region* | `string` |AWS region |
|*ctr.image.config.accessKey* | `dagger.#Secret` |AWS access key |
|*ctr.image.config.secretKey* | `dagger.#Secret` |AWS secret key |
|*ctr.image.config.localMode* | `*false \| bool` |AWS localstack mode |
|*ctr.image.version* | `*"1.19" \| string` |- |
_No input._
### ecr.#Credentials Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*username* | `"AWS"` |ECR registry |
|*secret* | `string` |ECR registry secret |
_No output._

13
docs/reference/aws/eks.md
View File

@@ -16,17 +16,8 @@ KubeConfig config outputs a valid kube-auth-config for kubectl client
### eks.#KubeConfig Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.region* | `string` |AWS region |
|*config.accessKey* | `dagger.#Secret` |AWS access key |
|*config.secretKey* | `dagger.#Secret` |AWS secret key |
|*config.localMode* | `*false \| bool` |AWS localstack mode |
|*clusterName* | `string` |EKS cluster name |
|*version* | `*"v1.19.9" \| string` |Kubectl version |
_No input._
### eks.#KubeConfig Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*kubeconfig* | `string` |kubeconfig is the generated kube configuration file |
_No output._

12
docs/reference/aws/elb.md
View File

@@ -16,16 +16,8 @@ Returns an unused rule priority (randomized in available range)
### elb.#RandomRulePriority Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.region* | `string` |AWS region |
|*config.accessKey* | `dagger.#Secret` |AWS access key |
|*config.secretKey* | `dagger.#Secret` |AWS secret key |
|*config.localMode* | `*false \| bool` |AWS localstack mode |
|*listenerArn* | `string` |ListenerArn |
_No input._
### elb.#RandomRulePriority Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*priority* | `string` |exported priority |
_No output._

46
docs/reference/aws/rds.md
View File

@@ -16,22 +16,11 @@ Creates a new Database on an existing RDS Instance
### rds.#Database Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.region* | `string` |AWS region |
|*config.accessKey* | `dagger.#Secret` |AWS access key |
|*config.secretKey* | `dagger.#Secret` |AWS secret key |
|*config.localMode* | `*false \| bool` |AWS localstack mode |
|*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) |
_No input._
### rds.#Database Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*out* | `string` |Name of the DB created |
_No output._
## rds.#Instance
@@ -39,21 +28,11 @@ Fetches information on an existing RDS Instance
### rds.#Instance Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.region* | `string` |AWS region |
|*config.accessKey* | `dagger.#Secret` |AWS access key |
|*config.secretKey* | `dagger.#Secret` |AWS secret key |
|*config.localMode* | `*false \| bool` |AWS localstack mode |
|*dbArn* | `string` |ARN of the database instance |
_No input._
### rds.#Instance Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*hostname* | `_\|_` |DB hostname |
|*port* | `_\|_` |DB port |
|*info* | `_\|_` |- |
_No output._
## rds.#User
@@ -61,21 +40,8 @@ Creates a new user credentials on an existing RDS Instance
### rds.#User Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.region* | `string` |AWS region |
|*config.accessKey* | `dagger.#Secret` |AWS access key |
|*config.secretKey* | `dagger.#Secret` |AWS secret key |
|*config.localMode* | `*false \| bool` |AWS localstack mode |
|*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) |
_No input._
### rds.#User Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*out* | `string` |Outputted username |
_No output._

16
docs/reference/aws/s3.md
View File

@@ -16,20 +16,8 @@ S3 Bucket object(s) sync
### s3.#Object Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.region* | `string` |AWS region |
|*config.accessKey* | `dagger.#Secret` |AWS access key |
|*config.secretKey* | `dagger.#Secret` |AWS secret key |
|*config.localMode* | `*false \| bool` |AWS localstack mode |
|*source* | `dagger.#Artifact` |Source Artifact to upload to S3 |
|*target* | `string` |Target S3 URL (eg. s3://\<bucket-name\>/\<path\>/\<sub-path\>) |
|*delete* | `*false \| true` |Delete files that already exist on remote destination |
|*contentType* | `*"" \| string` |Object content type |
|*always* | `*true \| false` |Always write the object to S3 |
_No input._
### s3.#Object Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*url* | `string` |URL of the uploaded S3 object |
_No output._