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

add git + argocd docs

Browse Source 
Signed-off-by: Joel Longtine <joel@dagger.io>
This commit is contained in:
Joel Longtine 2021-12-16 15:37:55 -07:00
parent 86366b1f11
commit 64e9027bbe
2 changed files with 35 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
docs/reference/argocd.md
View File

@ -21,7 +21,7 @@ Create an ArgoCD application
|*config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version | |*config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version |
|*config.server* | `string` |ArgoCD server | |*config.server* | `string` |ArgoCD server |
|*config.project* | `*"default" \| string` |ArgoCD project | |*config.project* | `*"default" \| string` |ArgoCD project |
|*config.token* | `*null \| {}` |ArgoCD authentication token | |*config.token* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |ArgoCD authentication token |
|*name* | `string` |App name | |*name* | `string` |App name |
|*repo* | `string` |Repository url (git or helm) | |*repo* | `string` |Repository url (git or helm) |
|*path* | `string` |Folder to deploy | |*path* | `string` |Folder to deploy |
@ -29,7 +29,7 @@ Create an ArgoCD application
|*image.config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version | |*image.config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version |
|*image.config.server* | `string` |ArgoCD server | |*image.config.server* | `string` |ArgoCD server |
|*image.config.project* | `*"default" \| string` |ArgoCD project | |*image.config.project* | `*"default" \| string` |ArgoCD project |
|*image.config.token* | `*null \| {}` |ArgoCD authentication token | |*image.config.token* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |ArgoCD authentication token |
|*namespace* | `*"default" \| string` |Destination namespace | |*namespace* | `*"default" \| string` |Destination namespace |
|*env.APP_NAME* | `string` |- | |*env.APP_NAME* | `string` |- |
|*env.APP_REPO* | `string` |- | |*env.APP_REPO* | `string` |- |
@ -47,12 +47,12 @@ Re-usable CLI component
### argocd.#CLI Inputs ### argocd.#CLI Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
|*config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version | |*config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version |
|*config.server* | `string` |ArgoCD server | |*config.server* | `string` |ArgoCD server |
|*config.project* | `*"default" \| string` |ArgoCD project | |*config.project* | `*"default" \| string` |ArgoCD project |
|*config.token* | `*null \| {}` |ArgoCD authentication token | |*config.token* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |ArgoCD authentication token |
### argocd.#CLI Outputs ### argocd.#CLI Outputs
@ -64,12 +64,12 @@ ArgoCD configuration
### argocd.#Config Inputs ### argocd.#Config Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
|*version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version | |*version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version |
|*server* | `string` |ArgoCD server | |*server* | `string` |ArgoCD server |
|*project* | `*"default" \| string` |ArgoCD project | |*project* | `*"default" \| string` |ArgoCD project |
|*token* | `*null \| {}` |ArgoCD authentication token | |*token* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |ArgoCD authentication token |
### argocd.#Config Outputs ### argocd.#Config Outputs
@ -81,13 +81,13 @@ Get application's status
### argocd.#Status Inputs ### argocd.#Status Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
|*config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version | |*config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version |
|*config.server* | `string` |ArgoCD server | |*config.server* | `string` |ArgoCD server |
|*config.project* | `*"default" \| string` |ArgoCD project | |*config.project* | `*"default" \| string` |ArgoCD project |
|*config.token* | `*null \| {}` |ArgoCD authentication token | |*config.token* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |ArgoCD authentication token |
|*name* | `string` |ArgoCD application | |*name* | `string` |ArgoCD application |
### argocd.#Status Outputs ### argocd.#Status Outputs
@ -111,18 +111,18 @@ Sync an application to its targer state
|*config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version | |*config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version |
|*config.server* | `string` |ArgoCD server | |*config.server* | `string` |ArgoCD server |
|*config.project* | `*"default" \| string` |ArgoCD project | |*config.project* | `*"default" \| string` |ArgoCD project |
|*config.token* | `*null \| {}` |ArgoCD authentication token | |*config.token* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |ArgoCD authentication token |
|*application* | `string` |ArgoCD application | |*application* | `string` |ArgoCD application |
|*wait* | `*false \| bool` |Wait the application to sync correctly | |*wait* | `*false \| bool` |Wait the application to sync correctly |
|*ctr.image.config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version | |*ctr.image.config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version |
|*ctr.image.config.server* | `string` |ArgoCD server | |*ctr.image.config.server* | `string` |ArgoCD server |
|*ctr.image.config.project* | `*"default" \| string` |ArgoCD project | |*ctr.image.config.project* | `*"default" \| string` |ArgoCD project |
|*ctr.image.config.token* | `*null \| {}` |ArgoCD authentication token | |*ctr.image.config.token* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |ArgoCD authentication token |
|*ctr.env.APPLICATION* | `string` |- | |*ctr.env.APPLICATION* | `string` |- |
|*status.config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version | |*status.config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version |
|*status.config.server* | `string` |ArgoCD server | |*status.config.server* | `string` |ArgoCD server |
|*status.config.project* | `*"default" \| string` |ArgoCD project | |*status.config.project* | `*"default" \| string` |ArgoCD project |
|*status.config.token* | `*null \| {}` |ArgoCD authentication token | |*status.config.token* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |ArgoCD authentication token |
|*status.name* | `string` |ArgoCD application | |*status.name* | `string` |ArgoCD application |
### argocd.#Sync Outputs ### argocd.#Sync Outputs

22
docs/reference/git.md
View File

@ -16,15 +16,15 @@ Commit & push to git repository
### git.#Commit Inputs ### git.#Commit Inputs
| Name | Type | Description | | Name | Type | Description |
| ------------- |:-------------: |:-------------: | | ------------- |:-------------: |:-------------: |
|*repository.remote* | `string` |Repository remote URL | |*repository.remote* | `string` |Repository remote URL |
|*repository.authToken* | `*null \| {}` |Authentication token (PAT or password) | |*repository.authToken* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |Authentication token (PAT or password) |
|*repository.branch* | `string` |Git branch | |*repository.branch* | `string` |Git branch |
|*name* | `string` |Username | |*name* | `string` |Username |
|*email* | `string` |Email | |*email* | `string` |Email |
|*message* | `string` |Commit message | |*message* | `string` |Commit message |
|*force* | `*false \| bool` |Force push options | |*force* | `*false \| bool` |Force push options |
### git.#Commit Outputs ### git.#Commit Outputs
@ -69,8 +69,8 @@ A git repository
|*remote* | `string` |Git remote link | |*remote* | `string` |Git remote link |
|*ref* | `string` |Git ref: can be a commit, tag or branch. Example: "main" | |*ref* | `string` |Git ref: can be a commit, tag or branch. Example: "main" |
|*subdir* | `*null \| string` |(optional) Subdirectory | |*subdir* | `*null \| string` |(optional) Subdirectory |
|*authToken* | `*null \| {}` |(optional) Add Personal Access Token | |*authToken* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |(optional) Add Personal Access Token |
|*authHeader* | `*null \| {}` |(optional) Add OAuth Token | |*authHeader* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |(optional) Add OAuth Token |
### git.#Repository Outputs ### git.#Repository Outputs