From 4ca4aa1f4e67958b92586ac76c6b459590f9700a Mon Sep 17 00:00:00 2001 From: Francisco Seruca Salgado Date: Mon, 21 Oct 2024 14:29:24 +0100 Subject: [PATCH] Update bootstrap-tenant command documentation. This change updates some missing information on bootstrap-tenant command, regarding on how the command options works. Change-Id: Ibda08a8889292f36ed5ea44e8c368ee270b460f8 --- .../bootstrap-tenant-config-repo.go | 4 ++-- doc/reference/cli/index.md | 4 ++-- doc/user/zuul_config_repository.md | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/cli/cmd/bootstrap-tenant-config-repo/bootstrap-tenant-config-repo.go b/cli/cmd/bootstrap-tenant-config-repo/bootstrap-tenant-config-repo.go index d6f34257..dd0ae3e1 100644 --- a/cli/cmd/bootstrap-tenant-config-repo/bootstrap-tenant-config-repo.go +++ b/cli/cmd/bootstrap-tenant-config-repo/bootstrap-tenant-config-repo.go @@ -43,7 +43,7 @@ func getAnsibleIncludeRole(rolename string) map[string]any { // BootstrapTenantConfigRepoCmd command var BootstrapTenantConfigRepoCmd = &cobra.Command{ - Use: "bootstrap-tenant", + Use: "bootstrap-tenant ", Short: "bootstrap a tenant's config repository", Long: `Initialize a Zuul tenant's config repository with boilerplate code that define standard pipelines: @@ -254,6 +254,6 @@ func MkBootstrapCmd() *cobra.Command { driver string ) BootstrapTenantConfigRepoCmd.Flags().StringVar(&connection, "connection", "", "Name of the connection or a source") - BootstrapTenantConfigRepoCmd.Flags().StringVar(&driver, "driver", "", "Driver type of the connection") + BootstrapTenantConfigRepoCmd.Flags().StringVar(&driver, "driver", "", "Driver type of the connection. Supported drivers: gitlab, gerrit") return BootstrapTenantConfigRepoCmd } diff --git a/doc/reference/cli/index.md b/doc/reference/cli/index.md index 4cd8c234..684b58d9 100644 --- a/doc/reference/cli/index.md +++ b/doc/reference/cli/index.md @@ -467,7 +467,7 @@ Initialize a Zuul tenant's config repository with boilerplate code that define s it also includes a boilerplate job and pre-run playbook. ```sh -sf-operator SF bootstrap-tenant [FLAGS] /path/to/tenant-config-repo +sf-operator SF bootstrap-tenant /path/to/tenant-config-repo [FLAGS] ``` Flags: @@ -475,7 +475,7 @@ Flags: | Argument | Type | Description | Optional | Default | |----------|------|-------|----|----| |--connection |string | The name of the Zuul connection to use for pipelines | No | - | -|--driver |string | The driver used by the Zuul connection | No | - | +|--driver |string | The driver used by the Zuul connection. Supported drivers: gerrit, gitlab | No | - | #### configure TLS diff --git a/doc/user/zuul_config_repository.md b/doc/user/zuul_config_repository.md index 92b56b84..98c2584f 100644 --- a/doc/user/zuul_config_repository.md +++ b/doc/user/zuul_config_repository.md @@ -74,12 +74,12 @@ While the tenant's config project could be setup manually, we also provide a `cl * the `base job` and `playbooks` !!! warning - The tool only supports the definition of `pipelines` compatible with a `Gerrit` connection. + The tool only supports the definition of `pipelines` compatible with a `Gerrit` and `GitLab` connections. Get a local checkout of the tenant's config project/repository then run: ```sh -sf-operator SF bootstrap-tenant --connection [connection] [/path/to/repository] +sf-operator SF bootstrap-tenant --connection [connection] ``` ### Modify and merge @@ -101,4 +101,4 @@ Zuul bot account for the related connection is authorized to set approvals, repo See the related section by connection type: -- Gerrit: [Set the Gerrit ACLs for repository](../deployment/config_repository.md#repository-acls-and-labels) \ No newline at end of file +- Gerrit: [Set the Gerrit ACLs for repository](../deployment/config_repository.md#repository-acls-and-labels)