Zuul¶

Here you will find information about managing the Zuul service when deployed with the SF Operator. It does not replace Zuul's documentation, but addresses specificities and idiosyncrasies induced by deploying Zuul with the SF Operator.

Architecture
Services configuration
Tenant configuration
Delegating temporary administrative powers on a tenant
Zuul-Client
Zuul-Admin
Scaling Zuul

Architecture¶

Zuul is deployed by SF-Operator as micro-services:

Component	Kubernetes resource type	Scalable Y/N
zuul-scheduler	statefulset	N
zuul-executor	statefulset	Y
zuul-merger	statefulset	Y
zuul-web	deployment	N

Zuul-scheduler Pod¶

Container	Type	R.Request (Mem/CPU)	R.Limit (Mem/CPU)	R.Limit Upgrade (Y/N)
zuul-scheduler	normal	128Mi/0.1CPU	2Gi/2CPU	Y
zuul-scheduler-nodeexporter	normal	32Mi/0.01CPU	64Mi/0.1CPU	N
zuul-statsd	normal	32Mi/0.01CPU	64Mi/0.1CPU	N
init-scheduler-config	init	32Mi/0.01CPU	64Mi/0.1CPU	N

Zuul-executor Pod¶

Container	Type	R.Request (Mem/CPU)	R.Limit (Mem/CPU)	R.Limit Upgrade (Y/N)
zuul-executor	privileged	128Mi/0.1CPU	2Gi/2CPU	Y
zuul-executor-nodeexporter	normal	32Mi/0.01CPU	64Mi/0.1CPU	N

Zuul-merger Pod¶

Container	Type	R.Request (Mem/CPU)	R.Limit (Mem/CPU)	R.Limit Upgrade (Y/N)
zuul-merger	normal	128Mi/0.1CPU	2Gi/2CPU	Y
zuul-merger-nodeexporter	normal	32Mi/0.01CPU	64Mi/0.1CPU	N

Zuul-web Pod¶

Container	Type	R.Request (Mem/CPU)	R.Limit (Mem/CPU)	R.Limit Upgrade (Y/N)
zuul-web	normal	128Mi/0.1CPU	2Gi/2CPU	Y

Resource limits¶

For each component the main container's resource limits can be changed via the SoftwareFactory Custom Resource.

Services configuration¶

Configuring the Zuul micro-services is done through the SoftwareFactory deployment's manifest. Many configuration parameters are exposed by The SoftwareFactory Custom Resource spec.

The spec is constantly evolving during alpha development, and should be considered unstable but the ultimate source of truth for documentation about its properties.

Tenant configuration¶

Zuul's tenant configuration is stored in the config repository. Edit ./zuul/main.yaml to add, edit or delete tenants and projects on your deployment; then commit your changes for review and CI validation.

Delegating temporary administrative powers on a tenant¶

Zuul can generate temporary tokens to use with zuul-client. These tokens allow a user to perform administrative tasks such as managing autoholds, promoting changes and re-enqueueing buildsets on a given tenant. This feature is documented here in Zuul's upstream documentation.

There are two ways to generate such a token:

sf-operatorkubectl exec

sf-operator zuul create auth-token [FLAGS]

Refer to the command's documentation for further details.

kubectl exec -n sf --stdin --tty zuul-scheduler-0 -- zuul-admin create-auth-token [...]

Zuul-Client¶

You can generate a configuration file for zuul-client with the sf-operator CLI.

Zuul-Admin¶

The zuul-admin command line utility is available on zuul-scheduler pods.

Open a shell on any available zuul-scheduler pod, for example zuul-scheduler-0:

kubectl exec --stdin --tty zuul-scheduler-0 -- /bin/sh

Then from that shell, run the zuul-admin command.

Scaling Zuul¶

Zuul Executor and Zuul Merger services can be scaled whenever sf-operator deployment no more fits the demand of the CI jobs. The scale is done with Kubernetes scale cli command:

kubectl scale <resource kind> <resource name> --replicas=<number of replicas>

# Example to scale Zuul Executor
kubectl scale sts zuul-executor --replicas=3

The scale will take no more that one minute.