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

docs: ♻️ merge API Reference and Universe menu entries

Browse Source 
Signed-off-by: jffarge <jf@dagger.io>
This commit is contained in:
jffarge
2021-09-08 15:19:19 +02:00
parent a0d133c998
commit a2088a09ac
41 changed files with 32 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
docs/reference/kubernetes/README.md Normal file
View File

@@ -0,0 +1,44 @@
---
sidebar_label: kubernetes
---
# alpha.dagger.io/kubernetes
Kubernetes client operations
```cue
import "alpha.dagger.io/kubernetes"
```
## kubernetes.#Kubectl
Kubectl client
### kubernetes.#Kubectl Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*version* | `*"v1.19.9" \| string` |Kubectl version |
### kubernetes.#Kubectl Outputs
_No output._
## kubernetes.#Resources
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` |Kube config file |
### kubernetes.#Resources Outputs
_No output._

33
docs/reference/kubernetes/helm.md Normal file
View File

@@ -0,0 +1,33 @@
---
sidebar_label: helm
---
# alpha.dagger.io/kubernetes/helm
Helm package manager
```cue
import "alpha.dagger.io/kubernetes/helm"
```
## helm.#Chart
Install a Helm chart
### helm.#Chart Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*name* | `string` |Helm deployment name |
|*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` |Kube config file |
|*version* | `*"3.5.2" \| string` |Helm version |
|*kubectlVersion* | `*"v1.19.9" \| string` |Kubectl version |
### helm.#Chart Outputs
_No output._

39
docs/reference/kubernetes/kustomize.md Normal file
View File

@@ -0,0 +1,39 @@
---
sidebar_label: kustomize
---
# alpha.dagger.io/kubernetes/kustomize
Kustomize config management
```cue
import "alpha.dagger.io/kubernetes/kustomize"
```
## kustomize.#Kustomization
### kustomize.#Kustomization Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*version* | `*"v3.8.7" \| string` |Kustomize binary version |
### kustomize.#Kustomization Outputs
_No output._
## kustomize.#Kustomize
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 |
### kustomize.#Kustomize Outputs
_No output._