Skip to content

Commit

Permalink
Update bootstrap-tenant command documentation.
Browse files Browse the repository at this point in the history
This change updates some missing information on bootstrap-tenant
command, regarding on how the command options works.

Change-Id: Ibda08a8889292f36ed5ea44e8c368ee270b460f8
  • Loading branch information
fserucas committed Oct 21, 2024
1 parent 831b9b0 commit 4ca4aa1
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ func getAnsibleIncludeRole(rolename string) map[string]any {

// BootstrapTenantConfigRepoCmd command
var BootstrapTenantConfigRepoCmd = &cobra.Command{
Use: "bootstrap-tenant",
Use: "bootstrap-tenant <path to directory>",
Short: "bootstrap a tenant's config repository",
Long: `Initialize a Zuul tenant's config repository
with boilerplate code that define standard pipelines:
Expand Down Expand Up @@ -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
}
4 changes: 2 additions & 2 deletions doc/reference/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -467,15 +467,15 @@ 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:

| 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

Expand Down
6 changes: 3 additions & 3 deletions doc/user/zuul_config_repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 </path/to/repository> --connection [connection]
```

### Modify and merge
Expand All @@ -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)
- Gerrit: [Set the Gerrit ACLs for repository](../deployment/config_repository.md#repository-acls-and-labels)

0 comments on commit 4ca4aa1

Please sign in to comment.