llvm-premerge-checks/docs/playbooks.md

Playbooks

deployment to a clean infrastructure

General remarks:

• GCP does not route any traffic to your services unless the service is "healthy". It might take a few minutes after startup before the services is classified as healthy. Until then you will only see some generic error message.

These are the steps to set up the build server on a clean infrastructure:

1. Configure the tools on your local machine:

   ./local_setup.sh
   

2. Delete the old cluster, if it still exists:

   cd kubernetes/cluster
   ./cluster_delete.sh
   

3. Create the cluster:

   cd kubernetes/cluster
   ./cluster_create.sh
   

4. Create the disk storage, if it does not yet exist:

   cd kubernetes/cluster
   ./disk_create.sh
   

5. SSH into the VM instance mounting the volume, find the mount point and then set

   # go to the mount point of the volume
   cd  /var/lib/kubelet/plugins/kubernetes.io/gce-pd/mounts/jenkins-home
   # change the permissions
   sudo chmod a+rwx
   

6. Push the docker images to gcr.io:

   cd containers
   #for each subfolder:
   ./build_deploy.sh <foldername>
   

7. Deploy the stack:

   cd kubernetes
   ./deploy.sh
   

8. Configure it

creating basic authentication for reverse proxy

1. create auth file, based on ingress-nginx documentation

   cd kubernetes/reverse-proxy
   htpasswd -c auth <username>
   # enter password at prompt
   # add more users as required
   kubectl create secret generic proxy-auth --from-file=auth --namespace=jenkins
   

Creating docker containers on Windows

If you want to build/update/test docker container for Windows, you need to do this on a Windows machine. Here are the instructions to set up such a machine on GCP.

General hints:

• Use a GCP instance with "presistent SSD". This is much faster the the "persistent Disk".
• Try to avoid paths with white spaces in them.
• You need to configure Internet Explorer to allow downloads.
• Install Chrome, as Internet Explorer is a bit outdated.
• Install a nice IDE to edit Dockerfiles and scripts. VS Code is a good option.

1. Pick a GCP Windows image with Desktop Support.
2. Use the "Server Manager" application to install the "features":
   • Containers
   • HyperV
3. Install git with the default options: https://git-scm.com/download/win
4. git clone https://github.com/google/llvm-premerge-checks.git
   • Register your ssh keys on the windows machine on github if you intend to push changes.
5. Install docker: https://hub.docker.com/editions/community/docker-ce-desktop-windows
   • You will need a DockerHub account to download the installer.
   • Select "use Windows containers" during installation.
   • Start the "Docker Desktop" application, it will set up the required services for you.
6. Install kubectl.
7. Install gcloud and set it up according to the instructions.
8. Then run gcloud auth configure-docker to authorize docker to push images.

Check your installation by running "docker build ." in the containers/agent_windows folder.

To push push a new container run in containers:

powershell .\build_deploy.ps1 <container-folder>

Spawning a new windows agent

To spawn a new windows agent:

1. Go to the GCP page and pick a new number for the agent.
2. Update the machine name in kubernetes/windows_agent_create.sh.
3. Run kubernetes/windows_agent_create.sh
4. Go to the GCP page again
5. login to the new machine via RDP (you probably need to set the i).
6. In the RDP session: run these commands in the CMD window to start the docker container:

powershell 
Invoke-WebRequest -uri 'https://raw.githubusercontent.com/google/llvm-premerge-checks/master/kubernetes/windows_agent_bootstrap.ps1' -OutFile windows_agent_bootstrap.ps1
.\windows_agent_bootstrap.ps1

Testing scripts locally

Build and run agent docker image sudo build_run.sh agent-debian-testing-clang8-ssd /bin/bash.

Within a container set environment variables similar to pipeline.

Additionally set WORKSPACE, PHID and DIFF_ID parameters. Set CONDUIT_TOKEN with your personal one from https://reviews.llvm.org/settings/user/<USERNAME>/page/apitokens/.