Skip to content
Snippets Groups Projects
Verified Commit bf75c0e9 authored by Georgi Michev's avatar Georgi Michev
Browse files

Update the readme for sync tool

Update the optional statuses.
Update the "usage example" to allow connection to the DB.
parent 7e14c17d
No related branches found
No related tags found
No related merge requests found
Pipeline #56438 passed with stages
in 3 minutes and 44 seconds
......@@ -35,7 +35,7 @@ Basic usage documentation is available when executing the following command on M
The flags passed to the script are as follows:
```
-dbAddr string
Mongo DB connection string.
Mongo DB connection string.
-dbUser string
Mongo DB username.
-dbPass string
......@@ -43,20 +43,20 @@ The flags passed to the script are as follows:
-repoURL string
Policy repository URL.
-repoUser string
GIT Server username.
GIT Server username - optional
-repoPass string
GIT Server password.
GIT Server password - optional
-repoFolder string
Folder where the tool scans for policies
Folder where the tool scans for policies - optional
-branch string
GIT branch for explicit checkout. This flag is optional.
GIT branch for explicit checkout - optional
-keepAlive bool
Keep alive the service (e.g.for containers)
Keep alive the service (e.g.for containers) - optional
-syncInterval time.Duration
Sync interval given as time duration string (e.g. 1s, 10m, 1h30m)
Sync interval given as time duration string (e.g. 1s, 10m, 1h30m) - optional
```
Usage example:
```shell
./sync -repoURL="https://path/to/repo.git" -repoUser="user" -repoPass="pass" -dbAddr="mongodb://localhost:27017/policy" -dbUser="user" -dbPass="pass" -branch="feature-branch" -keepAlive=true -syncInterval=20s
./sync -repoURL="https://path/to/repo.git" -repoUser="user" -repoPass="pass" -dbAddr="mongodb://localhost:27017/policy?directConnection=true" -dbUser="user" -dbPass="pass" -branch="feature-branch" -keepAlive=true -syncInterval=20s
```
temp @ a3d8bd0b
Subproject commit a3d8bd0b85d95b05353f8dd9a1069f724a8039ea
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment