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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
docs/reference/argocd.md
View File

@ -16,26 +16,7 @@ Create an ArgoCD application
### argocd.#App Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version |
|*config.server* | `string` |ArgoCD server |
|*config.project* | `*"default" \| string` |ArgoCD project |
|*config.token* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |ArgoCD authentication token |
|*name* | `string` |App name |
|*repo* | `string` |Repository url (git or helm) |
|*path* | `string` |Folder to deploy |
|*server* | `*"https://kubernetes.default.svc" \| string` |Destination server |
|*image.config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version |
|*image.config.server* | `string` |ArgoCD server |
|*image.config.project* | `*"default" \| string` |ArgoCD project |
|*image.config.token* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |ArgoCD authentication token |
|*namespace* | `*"default" \| string` |Destination namespace |
|*env.APP_NAME* | `string` |- |
|*env.APP_REPO* | `string` |- |
|*env.APP_PATH* | `string` |- |
|*env.APP_SERVER* | `*"https://kubernetes.default.svc" \| string` |- |
|*env.APP_NAMESPACE* | `*"default" \| string` |- |
_No input._
### argocd.#App Outputs
@ -47,12 +28,7 @@ Re-usable CLI component
### argocd.#CLI Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version |
|*config.server* | `string` |ArgoCD server |
|*config.project* | `*"default" \| string` |ArgoCD project |
|*config.token* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |ArgoCD authentication token |
_No input._
### argocd.#CLI Outputs
@ -64,12 +40,7 @@ ArgoCD configuration
### argocd.#Config Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version |
|*server* | `string` |ArgoCD server |
|*project* | `*"default" \| string` |ArgoCD project |
|*token* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |ArgoCD authentication token |
_No input._
### argocd.#Config Outputs
@ -81,24 +52,11 @@ Get application's status
### argocd.#Status Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version |
|*config.server* | `string` |ArgoCD server |
|*config.project* | `*"default" \| string` |ArgoCD project |
|*config.token* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |ArgoCD authentication token |
|*name* | `string` |ArgoCD application |
_No input._
### argocd.#Status Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*outputs.health* | `string` |Application health |
|*outputs.sync* | `string` |Application sync state |
|*outputs.namespace* | `string` |Namespace |
|*outputs.server* | `string` |Server |
|*outputs.urls* | `string` |Comma separated list of application URLs |
|*outputs.state* | `string` |Last operation state message |
_No output._
## argocd.#Sync
@ -106,32 +64,8 @@ Sync an application to its target state
### argocd.#Sync Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version |
|*config.server* | `string` |ArgoCD server |
|*config.project* | `*"default" \| string` |ArgoCD project |
|*config.token* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |ArgoCD authentication token |
|*application* | `string` |ArgoCD application |
|*wait* | `*false \| bool` |Wait the application to sync correctly |
|*ctr.image.config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version |
|*ctr.image.config.server* | `string` |ArgoCD server |
|*ctr.image.config.project* | `*"default" \| string` |ArgoCD project |
|*ctr.image.config.token* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |ArgoCD authentication token |
|*ctr.env.APPLICATION* | `string` |- |
|*status.config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version |
|*status.config.server* | `string` |ArgoCD server |
|*status.config.project* | `*"default" \| string` |ArgoCD project |
|*status.config.token* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |ArgoCD authentication token |
|*status.name* | `string` |ArgoCD application |
_No input._
### argocd.#Sync Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*status.outputs.health* | `string` |Application health |
|*status.outputs.sync* | `string` |Application sync state |
|*status.outputs.namespace* | `string` |Namespace |
|*status.outputs.server* | `string` |Server |
|*status.outputs.urls* | `string` |Comma separated list of application URLs |
|*status.outputs.state* | `string` |Last operation state message |
_No output._

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._

19
docs/reference/azure/README.md
View File

@ -16,17 +16,7 @@ Azure Cli to be used by all Azure packages
### azure.#CLI Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.tenantId* | `dagger.#Secret` |AZURE tenant id |
|*config.subscriptionId* | `dagger.#Secret` |AZURE subscription id |
|*config.appId* | `dagger.#Secret` |AZURE app id for the service principal used |
|*config.password* | `dagger.#Secret` |AZURE password for the service principal used |
|*image.from* | `"mcr.microsoft.com/azure-cli:2.27.1@sha256:1e117183100c9fce099ebdc189d73e506e7b02d2b73d767d3fc07caee72f9fb1"` |Remote ref (example: "index.docker.io/alpine:latest") |
|*secret."/run/secrets/appId"* | `dagger.#Secret` |- |
|*secret."/run/secrets/password"* | `dagger.#Secret` |- |
|*secret."/run/secrets/tenantId"* | `dagger.#Secret` |- |
|*secret."/run/secrets/subscriptionId"* | `dagger.#Secret` |- |
_No input._
### azure.#CLI Outputs
@ -38,12 +28,7 @@ Azure Config shared by all Azure packages
### azure.#Config Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*tenantId* | `dagger.#Secret` |AZURE tenant id |
|*subscriptionId* | `dagger.#Secret` |AZURE subscription id |
|*appId* | `dagger.#Secret` |AZURE app id for the service principal used |
|*password* | `dagger.#Secret` |AZURE password for the service principal used |
_No input._
### azure.#Config Outputs

24
docs/reference/azure/resourcegroup.md
View File

@ -14,28 +14,8 @@ Create a resource group
### resourcegroup.#ResourceGroup Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.tenantId* | `dagger.#Secret` |AZURE tenant id |
|*config.subscriptionId* | `dagger.#Secret` |AZURE subscription id |
|*config.appId* | `dagger.#Secret` |AZURE app id for the service principal used |
|*config.password* | `dagger.#Secret` |AZURE password for the service principal used |
|*rgName* | `string` |ResourceGroup name |
|*rgLocation* | `string` |ResourceGroup location |
|*ctr.image.config.tenantId* | `dagger.#Secret` |AZURE tenant id |
|*ctr.image.config.subscriptionId* | `dagger.#Secret` |AZURE subscription id |
|*ctr.image.config.appId* | `dagger.#Secret` |AZURE app id for the service principal used |
|*ctr.image.config.password* | `dagger.#Secret` |AZURE password for the service principal used |
|*ctr.image.image.from* | `"mcr.microsoft.com/azure-cli:2.27.1@sha256:1e117183100c9fce099ebdc189d73e506e7b02d2b73d767d3fc07caee72f9fb1"` |Remote ref (example: "index.docker.io/alpine:latest") |
|*ctr.image.secret."/run/secrets/appId"* | `dagger.#Secret` |- |
|*ctr.image.secret."/run/secrets/password"* | `dagger.#Secret` |- |
|*ctr.image.secret."/run/secrets/tenantId"* | `dagger.#Secret` |- |
|*ctr.image.secret."/run/secrets/subscriptionId"* | `dagger.#Secret` |- |
|*ctr.env.AZURE_DEFAULTS_GROUP* | `string` |- |
|*ctr.env.AZURE_DEFAULTS_LOCATION* | `string` |- |
_No input._
### resourcegroup.#ResourceGroup Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*id* | `string` |ResourceGroup Id Resource Id |
_No output._

36
docs/reference/azure/staticwebapp.md
View File

@ -14,40 +14,8 @@ Create a static web app
### staticwebapp.#StaticWebApp Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.tenantId* | `dagger.#Secret` |AZURE tenant id |
|*config.subscriptionId* | `dagger.#Secret` |AZURE subscription id |
|*config.appId* | `dagger.#Secret` |AZURE app id for the service principal used |
|*config.password* | `dagger.#Secret` |AZURE password for the service principal used |
|*rgName* | `string` |ResourceGroup name in which to create static webapp |
|*stappLocation* | `string` |StaticWebApp location |
|*stappName* | `string` |StaticWebApp name |
|*remote* | `string` |GitHubRepository URL |
|*ref* | `*"main" \| string` |GitHub Branch |
|*appLocation* | `*"/" \| string` |Location of your application code |
|*buildLocation* | `*"build" \| string` |Location of your build artifacts |
|*authToken* | `dagger.#Secret` |GitHub Personal Access Token |
|*ctr.image.config.tenantId* | `dagger.#Secret` |AZURE tenant id |
|*ctr.image.config.subscriptionId* | `dagger.#Secret` |AZURE subscription id |
|*ctr.image.config.appId* | `dagger.#Secret` |AZURE app id for the service principal used |
|*ctr.image.config.password* | `dagger.#Secret` |AZURE password for the service principal used |
|*ctr.image.image.from* | `"mcr.microsoft.com/azure-cli:2.27.1@sha256:1e117183100c9fce099ebdc189d73e506e7b02d2b73d767d3fc07caee72f9fb1"` |Remote ref (example: "index.docker.io/alpine:latest") |
|*ctr.image.secret."/run/secrets/appId"* | `dagger.#Secret` |- |
|*ctr.image.secret."/run/secrets/password"* | `dagger.#Secret` |- |
|*ctr.image.secret."/run/secrets/tenantId"* | `dagger.#Secret` |- |
|*ctr.image.secret."/run/secrets/subscriptionId"* | `dagger.#Secret` |- |
|*ctr.env.AZURE_DEFAULTS_GROUP* | `string` |- |
|*ctr.env.AZURE_DEFAULTS_LOCATION* | `string` |- |
|*ctr.env.AZURE_STATICWEBAPP_NAME* | `string` |- |
|*ctr.env.GIT_URL* | `string` |- |
|*ctr.env.GIT_BRANCH* | `*"main" \| string` |- |
|*ctr.env.APP_LOCATION* | `*"/" \| string` |- |
|*ctr.env.BUILD_LOCATION* | `*"build" \| string` |- |
|*ctr.secret."/run/secrets/git_pat"* | `dagger.#Secret` |- |
_No input._
### staticwebapp.#StaticWebApp Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*defaultHostName* | `string` |DefaultHostName generated by Azure |
_No output._

26
docs/reference/azure/storage.md
View File

@ -14,30 +14,8 @@ Create a storage account
### storage.#StorageAccount Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.tenantId* | `dagger.#Secret` |AZURE tenant id |
|*config.subscriptionId* | `dagger.#Secret` |AZURE subscription id |
|*config.appId* | `dagger.#Secret` |AZURE app id for the service principal used |
|*config.password* | `dagger.#Secret` |AZURE password for the service principal used |
|*rgName* | `string` |ResourceGroup name |
|*stLocation* | `string` |StorageAccount location |
|*stName* | `string` |StorageAccount name |
|*ctr.image.config.tenantId* | `dagger.#Secret` |AZURE tenant id |
|*ctr.image.config.subscriptionId* | `dagger.#Secret` |AZURE subscription id |
|*ctr.image.config.appId* | `dagger.#Secret` |AZURE app id for the service principal used |
|*ctr.image.config.password* | `dagger.#Secret` |AZURE password for the service principal used |
|*ctr.image.image.from* | `"mcr.microsoft.com/azure-cli:2.27.1@sha256:1e117183100c9fce099ebdc189d73e506e7b02d2b73d767d3fc07caee72f9fb1"` |Remote ref (example: "index.docker.io/alpine:latest") |
|*ctr.image.secret."/run/secrets/appId"* | `dagger.#Secret` |- |
|*ctr.image.secret."/run/secrets/password"* | `dagger.#Secret` |- |
|*ctr.image.secret."/run/secrets/tenantId"* | `dagger.#Secret` |- |
|*ctr.image.secret."/run/secrets/subscriptionId"* | `dagger.#Secret` |- |
|*ctr.env.AZURE_DEFAULTS_GROUP* | `string` |- |
|*ctr.env.AZURE_DEFAULTS_LOCATION* | `string` |- |
|*ctr.env.AZURE_STORAGE_ACCOUNT* | `string` |- |
_No input._
### storage.#StorageAccount Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*id* | `string` |StorageAccount Id |
_No output._

5
docs/reference/bats.md
View File

@ -12,10 +12,7 @@ import "alpha.dagger.io/bats"
### bats.#Bats Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*source* | `dagger.#Artifact` |Source containing bats files |
|*ctr.mount."/src".from* | `dagger.#Artifact` |- |
_No input._
### bats.#Bats Outputs

34
docs/reference/docker/README.md
View File

@ -16,10 +16,7 @@ Build a Docker image from source
### docker.#Build Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*source* | `dagger.#Artifact` |Build context |
|*dockerfile* | `*null \| string` |Dockerfile passed as a string |
_No input._
### docker.#Build Outputs
@ -43,16 +40,11 @@ Load a docker image into a docker engine
### docker.#Load Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*tag* | `string` |Name and optionally a tag in the 'name:tag' format |
|*source* | `dagger.#Artifact` |Image source |
_No input._
### docker.#Load Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*id* | `string` |Image ID |
_No output._
## docker.#Pull
@ -60,9 +52,7 @@ Pull a docker container
### docker.#Pull Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*from* | `string` |Remote ref (example: "index.docker.io/alpine:latest") |
_No input._
### docker.#Pull Outputs
@ -74,27 +64,17 @@ Push a docker image to a remote registry
### docker.#Push Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*target* | `string` |Remote target (example: "index.docker.io/alpine:latest") |
|*source* | `dagger.#Artifact` |Image source |
_No input._
### docker.#Push Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*ref* | `string` |Image ref |
|*digest* | `string` |Image digest |
_No output._
## docker.#Run
### docker.#Run Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*ref* | `string` |Image reference (e.g: nginx:alpine) |
|*recreate* | `*true \| bool` |Recreate container? |
|*run.env.IMAGE_REF* | `string` |- |
_No input._
### docker.#Run Outputs

5
docs/reference/docker/compose.md
View File

@ -14,10 +14,7 @@ import "alpha.dagger.io/docker/compose"
### compose.#App Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*name* | `*"source" \| string` |App name (use as COMPOSE_PROJECT_NAME) |
|*registries* | `[...{\n username: string\n secret: {\n $dagger: {\n secret: {}\n }\n }\n}]` |Image registries |
_No input._
### compose.#App Outputs

14
docs/reference/gcp/README.md
View File

@ -16,12 +16,7 @@ Base Google Cloud Config
### gcp.#Config Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*region* | `*null \| string` |GCP region |
|*zone* | `*null \| string` |GCP zone |
|*project* | `string` |GCP project |
|*serviceKey* | `dagger.#Secret` |GCP service key |
_No input._
### gcp.#Config Outputs
@ -33,12 +28,7 @@ Re-usable gcloud component
### gcp.#GCloud Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.region* | `*null \| string` |GCP region |
|*config.zone* | `*null \| string` |GCP zone |
|*config.project* | `string` |GCP project |
|*config.serviceKey* | `dagger.#Secret` |GCP service key |
_No input._
### gcp.#GCloud Outputs

11
docs/reference/gcp/cloudrun.md
View File

@ -14,16 +14,7 @@ Service deploys a Cloud Run service based on provided GCR image
### cloudrun.#Service Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.region* | `*null \| string` |GCP region |
|*config.zone* | `*null \| string` |GCP zone |
|*config.project* | `string` |GCP project |
|*config.serviceKey* | `dagger.#Secret` |GCP service key |
|*name* | `string` |Cloud Run service name |
|*image* | `string` |GCR image ref |
|*platform* | `*"managed" \| string` |Cloud Run platform |
|*port* | `*"80" \| string` |Cloud Run service exposed port |
_No input._
### cloudrun.#Service Outputs

12
docs/reference/gcp/gcr.md
View File

@ -16,16 +16,8 @@ Credentials retriever for GCR
### gcr.#Credentials Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.region* | `*null \| string` |GCP region |
|*config.zone* | `*null \| string` |GCP zone |
|*config.project* | `string` |GCP project |
|*config.serviceKey* | `dagger.#Secret` |GCP service key |
_No input._
### gcr.#Credentials Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*username* | `"oauth2accesstoken"` |GCR registry username |
|*secret* | `string` |GCR registry secret |
_No output._

16
docs/reference/gcp/gcs.md
View File

@ -16,20 +16,8 @@ GCS Bucket object(s) sync
### gcs.#Object Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.region* | `*null \| string` |GCP region |
|*config.zone* | `*null \| string` |GCP zone |
|*config.project* | `string` |GCP project |
|*config.serviceKey* | `dagger.#Secret` |GCP service key |
|*source* | `dagger.#Artifact` |Source Artifact to upload to GCS |
|*target* | `string` |Target GCS URL (eg. gs://\<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 GCS |
_No input._
### gcs.#Object Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*url* | `string` |URL of the uploaded GCS object |
_No output._

13
docs/reference/gcp/gke.md
View File

@ -16,17 +16,8 @@ KubeConfig config outputs a valid kube-auth-config for kubectl client
### gke.#KubeConfig Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.region* | `*null \| string` |GCP region |
|*config.zone* | `*null \| string` |GCP zone |
|*config.project* | `string` |GCP project |
|*config.serviceKey* | `dagger.#Secret` |GCP service key |
|*clusterName* | `string` |GKE cluster name |
|*version* | `*"v1.19.9" \| string` |Kubectl version |
_No input._
### gke.#KubeConfig Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*kubeconfig* | `string` |kubeconfig is the generated kube configuration file |
_No output._

11
docs/reference/gcp/secretmanager.md
View File

@ -14,16 +14,7 @@ import "alpha.dagger.io/gcp/secretmanager"
### secretmanager.#Secrets Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.region* | `*null \| string` |GCP region |
|*config.zone* | `*null \| string` |GCP zone |
|*config.project* | `string` |GCP project |
|*config.serviceKey* | `dagger.#Secret` |GCP service key |
|*deployment.image.config.region* | `*null \| string` |GCP region |
|*deployment.image.config.zone* | `*null \| string` |GCP zone |
|*deployment.image.config.project* | `string` |GCP project |
|*deployment.image.config.serviceKey* | `dagger.#Secret` |GCP service key |
_No input._
### secretmanager.#Secrets Outputs

38
docs/reference/git.md
View File

@ -16,21 +16,11 @@ Commit & push to git repository
### git.#Commit Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*repository.remote* | `string` |Repository remote URL |
|*repository.authToken* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |Authentication token (PAT or password) |
|*repository.branch* | `string` |Git branch |
|*name* | `string` |Username |
|*email* | `string` |Email |
|*message* | `string` |Commit message |
|*force* | `*false \| bool` |Force push options |
_No input._
### git.#Commit Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*hash* | `string` |Commit hash |
_No output._
## git.#CurrentBranch
@ -38,15 +28,11 @@ Get the name of the current checked out branch or tag
### git.#CurrentBranch Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*repository* | `dagger.#Artifact` |Git repository |
_No input._
### git.#CurrentBranch Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*name* | `string` |Git branch name |
_No output._
## git.#Image
@ -64,13 +50,7 @@ A git repository
### git.#Repository Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*remote* | `string` |Git remote link |
|*ref* | `string` |Git ref: can be a commit, tag or branch. Example: "main" |
|*subdir* | `*null \| string` |(optional) Subdirectory |
|*authToken* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |(optional) Add Personal Access Token |
|*authHeader* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |(optional) Add OAuth Token |
_No input._
### git.#Repository Outputs
@ -82,12 +62,8 @@ List tags of a repository
### git.#Tags Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*repository* | `dagger.#Artifact` |Git repository |
_No input._
### git.#Tags Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*tags* | `[...string]` |Repository tags |
_No output._

33
docs/reference/go.md
View File

@ -16,21 +16,11 @@ Go application builder
### go.#Build Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*version* | `*"1.16" \| string` |Go version to use |
|*source* | `dagger.#Artifact` |Source Directory to build |
|*packages* | `*"." \| string` |Packages to build |
|*arch* | `*"amd64" \| string` |Target architecture |
|*os* | `*"linux" \| string` |Target OS |
|*tags* | `*"" \| string` |Build tags to use for building |
|*ldflags* | `*"" \| string` |LDFLAGS to use for linking |
_No input._
### go.#Build Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*output* | `string` |Specify the targeted binary name |
_No output._
## go.#Container
@ -38,11 +28,7 @@ A standalone go environment
### go.#Container Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*version* | `*"1.16" \| string` |Go version to use |
|*source* | `dagger.#Artifact` |Source code |
|*image.from* | `"docker.io/golang:1.16-alpine"` |Remote ref (example: "index.docker.io/alpine:latest") |
_No input._
### go.#Container Outputs
@ -54,11 +40,7 @@ Re-usable component for the Go compiler
### go.#Go Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*version* | `*"1.16" \| string` |Go version to use |
|*args* | `[...string]` |Arguments to the Go binary |
|*source* | `dagger.#Artifact` |Source Directory to build |
_No input._
### go.#Go Outputs
@ -68,12 +50,7 @@ _No output._
### go.#Test Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*version* | `*"1.16" \| string` |Go version to use |
|*source* | `dagger.#Artifact` |Source Directory to build |
|*packages* | `*"." \| string` |Packages to test |
|*args* | `["test", "-v", *"." \| string]` |Arguments to the Go binary |
_No input._
### go.#Test Outputs

6
docs/reference/graphql.md
View File

@ -16,8 +16,4 @@ _No input._
### graphql.#Query Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*post.statusCode* | `string` |- |
|*post.body* | `string` |- |
|*data* | `_\|_` |- |
_No output._

25
docs/reference/http.md
View File

@ -16,10 +16,7 @@ _No input._
### http.#Delete Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*statusCode* | `string` |- |
|*body* | `string` |- |
_No output._
## http.#Do
@ -29,10 +26,7 @@ _No input._
### http.#Do Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*statusCode* | `string` |- |
|*body* | `string` |- |
_No output._
## http.#Get
@ -42,10 +36,7 @@ _No input._
### http.#Get Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*statusCode* | `string` |- |
|*body* | `string` |- |
_No output._
## http.#Post
@ -55,10 +46,7 @@ _No input._
### http.#Post Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*statusCode* | `string` |- |
|*body* | `string` |- |
_No output._
## http.#Put
@ -68,10 +56,7 @@ _No input._
### http.#Put Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*statusCode* | `string` |- |
|*body* | `string` |- |
_No output._
## http.#Wait

13
docs/reference/java/maven.md
View File

@ -16,17 +16,8 @@ A Maven project
### maven.#Project Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*source* | `dagger.#Artifact` |Application source code |
|*package* | `struct` |Extra alpine packages to install |
|*env* | `struct` |Environment variables |
|*phases* | `*["package"] \| [...string]` |- |
|*goals* | `*[] \| [...string]` |- |
|*args* | `*[] \| [...string]` |Optional arguments for the script |
_No input._
### maven.#Project Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*build* | `struct` |Build output directory |
_No output._

15
docs/reference/js/yarn.md
View File

@ -16,19 +16,8 @@ A Yarn package
### yarn.#Package Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*source* | `dagger.#Artifact` |Application source code |
|*package* | `struct` |Extra alpine packages to install |
|*cwd* | `*"." \| string` |working directory to use |
|*env* | `struct` |Environment variables |
|*writeEnvFile* | `*"" \| string` |Write the contents of `environment` to this file, in the "envfile" format |
|*buildDir* | `*"build" \| string` |Read build output from this directory (path must be relative to working directory) |
|*script* | `*"build" \| string` |Run this yarn script |
|*args* | `*[] \| [...string]` |Optional arguments for the script |
_No input._
### yarn.#Package Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*build* | `struct` |Build output directory |
_No output._

13
docs/reference/kubernetes/README.md
View File

@ -16,9 +16,7 @@ Kubectl client
### kubernetes.#Kubectl Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*version* | `*"v1.19.9" \| string` |Kubectl version |
_No input._
### kubernetes.#Kubectl Outputs
@ -30,14 +28,7 @@ Apply Kubernetes resources
### kubernetes.#Resources Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*source* | `dagger.#Artifact` |Kubernetes config to deploy |
|*manifest* | `*null \| string` |Kubernetes manifest to deploy inlined in a string |
|*url* | `*null \| string` |Kubernetes manifest url to deploy remote configuration |
|*namespace* | `*"default" \| string` |Kubernetes Namespace to deploy to |
|*version* | `*"v1.19.9" \| string` |Version of kubectl client |
|*kubeconfig* | `(string\|struct)` |Kube config file |
_No input._
### kubernetes.#Resources Outputs

15
docs/reference/kubernetes/helm.md
View File

@ -16,20 +16,7 @@ Install a Helm chart
### helm.#Chart Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*name* | `string` |Helm deployment name |
|*chart* | `*null \| string` |Helm chart to install from repository |
|*repository* | `*null \| string` |Helm chart repository |
|*values* | `*null \| string` |Helm values (either a YAML string or a Cue structure) |
|*namespace* | `string` |Kubernetes Namespace to deploy to |
|*action* | `*"installOrUpgrade" \| "install" \| "upgrade"` |Helm action to apply |
|*timeout* | `*"5m" \| string` |time to wait for any individual Kubernetes operation (like Jobs for hooks) |
|*wait* | `*true \| bool` |if set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. It will wait for as long as timeout |
|*atomic* | `*true \| bool` |if set, installation process purges chart on fail. The wait option will be set automatically if atomic is used |
|*kubeconfig* | `(string\|struct)` |Kube config file |
|*version* | `*"3.5.2" \| string` |Helm version |
|*kubectlVersion* | `*"v1.19.9" \| string` |Kubectl version |
_No input._
### helm.#Chart Outputs

10
docs/reference/kubernetes/kustomize.md
View File

@ -14,9 +14,7 @@ import "alpha.dagger.io/kubernetes/kustomize"
### kustomize.#Kustomization Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*version* | `*"v3.8.7" \| string` |Kustomize binary version |
_No input._
### kustomize.#Kustomization Outputs
@ -28,11 +26,7 @@ Apply a Kubernetes Kustomize folder
### kustomize.#Kustomize Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*source* | `dagger.#Artifact` |Kubernetes source |
|*kustomization* | `string` |Optional Kustomization file |
|*version* | `*"v3.8.7" \| string` |Kustomize binary version |
_No input._
### kustomize.#Kustomize Outputs

19
docs/reference/netlify.md
View File

@ -16,10 +16,7 @@ Netlify account credentials
### netlify.#Account Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*name* | `*"" \| string` |Use this Netlify account name (also referred to as "team" in the Netlify docs) |
|*token* | `dagger.#Secret` |Netlify authentication token |
_No input._
### netlify.#Account Outputs
@ -31,18 +28,8 @@ Netlify site
### netlify.#Site Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*account.name* | `*"" \| string` |Use this Netlify account name (also referred to as "team" in the Netlify docs) |
|*account.token* | `dagger.#Secret` |Netlify authentication token |
|*contents* | `dagger.#Artifact` |Contents of the application to deploy |
|*name* | `string` |Deploy to this Netlify site |
|*create* | `*true \| bool` |Create the Netlify site if it doesn't exist? |
_No input._
### netlify.#Site Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*url* | `string` |Website url |
|*deployUrl* | `string` |Unique Deploy URL |
|*logsUrl* | `string` |Logs URL for this deployment |
_No output._

9
docs/reference/random.md
View File

@ -16,13 +16,8 @@ Generate a random string
### random.#String Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*seed* | `string` |Seed of the random string to generate. When using the same `seed`, the same random string will be generated because of caching. |
|*length* | `*12 \| number` |length of the string |
_No input._
### random.#String Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*out* | `string` |generated random string |
_No output._

9
docs/reference/terraform.md
View File

@ -16,13 +16,8 @@ Terraform configuration
### terraform.#Configuration Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*version* | `*"latest" \| string` |Terraform version |
|*source* | `dagger.#Artifact` |Source configuration |
_No input._
### terraform.#Configuration Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*output* | `struct` |- |
_No output._

4
docs/reference/trivy.md
View File

@ -42,6 +42,4 @@ _No input._
### trivy.#Image Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*ref* | `string` |Reference analyzed |
_No output._