Skip to content

Commit

Permalink
Merge "doc - vatious fixes"
Browse files Browse the repository at this point in the history
  • Loading branch information
Microzuul CI authored and Gerrit Code Review committed Jun 13, 2024
2 parents a5ef0a4 + 0eb8438 commit 1fa3461
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 11 deletions.
10 changes: 5 additions & 5 deletions doc/deployment/config_repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
1. [Gerrit](#hosting-on-gerrit)
- [Prerequisites](#prerequisites-on-gerrit)
- [Configuring Gerrit](#configuring-gerrit)
- [Configuring the Zuul connection](#configuring-the-zuul-connection)
- [Configuring the Zuul connection](#configuring-the-gerrit-zuul-connection)
1. [GitLab](#hosting-on-gitlab)
- [Configuring the Zuul connection](#configuring-the-zuul-connection-1)
- [Configuring the Zuul connection](#configuring-the-gitlab-zuul-connection)
1. [Next Steps](#next-steps)

## Concept
Expand Down Expand Up @@ -121,7 +121,7 @@ Here are the required labels to define in the repository's *Access* settings (*m

For further information check the [Gerrit section](https://zuul-ci.org/docs/zuul/latest/drivers/gerrit.html#gerrit) in Zuul's documentation.

#### Configuring the Zuul connection
#### Configuring the Gerrit Zuul connection

In order for Zuul to start listening to Gerrit events, add a `gerritconn` property in your deployed **SoftwareFactory**'s Spec. Edit the spec with:

Expand Down Expand Up @@ -168,7 +168,7 @@ an API Token and WebHook token](https://zuul-ci.org/docs/zuul/latest/drivers/git
The `gate` pipeline defined for the `config` repository workflow relies in the `gateit` label for the pipeline
trigger rule. Thus, a GitLab label named `gateit` must be defined in the `Settings` the `config` repository.

#### Configuring the Zuul connection
#### Configuring the Gitlab Zuul connection

To setup the zuul's connection to the GitLab instance, first you need a `Secret` resource (eg. named `gitlab-com-secret`)
to store the API and WebHook tokens. The `Secret`'s scheme is a follow:
Expand Down Expand Up @@ -198,7 +198,7 @@ spec:
- name: <zuul-connection-name>
server: gitlab.com
baseurl: https://gitlab.com
secrets: gitlab-com-secret
secrets: gitlab-conn-secret
[...]
```

Expand Down
14 changes: 8 additions & 6 deletions doc/developer/images.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,17 +88,17 @@ running Zuul pods.
Follow these steps on your MicroShift instance

```sh
mkdir -p /home/centos/git && cd /home/centos/git
mkdir -p /home/cloud-user/git && cd /home/cloud-user/git
git clone https://opendev.org/zuul/zuul
# Clone at the current version provided by sf-operator or use master branch
git checkout 9.3.0
cd zuul; git checkout 10.1.0
```

Then you can run the operator by providing the environment variable `ZUUL_LOCAL_SOURCE=<full-path-to-zuul-source>`.
For instance (using the standalone mode):
For instance (using the standalone mode'):

```
ZUUL_LOCAL_SOURCE=/home/cloud-user/git/zuul/zuul sf-operator --namespace sf dev create standalone-sf --cr playbooks/files/sf.yaml
ZUUL_LOCAL_SOURCE=/home/cloud-user/git/zuul/zuul go run ./main.go --namespace sf dev create standalone-sf --cr playbooks/files/sf.yaml
```

After any code change, you can restart the Zuul pods, for instance the zuul-scheduler pod:
Expand All @@ -110,6 +110,8 @@ kubectl rollout restart -n sf sts/zuul-merger
kubectl rollout restart -n sf deploy/zuul-web
```

The Zuul web UI won't work, to re-enable it the [following section](#zuul-web).

### Zuul-web

zuul-web static assets are located under the Zuul source tree on the container image. The local copy, from
Expand All @@ -124,8 +126,8 @@ Either,
To Fetch the built asset from the zuul-web container image, run the following process from the microshift machine.

```sh
cd /home/centos/git/zuul/zuul/web
podman create --name zuul-web quay.io/software-factory/zuul-web:9.3.0-1
cd /home/cloud-user/git/zuul/zuul/web
podman create --name zuul-web quay.io/software-factory/zuul-web:10.1.0-1
podman export -o /tmp/zuul-web.tar zuul-web
tar -xf /tmp/zuul-web.tar usr/local/lib/python3.11/site-packages/zuul/web/static
mv usr/local/lib/python3.11/site-packages/zuul/web/static static
Expand Down

0 comments on commit 1fa3461

Please sign in to comment.