doc: reword to focus on variables used to configure the sync job (048ee6e6) · Commits · to be continuous... / tools / gitlab-sync

README.md

+16 −17

Original line number	Diff line number	Diff line
		@@ -19,23 +19,22 @@ Once copied _to be continuous_ to your GitLab server, you shall then schedule a
		The job only requires a GitLab token, that shall be configured declaring a `$GITLAB_TOKEN` CI/CD project variable.
		All the other parameters/variables are automatically determined by the job but might be overwritten with the appropriate project variables if need be:

		\| CLI option \| Env. Variable \| Description \| Default Value \|
		\| -------------------------- \| -------------------------------- \| ------------------------------------------------------------------------------------------------------ \| --------------------------------------- \|
		\| `--src-api` \| `$SRC_GITLAB_API` \| GitLab source API url \| `https://gitlab.com/api/v4` \|
		\| `--src-sync-path` \| `$SRC_SYNC_PATH` \| GitLab source root group path to synchronize \| `to-be-continuous` \|
		\| `--dest-api` \| `$DEST_GITLAB_API` \| GitLab destination API url \| `$CI_API_V4_URL` \|
		\| `--dest-token` \| `$DEST_TOKEN` or `$GITLAB_TOKEN` \| GitLab destination token with at least scopes `api,read_repository,write_repository` and `Owner` role \| _none_ (mandatory) \|
		\| `--dest-sync-path` \| `$DEST_SYNC_PATH` \| GitLab destination root group path to synchronize (defaults to `--src-sync-path`) \| determined from `$CI_PROJECT_NAMESPACE` \|
		\| `--max-visibility` \| `$MAX_VISIBILITY` \| maximum visibility of projects in destination group (defaults to `public`) \| `$CI_PROJECT_VISIBILITY` \|
		\| `--exclude` \| `$EXCLUDE` \| project/group path(s) to exclude (multiple CLI option; env. variable is a coma separated list) \| `samples,custom` \|
		\| `--insecure` \| `$INSECURE` \| skip SSL verification \| `false` \|
		\| `--update-release` \| `$UPDATE_RELEASE` \| set to force the update of the latest release (in order to trigger GitLab CI/CD catalog publication) \| `false` \|
		\| `--update-avatar` \| `$UPDATE_AVATAR` \| force update the avatar images even when they exist and look the same \| `false` \|
		\| `--no-group-description` \| `$GROUP_DESCRIPTION_DISABLED` \| don't synchronize group description \| `false` \|
		\| `--no-project-description` \| `$PROJECT_DESCRIPTION_DISABLED` \| don't synchronize project description \| `false` \|
		\| `--dry-run` \| _none_ \| dry run (don't execute any write action) \| `false` \|
		\| `--halt-on-error` \| _none_ \| halt synchronizing when an error occurs \| `false` \|
		\| `--cache-dir` \| `$CACHE_DIR` \| cache directory (used to download resources such as images and Git repositories) (defaults to `.work`) \| `.work` \|
		\| Env. Variable \| Description \| Default Value \|
		\| -------------------------------- \| ------------------------------------------------------------------------------------------------------ \| --------------------------------------- \|
		\| `$SRC_GITLAB_API` \| GitLab source API url \| `https://gitlab.com/api/v4` \|
		\| `$SRC_SYNC_PATH` \| GitLab source root group path to synchronize \| `to-be-continuous` \|
		\| `$DEST_GITLAB_API` \| GitLab destination API url \| `$CI_API_V4_URL` \|
		\| `$DEST_TOKEN` or `$GITLAB_TOKEN` \| GitLab destination token with at least scopes `api,read_repository,write_repository` and `Owner` role \| _none_ (mandatory) \|
		\| `$DEST_SYNC_PATH` \| GitLab destination root group path to synchronize (defaults to `--src-sync-path`) \| determined from `$CI_PROJECT_NAMESPACE` \|
		\| `$MAX_VISIBILITY` \| maximum visibility of projects in destination group (defaults to `public`) \| `$CI_PROJECT_VISIBILITY` \|
		\| `$EXCLUDE` \| project/group path(s) to exclude (multiple CLI option; env. variable is a coma separated list) \| `samples,custom` \|
		\| `$INCLUDE` \| project/group path(s) to include (multiple CLI option; env. variable is a coma separated list) \| `tools,docker,ansible` \|
		\| `$INSECURE` \| skip SSL verification \| `false` \|
		\| `$UPDATE_RELEASE` \| set to force the update of the latest release (in order to trigger GitLab CI/CD catalog publication) \| `false` \|
		\| `$UPDATE_AVATAR` \| force update the avatar images even when they exist and look the same \| `false` \|
		\| `$GROUP_DESCRIPTION_DISABLED` \| don't synchronize group description \| `false` \|
		\| `$PROJECT_DESCRIPTION_DISABLED` \| don't synchronize project description \| `false` \|
		\| `$CACHE_DIR` \| cache directory (used to download resources such as images and Git repositories) (defaults to `.work`) \| `.work` \|

		## CI/CD Catalog

Original line number	Diff line number	Diff line
		@@ -19,23 +19,22 @@ Once copied _to be continuous_ to your GitLab server, you shall then schedule a
		The job only requires a GitLab token, that shall be configured declaring a `$GITLAB_TOKEN` CI/CD project variable.
		All the other parameters/variables are automatically determined by the job but might be overwritten with the appropriate project variables if need be:

		\| CLI option \| Env. Variable \| Description \| Default Value \|
		\| -------------------------- \| -------------------------------- \| ------------------------------------------------------------------------------------------------------ \| --------------------------------------- \|
		\| `--src-api` \| `$SRC_GITLAB_API` \| GitLab source API url \| `https://gitlab.com/api/v4` \|
		\| `--src-sync-path` \| `$SRC_SYNC_PATH` \| GitLab source root group path to synchronize \| `to-be-continuous` \|
		\| `--dest-api` \| `$DEST_GITLAB_API` \| GitLab destination API url \| `$CI_API_V4_URL` \|
		\| `--dest-token` \| `$DEST_TOKEN` or `$GITLAB_TOKEN` \| GitLab destination token with at least scopes `api,read_repository,write_repository` and `Owner` role \| _none_ (mandatory) \|
		\| `--dest-sync-path` \| `$DEST_SYNC_PATH` \| GitLab destination root group path to synchronize (defaults to `--src-sync-path`) \| determined from `$CI_PROJECT_NAMESPACE` \|
		\| `--max-visibility` \| `$MAX_VISIBILITY` \| maximum visibility of projects in destination group (defaults to `public`) \| `$CI_PROJECT_VISIBILITY` \|
		\| `--exclude` \| `$EXCLUDE` \| project/group path(s) to exclude (multiple CLI option; env. variable is a coma separated list) \| `samples,custom` \|
		\| `--insecure` \| `$INSECURE` \| skip SSL verification \| `false` \|
		\| `--update-release` \| `$UPDATE_RELEASE` \| set to force the update of the latest release (in order to trigger GitLab CI/CD catalog publication) \| `false` \|
		\| `--update-avatar` \| `$UPDATE_AVATAR` \| force update the avatar images even when they exist and look the same \| `false` \|
		\| `--no-group-description` \| `$GROUP_DESCRIPTION_DISABLED` \| don't synchronize group description \| `false` \|
		\| `--no-project-description` \| `$PROJECT_DESCRIPTION_DISABLED` \| don't synchronize project description \| `false` \|
		\| `--dry-run` \| _none_ \| dry run (don't execute any write action) \| `false` \|
		\| `--halt-on-error` \| _none_ \| halt synchronizing when an error occurs \| `false` \|
		\| `--cache-dir` \| `$CACHE_DIR` \| cache directory (used to download resources such as images and Git repositories) (defaults to `.work`) \| `.work` \|
		\| Env. Variable \| Description \| Default Value \|
		\| -------------------------------- \| ------------------------------------------------------------------------------------------------------ \| --------------------------------------- \|
		\| `$SRC_GITLAB_API` \| GitLab source API url \| `https://gitlab.com/api/v4` \|
		\| `$SRC_SYNC_PATH` \| GitLab source root group path to synchronize \| `to-be-continuous` \|
		\| `$DEST_GITLAB_API` \| GitLab destination API url \| `$CI_API_V4_URL` \|
		\| `$DEST_TOKEN` or `$GITLAB_TOKEN` \| GitLab destination token with at least scopes `api,read_repository,write_repository` and `Owner` role \| _none_ (mandatory) \|
		\| `$DEST_SYNC_PATH` \| GitLab destination root group path to synchronize (defaults to `--src-sync-path`) \| determined from `$CI_PROJECT_NAMESPACE` \|
		\| `$MAX_VISIBILITY` \| maximum visibility of projects in destination group (defaults to `public`) \| `$CI_PROJECT_VISIBILITY` \|
		\| `$EXCLUDE` \| project/group path(s) to exclude (multiple CLI option; env. variable is a coma separated list) \| `samples,custom` \|
		\| `$INCLUDE` \| project/group path(s) to include (multiple CLI option; env. variable is a coma separated list) \| `tools,docker,ansible` \|
		\| `$INSECURE` \| skip SSL verification \| `false` \|
		\| `$UPDATE_RELEASE` \| set to force the update of the latest release (in order to trigger GitLab CI/CD catalog publication) \| `false` \|
		\| `$UPDATE_AVATAR` \| force update the avatar images even when they exist and look the same \| `false` \|
		\| `$GROUP_DESCRIPTION_DISABLED` \| don't synchronize group description \| `false` \|
		\| `$PROJECT_DESCRIPTION_DISABLED` \| don't synchronize project description \| `false` \|
		\| `$CACHE_DIR` \| cache directory (used to download resources such as images and Git repositories) (defaults to `.work`) \| `.work` \|

		## CI/CD Catalog