From 9337eed2bb5b09c9b00fc40e893ec6de31b43b73 Mon Sep 17 00:00:00 2001 From: Tom Chauveau Date: Thu, 9 Sep 2021 13:01:50 +0200 Subject: [PATCH] Update argocd documentation Signed-off-by: Tom Chauveau --- docs/reference/README.md | 3 +- docs/reference/argocd.md | 111 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 112 insertions(+), 2 deletions(-) create mode 100644 docs/reference/argocd.md diff --git a/docs/reference/README.md b/docs/reference/README.md index 11758391..734ab675 100644 --- a/docs/reference/README.md +++ b/docs/reference/README.md @@ -1,8 +1,7 @@ # Index - [alpine](./alpine.md) - Base package for Alpine Linux -- [argocd](./argocd/README.md) - ArgoCD client operations -- [argocd/app](./argocd/app.md) - ArgoCD applications +- [argocd](./argocd.md) - ArgoCD client operations - [aws](./aws/README.md) - AWS base package - [aws/cloudformation](./aws/cloudformation.md) - AWS CloudFormation - [aws/ecr](./aws/ecr.md) - Amazon Elastic Container Registry (ECR) diff --git a/docs/reference/argocd.md b/docs/reference/argocd.md new file mode 100644 index 00000000..4ebc5a03 --- /dev/null +++ b/docs/reference/argocd.md @@ -0,0 +1,111 @@ +--- +sidebar_label: argocd +--- + +# alpha.dagger.io/argocd + +ArgoCD client operations + +```cue +import "alpha.dagger.io/argocd" +``` + +## argocd.#App + +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* | `dagger.#Secret` |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 | +|*namespace* | `*"default" \| string` |Destination namespace | + +### argocd.#App Outputs + +_No output._ + +## argocd.#CLI + +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* | `dagger.#Secret` |ArgoCD authentication token | + +### argocd.#CLI Outputs + +_No output._ + +## argocd.#Config + +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* | `dagger.#Secret` |ArgoCD authentication token | + +### argocd.#Config Outputs + +_No output._ + +## argocd.#Status + +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* | `dagger.#Secret` |ArgoCD authentication token | +|*name* | `string` |ArgoCD application | + +### 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 | + +## argocd.#Sync + +Sync an application to its targer 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* | `dagger.#Secret` |ArgoCD authentication token | +|*application* | `string` |ArgoCD application | +|*wait* | `*false \| bool` |Wait the application to sync correctly | + +### argocd.#Sync Outputs + +_No output._