diff --git a/cmd/sync/README.md b/cmd/sync/README.md index 187d384f1d34b682ed744fa1c8b02d101b8792e8..b214f0cfd57c15ee97899b7f202ec16fa5c2fa2e 100644 --- a/cmd/sync/README.md +++ b/cmd/sync/README.md @@ -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 ``` diff --git a/cmd/sync/temp b/cmd/sync/temp new file mode 160000 index 0000000000000000000000000000000000000000..a3d8bd0b85d95b05353f8dd9a1069f724a8039ea --- /dev/null +++ b/cmd/sync/temp @@ -0,0 +1 @@ +Subproject commit a3d8bd0b85d95b05353f8dd9a1069f724a8039ea