Skip to content

Commit 81528cf

Browse files
CR-23224 create README.md (#691)
* CR-23224 create README.md * CR-23224 create README.md * CR-23224 create README.md
1 parent 22fb9c7 commit 81528cf

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

incubating/argo-cd-sync/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# gitops-argocd-sync
2+
3+
Syncs Argo CD apps managed by our GitOps Runtimes using Codefresh API
4+
5+
## Installation
6+
7+
* `pip3 install -r requirements.txt`
8+
9+
## Run
10+
11+
* `python3 argocd_sync.py`
12+
13+
## Supported parameters
14+
| Name | Description | Optional | Default value |
15+
|:---------------|:------------------------------------------------------------------------------------------|:---------|:---------------------------------------|
16+
| RUNTIME | The name of the GitOps Runtime managing the Argo CD Application | false | |
17+
| APPLICATION | The name of the Argo CD Application to be synced | false | |
18+
| ROLLBACK | Initiate a rollback to the previous revision if the Sync and Wait does not become healthy | true | |
19+
| WAIT_ROLLBACK | Wait for the app to be healthy after a rollback. Forces ROLLBACK to true | true | |
20+
| CA_BUNDLE | A base64 encoded string that contain the complete CA Certificate Bundle | true | |
21+
| INSECURE | Allows the usage of a self-signed certificate in the chain to reach the API endpoint | true | |
22+
| WAIT_HEALTHY | Wait for the app to be healthy | true | false |
23+
| INTERVAL | Interval in seconds to wait between checks | true | 10 |
24+
| MAX_CHECKS | Maximum numbers of checks to do (to avoid forever wait) | true | 10 |
25+
| LOG_LEVEL | Set the log level, e.g. 'debug', 'info', 'warn', 'error', 'critical' (default 'error') | true | error |
26+
| CF_URL | Codefresh API URL | true | https://g.codefresh.io |
27+
| CF_API_KEY | Codefresh API token | true | |
28+
| CF_STEP_NAME | Used in generating a link to the Apps Dashboard | true | STEP_NAME |
29+
| IMAGE_NAME | Overwrites the image name | true | quay.io/codefreshplugins/argo-cd-sync |
30+
| IMAGE_TAG | Overwrites the tag | true | 1.4.4 |

0 commit comments

Comments
 (0)