Skip to content

Commit d1b8158

Browse files
Enhance Buildkite documentation: improve clarity, section titles, and instructions for setting up agents and pipelines on Google Axion C4A Arm VMs.
1 parent 7c85f8e commit d1b8158

File tree

3 files changed

+25
-26
lines changed

3 files changed

+25
-26
lines changed

content/learning-paths/servers-and-cloud-computing/buildkite-gcp/buildkite-agent-setup.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: Set up Buildkite
2+
title: Set up and connect Buildkite agent on a Google Axion C4A Arm VM
33
weight: 5
44

55
### FIXED, DO NOT MODIFY
66
layout: learningpathall
77
---
88

9-
# Set up a Buildkite agent
9+
## What you'll do in this section
1010

11-
After installing the Buildkite agent binary on a Google Axion C4A Arm VM, you can set up and configure a Buildkite agent and queue.
11+
In this section, you'll configure and connect a Buildkite agent on a Google Axion C4A Arm virtual machine (VM). You'll generate an agent token, set up the agent configuration, create a Buildkite queue, and verify that your agent is online and ready to run CI/CD jobs on Arm infrastructure.
1212

1313
## Create an agent token
1414

@@ -27,7 +27,7 @@ To create an agent token, follow these steps:
2727
![Buildkite Dashboard alt-text#center](images/agent-token.png "Create Buildkite agent token")
2828

2929

30-
## Configure Buildkite Agent
30+
## Configure the Buildkite agent
3131

3232
Create the configuration directory and file on your local system with the commands below:
3333

@@ -66,7 +66,7 @@ token="YOUR-GENERATED-TOKEN-VALUE"
6666
tags="queue=buildkite-queue1"
6767
```
6868

69-
## Create a Queue in Buildkite
69+
## Create a queue in Buildkite
7070

7171
Now that your agent is created, you can create a queue.
7272

@@ -80,7 +80,7 @@ This step connects your agent to the correct queue, ensuring jobs are routed to
8080
Make sure the queue name matches the `tags` field in the agent configuration.
8181
{{% /notice %}}
8282

83-
![Buildkite Dashboard alt-text#center](images/queue.png "Create Buildkite Queue")
83+
![Buildkite Dashboard alt-text#center](images/queue.png "Create the Buildkite queue")
8484

8585
## Verify the agent in the Buildkite UI
8686

@@ -90,12 +90,13 @@ First, start the agent on your local computer:
9090
sudo /root/.buildkite-agent/bin/buildkite-agent start --build-path="/var/lib/buildkite-agent/builds"
9191
```
9292

93-
Then, confirm it is visible in the Buildkite UI:
93+
Then, confirm the agent is visible in the Buildkite UI, by doing the following:
9494

95-
Go Buildkite and select Agents
95+
- In the Buildkite dashboard, select **Agents** from the left menu. This page lists all registered agents for your organization.
96+
- Look for your new agent in the list and verify that its status is **online** and that it is assigned to the correct queue.
9697

9798
Confirm that the agent is online and connected to the queue `buildkite-queue1`.
9899

99100
![Buildkite Dashboard alt-text#center](images/agent.png "Verify the agent")
100101

101-
The Buildkite agent is ready, you can proceed to use Buildkite for building multi-arch images.
102+
Congratulations! Your Buildkite agent is now set up and connected to your queue. You can now start using Buildkite to build multi-architecture images on your Arm-based VM. This setup enables you to run CI/CD pipelines optimized for Arm platforms, and take advantage of the performance and scalability of Arm servers.

content/learning-paths/servers-and-cloud-computing/buildkite-gcp/multiarch_buildkite_pipeline.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,4 +105,6 @@ Trigger a new build by clicking New Build on your pipeline’s dashboard.
105105
106106
![Buildkite Dashboard alt-text#center](images/build-p.png "Create Build")
107107
108-
Once your files and pipeline are ready, you can validate that your Buildkite agent is running and ready to execute jobs.
108+
## What you've accomplished
109+
110+
You've now created a simple Flask application, added a Dockerfile, set up your GitHub repository, and configured a Buildkite pipeline for multi-architecture builds on Arm. You also added Docker credentials as secrets and defined your pipeline steps in YAML. These steps prepare you to build, push, and test containerized applications using Arm-based infrastructure. You're now ready to validate your setup and run your first build!

content/learning-paths/servers-and-cloud-computing/buildkite-gcp/validation.md

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Follow the steps below to run your pipeline on an Arm-based Buildkite agent. You
1212

1313
## Ensure the agent is running
1414

15-
Before your pipeline can execute, the Buildkite agent must be running and connected to your Buildkite account. To verify the agent status, run the following command on your VM:
15+
Before running your pipeline, make sure the Buildkite agent is active and connected. On your VM, check the agent status with this command:
1616

1717
```console
1818
sudo /root/.buildkite-agent/bin/buildkite-agent status
@@ -24,26 +24,26 @@ This command checks the current state of your Buildkite agent and displays its c
2424

2525
To start your pipeline, navigate to your pipeline in the Buildkite web interface. From your Buildkite dashboard, select the pipeline you created and click the "New Build" button. Choose the branch you want to build from the dropdown menu, then click "Start Build" to begin execution.
2626

27-
![Buildkite Dashboard alt-text#center](images/build-p.png "Trigger the pipeline")
27+
![Screenshot of the Buildkite dashboard showing the "New Build" button highlighted, with the pipeline name and branch selection visible. This interface allows you to trigger a new build and select the branch to build from.](images/build-p.png "Trigger the pipeline")
2828

2929
When you trigger the pipeline, Buildkite sends the job to your Arm-based agent and begins executing the steps defined in your YAML configuration file. The agent will process each step in sequence, starting with Docker login, followed by creating the Buildx builder, and finally building and pushing your multi-architecture Docker image.
3030

3131
## Monitor the Build
32+
You can watch your build logs in real time in the Buildkite dashboard. Each step appears as it runs, so you can track progress and spot any issues quickly.
3233

33-
You can see the logs of your build live in the Buildkite UI.
34+
The main steps you'll see are:
3435

35-
The steps include:
36-
- Docker login
37-
- Buildx builder creation
38-
- Multi-arch Docker image build and push
36+
- Logging in to Docker
37+
- Creating the Buildx builder
38+
- Building and pushing the multi-architecture Docker image
3939

40-
![Buildkite Dashboard alt-text#center](images/log.png "Monitor the build")
40+
![Screenshot of the Buildkite dashboard displaying real-time build logs, showing each pipeline step and its status for monitoring progress](images/log.png "Monitor the build")
4141

4242
## Verify multi-arch image
4343

4444
After the pipeline completes successfully, you can go to Docker Hub and verify the pushed multi-arch images:
4545

46-
![Docker-Hub alt-text#center](images/multi-arch-image.png "Figure 3: Docker image")
46+
![Screenshot of Docker Hub showing the multi-architecture image for the application repository, confirming both arm64 and amd64 platforms are available](images/multi-arch-image.png "Docker image")
4747

4848
## Run the Flask application
4949

@@ -54,18 +54,14 @@ docker run --rm -p 80:5000 <DOCKER_USERNAME>/multi-arch-app:latest
5454

5555
This command runs the Flask application inside a container, exposing it on port 5000 inside the container and mapping it to port 80 on the host machine.
5656

57-
You can now visit the VM’s Public IP to access the Flask application.
57+
You can now visit the VM’s Public IP to access the Flask application:
5858

5959
```console
6060
http://<VM_IP>
6161
```
6262
You should see output similar to:
63+
![Screenshot of the Docker Hub web interface showing the multi-architecture image tags for the application repository, confirming successful upload of both arm64 and amd64 images](images/browser.png "Verify Docker images")
6364

64-
![Buildkite Dashboard alt-text#center](images/browser.png "Verify Docker i
65-
mages")
66-
67-
Your pipeline is working, and you have successfully built and ran the Flask application using your Arm-based Buildkite agent.
68-
69-
## Recap your progress
65+
## What you've accomplished
7066

7167
You've now completed the key steps to run a Buildkite pipeline on an Arm-based Google Axion C4A VM. You verified your agent connection, triggered and monitored a multi-architecture build, and successfully deployed and tested a Flask application in a Docker container. This workflow demonstrates how to use Arm infrastructure for modern CI/CD pipelines and multi-architecture container builds. Great work, you're now ready to apply these skills to your own Arm-based projects!

0 commit comments

Comments
 (0)