kjuulh/dagger
Archived
1
0
Fork 0
Code Issues 1 Pull Requests 1 Projects Releases Wiki Activity
This repository has been archived on 2024-04-08. You can view files and clone it, but cannot push or open issues or pull requests.
2a946385fa
dagger/docs/reference/argocd.md

138 lines
7.7 KiB
Markdown
Raw Normal View History

Update argocd documentation Signed-off-by: Tom Chauveau <tom.chauveau@epitech.eu>
2021-09-09 13:01:50 +02:00
---
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
Fix caching issue on argoCD package Signed-off-by: Tom Chauveau <tom.chauveau@epitech.eu>
2021-09-10 15:37:37 +02:00
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version |
|*config.server* | `string` |ArgoCD server |
|*config.project* | `*"default" \| string` |ArgoCD project |
Migrate dagger.#Secret and dagger.#Stream to new format - Refactored to keep every transformation of built-in types (e.g. FS, Secret, etc) to/from CUE in the same place (plancontext) - dagger.#Service and dagger.#Secret are now following the new FS-like format (e.g. `_service: id: string`) - Backward compatibility - dagger.#Stream is now an alias for dagger.#Service Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2021-12-01 02:51:28 +01:00
|*config.token* | `*null \| {}` |ArgoCD authentication token |
Fix caching issue on argoCD package Signed-off-by: Tom Chauveau <tom.chauveau@epitech.eu>
2021-09-10 15:37:37 +02:00
|*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 |
Migrate dagger.#Secret and dagger.#Stream to new format - Refactored to keep every transformation of built-in types (e.g. FS, Secret, etc) to/from CUE in the same place (plancontext) - dagger.#Service and dagger.#Secret are now following the new FS-like format (e.g. `_service: id: string`) - Backward compatibility - dagger.#Stream is now an alias for dagger.#Service Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2021-12-01 02:51:28 +01:00
|*image.config.token* | `*null \| {}` |ArgoCD authentication token |
Fix caching issue on argoCD package Signed-off-by: Tom Chauveau <tom.chauveau@epitech.eu>
2021-09-10 15:37:37 +02:00
|*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` |- |
Update argocd documentation Signed-off-by: Tom Chauveau <tom.chauveau@epitech.eu>
2021-09-09 13:01:50 +02:00
### argocd.#App Outputs
_No output._
## argocd.#CLI
Re-usable CLI component
### argocd.#CLI Inputs
Supports both basicAuth & Token Signed-off-by: Tom Chauveau <tom.chauveau@epitech.eu>
2021-09-10 11:13:10 +02:00
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version |
|*config.server* | `string` |ArgoCD server |
|*config.project* | `*"default" \| string` |ArgoCD project |
Migrate dagger.#Secret and dagger.#Stream to new format - Refactored to keep every transformation of built-in types (e.g. FS, Secret, etc) to/from CUE in the same place (plancontext) - dagger.#Service and dagger.#Secret are now following the new FS-like format (e.g. `_service: id: string`) - Backward compatibility - dagger.#Stream is now an alias for dagger.#Service Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2021-12-01 02:51:28 +01:00
|*config.token* | `*null \| {}` |ArgoCD authentication token |
Update argocd documentation Signed-off-by: Tom Chauveau <tom.chauveau@epitech.eu>
2021-09-09 13:01:50 +02:00
### argocd.#CLI Outputs
_No output._
## argocd.#Config
ArgoCD configuration
### argocd.#Config Inputs
Supports both basicAuth & Token Signed-off-by: Tom Chauveau <tom.chauveau@epitech.eu>
2021-09-10 11:13:10 +02:00
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version |
|*server* | `string` |ArgoCD server |
|*project* | `*"default" \| string` |ArgoCD project |
Migrate dagger.#Secret and dagger.#Stream to new format - Refactored to keep every transformation of built-in types (e.g. FS, Secret, etc) to/from CUE in the same place (plancontext) - dagger.#Service and dagger.#Secret are now following the new FS-like format (e.g. `_service: id: string`) - Backward compatibility - dagger.#Stream is now an alias for dagger.#Service Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2021-12-01 02:51:28 +01:00
|*token* | `*null \| {}` |ArgoCD authentication token |
Update argocd documentation Signed-off-by: Tom Chauveau <tom.chauveau@epitech.eu>
2021-09-09 13:01:50 +02:00
### argocd.#Config Outputs
_No output._
## argocd.#Status
Get application's status
### argocd.#Status Inputs
Supports both basicAuth & Token Signed-off-by: Tom Chauveau <tom.chauveau@epitech.eu>
2021-09-10 11:13:10 +02:00
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version |
|*config.server* | `string` |ArgoCD server |
|*config.project* | `*"default" \| string` |ArgoCD project |
Migrate dagger.#Secret and dagger.#Stream to new format - Refactored to keep every transformation of built-in types (e.g. FS, Secret, etc) to/from CUE in the same place (plancontext) - dagger.#Service and dagger.#Secret are now following the new FS-like format (e.g. `_service: id: string`) - Backward compatibility - dagger.#Stream is now an alias for dagger.#Service Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2021-12-01 02:51:28 +01:00
|*config.token* | `*null \| {}` |ArgoCD authentication token |
Supports both basicAuth & Token Signed-off-by: Tom Chauveau <tom.chauveau@epitech.eu>
2021-09-10 11:13:10 +02:00
|*name* | `string` |ArgoCD application |
Update argocd documentation Signed-off-by: Tom Chauveau <tom.chauveau@epitech.eu>
2021-09-09 13:01:50 +02:00
### 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
`argocd.#Sync` now retrieve status Signed-off-by: Tom Chauveau <tom.chauveau@epitech.eu>
2021-09-10 16:29:29 +02:00
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version |
|*config.server* | `string` |ArgoCD server |
|*config.project* | `*"default" \| string` |ArgoCD project |
Migrate dagger.#Secret and dagger.#Stream to new format - Refactored to keep every transformation of built-in types (e.g. FS, Secret, etc) to/from CUE in the same place (plancontext) - dagger.#Service and dagger.#Secret are now following the new FS-like format (e.g. `_service: id: string`) - Backward compatibility - dagger.#Stream is now an alias for dagger.#Service Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2021-12-01 02:51:28 +01:00
|*config.token* | `*null \| {}` |ArgoCD authentication token |
`argocd.#Sync` now retrieve status Signed-off-by: Tom Chauveau <tom.chauveau@epitech.eu>
2021-09-10 16:29:29 +02:00
|*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 |
Migrate dagger.#Secret and dagger.#Stream to new format - Refactored to keep every transformation of built-in types (e.g. FS, Secret, etc) to/from CUE in the same place (plancontext) - dagger.#Service and dagger.#Secret are now following the new FS-like format (e.g. `_service: id: string`) - Backward compatibility - dagger.#Stream is now an alias for dagger.#Service Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2021-12-01 02:51:28 +01:00
|*ctr.image.config.token* | `*null \| {}` |ArgoCD authentication token |
`argocd.#Sync` now retrieve status Signed-off-by: Tom Chauveau <tom.chauveau@epitech.eu>
2021-09-10 16:29:29 +02:00
|*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 |
Migrate dagger.#Secret and dagger.#Stream to new format - Refactored to keep every transformation of built-in types (e.g. FS, Secret, etc) to/from CUE in the same place (plancontext) - dagger.#Service and dagger.#Secret are now following the new FS-like format (e.g. `_service: id: string`) - Backward compatibility - dagger.#Stream is now an alias for dagger.#Service Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2021-12-01 02:51:28 +01:00
|*status.config.token* | `*null \| {}` |ArgoCD authentication token |
`argocd.#Sync` now retrieve status Signed-off-by: Tom Chauveau <tom.chauveau@epitech.eu>
2021-09-10 16:29:29 +02:00
|*status.name* | `string` |ArgoCD application |
Update argocd documentation Signed-off-by: Tom Chauveau <tom.chauveau@epitech.eu>
2021-09-09 13:01:50 +02:00
### argocd.#Sync Outputs
`argocd.#Sync` now retrieve status Signed-off-by: Tom Chauveau <tom.chauveau@epitech.eu>
2021-09-10 16:29:29 +02:00
| 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 |
Reference in New Issue Copy Permalink