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

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