docs: ♻️ merge API Reference and Universe menu entries
Signed-off-by: jffarge <jf@dagger.io>
This commit is contained in:
jffarge
45
docs/reference/aws/README.md
Normal file
45
docs/reference/aws/README.md
Normal file
@@ -0,0 +1,45 @@
|
||||
---
|
||||
sidebar_label: aws
|
||||
---
|
||||
|
||||
# alpha.dagger.io/aws
|
||||
|
||||
AWS base package
|
||||
|
||||
```cue
|
||||
import "alpha.dagger.io/aws"
|
||||
```
|
||||
|
||||
## aws.#CLI
|
||||
|
||||
Re-usable aws-cli component
|
||||
|
||||
### 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 |
|
||||
|
||||
### aws.#CLI Outputs
|
||||
|
||||
_No output._
|
||||
|
||||
## aws.#Config
|
||||
|
||||
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 |
|
||||
|
||||
### aws.#Config Outputs
|
||||
|
||||
_No output._
|
||||
34
docs/reference/aws/cloudformation.md
Normal file
34
docs/reference/aws/cloudformation.md
Normal file
@@ -0,0 +1,34 @@
|
||||
---
|
||||
sidebar_label: cloudformation
|
||||
---
|
||||
|
||||
# alpha.dagger.io/aws/cloudformation
|
||||
|
||||
AWS CloudFormation
|
||||
|
||||
```cue
|
||||
import "alpha.dagger.io/aws/cloudformation"
|
||||
```
|
||||
|
||||
## cloudformation.#Stack
|
||||
|
||||
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 |
|
||||
|
||||
### cloudformation.#Stack Outputs
|
||||
|
||||
_No output._
|
||||
35
docs/reference/aws/ecr.md
Normal file
35
docs/reference/aws/ecr.md
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
sidebar_label: ecr
|
||||
---
|
||||
|
||||
# alpha.dagger.io/aws/ecr
|
||||
|
||||
Amazon Elastic Container Registry (ECR)
|
||||
|
||||
```cue
|
||||
import "alpha.dagger.io/aws/ecr"
|
||||
```
|
||||
|
||||
## ecr.#Credentials
|
||||
|
||||
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 |
|
||||
|
||||
### ecr.#Credentials Outputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*username* | `"AWS"` |ECR registry |
|
||||
|*secret* | `string` |ECR registry secret |
|
||||
11
docs/reference/aws/ecs.md
Normal file
11
docs/reference/aws/ecs.md
Normal file
@@ -0,0 +1,11 @@
|
||||
---
|
||||
sidebar_label: ecs
|
||||
---
|
||||
|
||||
# alpha.dagger.io/aws/ecs
|
||||
|
||||
AWS Elastic Container Service (ECS)
|
||||
|
||||
```cue
|
||||
import "alpha.dagger.io/aws/ecs"
|
||||
```
|
||||
32
docs/reference/aws/eks.md
Normal file
32
docs/reference/aws/eks.md
Normal file
@@ -0,0 +1,32 @@
|
||||
---
|
||||
sidebar_label: eks
|
||||
---
|
||||
|
||||
# alpha.dagger.io/aws/eks
|
||||
|
||||
AWS Elastic Kubernetes Service (EKS)
|
||||
|
||||
```cue
|
||||
import "alpha.dagger.io/aws/eks"
|
||||
```
|
||||
|
||||
## eks.#KubeConfig
|
||||
|
||||
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 |
|
||||
|
||||
### eks.#KubeConfig Outputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*kubeconfig* | `string` |kubeconfig is the generated kube configuration file |
|
||||
31
docs/reference/aws/elb.md
Normal file
31
docs/reference/aws/elb.md
Normal file
@@ -0,0 +1,31 @@
|
||||
---
|
||||
sidebar_label: elb
|
||||
---
|
||||
|
||||
# alpha.dagger.io/aws/elb
|
||||
|
||||
AWS Elastic Load Balancer (ELBv2)
|
||||
|
||||
```cue
|
||||
import "alpha.dagger.io/aws/elb"
|
||||
```
|
||||
|
||||
## elb.#RandomRulePriority
|
||||
|
||||
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 |
|
||||
|
||||
### elb.#RandomRulePriority Outputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*priority* | `string` |exported priority |
|
||||
81
docs/reference/aws/rds.md
Normal file
81
docs/reference/aws/rds.md
Normal file
@@ -0,0 +1,81 @@
|
||||
---
|
||||
sidebar_label: rds
|
||||
---
|
||||
|
||||
# alpha.dagger.io/aws/rds
|
||||
|
||||
AWS Relational Database Service (RDS)
|
||||
|
||||
```cue
|
||||
import "alpha.dagger.io/aws/rds"
|
||||
```
|
||||
|
||||
## rds.#Database
|
||||
|
||||
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) |
|
||||
|
||||
### rds.#Database Outputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*out* | `string` |Name of the DB created |
|
||||
|
||||
## rds.#Instance
|
||||
|
||||
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 |
|
||||
|
||||
### rds.#Instance Outputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*hostname* | `_\|_` |DB hostname |
|
||||
|*port* | `_\|_` |DB port |
|
||||
|*info* | `_\|_` |- |
|
||||
|
||||
## rds.#User
|
||||
|
||||
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) |
|
||||
|
||||
### rds.#User Outputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*out* | `string` |Outputed username |
|
||||
35
docs/reference/aws/s3.md
Normal file
35
docs/reference/aws/s3.md
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
sidebar_label: s3
|
||||
---
|
||||
|
||||
# alpha.dagger.io/aws/s3
|
||||
|
||||
AWS Simple Storage Service
|
||||
|
||||
```cue
|
||||
import "alpha.dagger.io/aws/s3"
|
||||
```
|
||||
|
||||
## s3.#Object
|
||||
|
||||
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 |
|
||||
|
||||
### s3.#Object Outputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*url* | `string` |URL of the uploaded S3 object |
|
||||
Reference in New Issue
Block a user