docs: ♻️ merge API Reference and Universe menu entries
Signed-off-by: jffarge <jf@dagger.io>
This commit is contained in:
jffarge
43
docs/reference/gcp/README.md
Normal file
43
docs/reference/gcp/README.md
Normal file
@@ -0,0 +1,43 @@
|
||||
---
|
||||
sidebar_label: gcp
|
||||
---
|
||||
|
||||
# alpha.dagger.io/gcp
|
||||
|
||||
Google Cloud Platform
|
||||
|
||||
```cue
|
||||
import "alpha.dagger.io/gcp"
|
||||
```
|
||||
|
||||
## gcp.#Config
|
||||
|
||||
Base Google Cloud Config
|
||||
|
||||
### gcp.#Config Inputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*region* | `string` |GCP region |
|
||||
|*project* | `string` |GCP project |
|
||||
|*serviceKey* | `dagger.#Secret` |GCP service key |
|
||||
|
||||
### gcp.#Config Outputs
|
||||
|
||||
_No output._
|
||||
|
||||
## gcp.#GCloud
|
||||
|
||||
Re-usable gcloud component
|
||||
|
||||
### gcp.#GCloud Inputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*config.region* | `string` |GCP region |
|
||||
|*config.project* | `string` |GCP project |
|
||||
|*config.serviceKey* | `dagger.#Secret` |GCP service key |
|
||||
|
||||
### gcp.#GCloud Outputs
|
||||
|
||||
_No output._
|
||||
29
docs/reference/gcp/cloudrun.md
Normal file
29
docs/reference/gcp/cloudrun.md
Normal file
@@ -0,0 +1,29 @@
|
||||
---
|
||||
sidebar_label: cloudrun
|
||||
---
|
||||
|
||||
# alpha.dagger.io/gcp/cloudrun
|
||||
|
||||
```cue
|
||||
import "alpha.dagger.io/gcp/cloudrun"
|
||||
```
|
||||
|
||||
## cloudrun.#Service
|
||||
|
||||
Service deploys a Cloud Run service based on provided GCR image
|
||||
|
||||
### cloudrun.#Service Inputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*config.region* | `string` |GCP region |
|
||||
|*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 |
|
||||
|
||||
### cloudrun.#Service Outputs
|
||||
|
||||
_No output._
|
||||
30
docs/reference/gcp/gcr.md
Normal file
30
docs/reference/gcp/gcr.md
Normal file
@@ -0,0 +1,30 @@
|
||||
---
|
||||
sidebar_label: gcr
|
||||
---
|
||||
|
||||
# alpha.dagger.io/gcp/gcr
|
||||
|
||||
Google Container Registry
|
||||
|
||||
```cue
|
||||
import "alpha.dagger.io/gcp/gcr"
|
||||
```
|
||||
|
||||
## gcr.#Credentials
|
||||
|
||||
Credentials retriever for GCR
|
||||
|
||||
### gcr.#Credentials Inputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*config.region* | `string` |GCP region |
|
||||
|*config.project* | `string` |GCP project |
|
||||
|*config.serviceKey* | `dagger.#Secret` |GCP service key |
|
||||
|
||||
### gcr.#Credentials Outputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*username* | `"oauth2accesstoken"` |GCR registry username |
|
||||
|*secret* | `string` |GCR registry secret |
|
||||
34
docs/reference/gcp/gcs.md
Normal file
34
docs/reference/gcp/gcs.md
Normal file
@@ -0,0 +1,34 @@
|
||||
---
|
||||
sidebar_label: gcs
|
||||
---
|
||||
|
||||
# alpha.dagger.io/gcp/gcs
|
||||
|
||||
Google Cloud Storage
|
||||
|
||||
```cue
|
||||
import "alpha.dagger.io/gcp/gcs"
|
||||
```
|
||||
|
||||
## gcs.#Object
|
||||
|
||||
GCS Bucket object(s) sync
|
||||
|
||||
### gcs.#Object Inputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*config.region* | `string` |GCP region |
|
||||
|*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 |
|
||||
|
||||
### gcs.#Object Outputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*url* | `string` |URL of the uploaded GCS object |
|
||||
31
docs/reference/gcp/gke.md
Normal file
31
docs/reference/gcp/gke.md
Normal file
@@ -0,0 +1,31 @@
|
||||
---
|
||||
sidebar_label: gke
|
||||
---
|
||||
|
||||
# alpha.dagger.io/gcp/gke
|
||||
|
||||
Google Kubernetes Engine
|
||||
|
||||
```cue
|
||||
import "alpha.dagger.io/gcp/gke"
|
||||
```
|
||||
|
||||
## gke.#KubeConfig
|
||||
|
||||
KubeConfig config outputs a valid kube-auth-config for kubectl client
|
||||
|
||||
### gke.#KubeConfig Inputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*config.region* | `string` |GCP region |
|
||||
|*config.project* | `string` |GCP project |
|
||||
|*config.serviceKey* | `dagger.#Secret` |GCP service key |
|
||||
|*clusterName* | `string` |GKE cluster name |
|
||||
|*version* | `*"v1.19.9" \| string` |Kubectl version |
|
||||
|
||||
### gke.#KubeConfig Outputs
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------- |:-------------: |:-------------: |
|
||||
|*kubeconfig* | `string` |kubeconfig is the generated kube configuration file |
|
||||
Reference in New Issue
Block a user