Skip to content

Commit 7c85f8e

Browse files
Refactor documentation for Buildkite setup: improve clarity, consistency, and formatting across multiple files.
1 parent 2bc9c3c commit 7c85f8e

File tree

4 files changed

+51
-34
lines changed

4 files changed

+51
-34
lines changed

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

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Set-up Buildkite
2+
title: Set up Buildkite
33
weight: 5
44

55
### FIXED, DO NOT MODIFY
@@ -10,21 +10,24 @@ layout: learningpathall
1010

1111
After installing the Buildkite agent binary on a Google Axion C4A Arm VM, you can set up and configure a Buildkite agent and queue.
1212

13-
## 1. Create an Agent Token
13+
## Create an agent token
1414

1515
Before configuring the agent, you need an agent token from your Buildkite organization.
1616

17-
1. Log in to your Buildkite account (you can login with GitHub), and go to your Organization Settings
18-
2. Click Agents in the left menu
19-
3. Click Create Agent Token
20-
4. Enter a name for your token, such as `buildkite-arm`
21-
5. Click Create Token
22-
6. Copy the token immediately, you won’t be able to see it again after leaving the page.
17+
To create an agent token, follow these steps:
2318

24-
![Buildkite Dashboard alt-text#center](images/agent-token.png "Create Buildkite agent Token")
19+
- Sign in to your Buildkite account. You can use your GitHub credentials if you prefer.
20+
- In the left menu, select **Organization settings**.
21+
- Select **Agents**.
22+
- Select **Create agent token**.
23+
- Enter a descriptive name for the token, such as `buildkite-arm`.
24+
- Select **Create token**.
25+
- Copy the token and store it securely as you won’t be able to view it again after you leave the page.
2526

27+
![Buildkite Dashboard alt-text#center](images/agent-token.png "Create Buildkite agent token")
2628

27-
## 2. Configure Buildkite Agent
29+
30+
## Configure Buildkite Agent
2831

2932
Create the configuration directory and file on your local system with the commands below:
3033

@@ -35,10 +38,10 @@ tags="queue=buildkite-queue1"
3538
EOF
3639
```
3740

38-
Replace `YOUR_AGENT_TOKEN` with the token you generated from your Buildkite Agents page.
41+
Replace `YOUR_AGENT_TOKEN` with the token that you generated from your Buildkite Agents page.
3942

40-
{{% notice Note %}}
41-
You find it easier to copy the commands above into a text file named `config-agent.sh` and run the file.
43+
{{% notice Tip %}}
44+
You might find it easier to copy the commands above into a text file named `config-agent.sh` and run the file.
4245
```console
4346
bash ./config-agent.sh
4447
```
@@ -63,21 +66,23 @@ token="YOUR-GENERATED-TOKEN-VALUE"
6366
tags="queue=buildkite-queue1"
6467
```
6568

66-
## 3. Create a Queue in Buildkite
69+
## Create a Queue in Buildkite
6770

6871
Now that your agent is created, you can create a queue.
6972

70-
1. Go to your Buildkite Organization select Queues and then select Create Queue
71-
2. Name the queue, for example `buildkite-queue1`
72-
3. Save the queue
73+
- Go to your Buildkite organization, select **Queues**, and then select **Create queue**.
74+
- Enter a name for the queue, for example `buildkite-queue1`.
75+
- Select **Save** to create the queue.
76+
77+
This step connects your agent to the correct queue, ensuring jobs are routed to your Arm-based Buildkite agent.
7378

7479
{{% notice Note %}}
7580
Make sure the queue name matches the `tags` field in the agent configuration.
7681
{{% /notice %}}
7782

7883
![Buildkite Dashboard alt-text#center](images/queue.png "Create Buildkite Queue")
7984

80-
## 4. Verify the agent in the Buildkite UI
85+
## Verify the agent in the Buildkite UI
8186

8287
First, start the agent on your local computer:
8388

@@ -91,6 +96,6 @@ Go Buildkite and select Agents
9196

9297
Confirm that the agent is online and connected to the queue `buildkite-queue1`.
9398

94-
![Buildkite Dashboard alt-text#center](images/agent.png "Verify Agent")
99+
![Buildkite Dashboard alt-text#center](images/agent.png "Verify the agent")
95100

96101
The Buildkite agent is ready, you can proceed to use Buildkite for building multi-arch images.

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

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,8 @@ The Buildkite Agent version 3.43.0 introduces Linux/Arm64 Docker image for the B
8686

8787
The [Arm Ecosystem Dashboard](https://developer.arm.com/ecosystem-dashboard/) recommends Buildkite Agent version v3.43.0 or later for Arm platforms.
8888
{{% /notice %}}
89-
### Install Docker
89+
90+
## Install Docker
9091

9192
Buildkite uses Docker to build and push images.
9293

@@ -141,9 +142,13 @@ For more examples and ideas, visit:
141142
Docker Buildx is a plugin that allows the building of multi-architecture images, for example `arm64` and `amd64`.
142143
If you're using SUSE Linux, you need to install Docker Buildx manually. On Ubuntu, Docker Buildx is included by default, so you can skip this step.
143144

145+
For more information or troubleshooting details, see the [Docker Buildx documentation](https://docs.docker.com/build/buildx/).
146+
144147
## Download Docker Buildx
145148

146-
Download the Docker Buildx binary and move it to the Docker CLI plugin directory. This enables advanced multi-architecture builds on your Arm VM.
149+
If you need to download Docker Buildx, follow these steps.
150+
151+
Start by downloading the Docker Buildx binary and move it to the Docker CLI plugin directory. This enables advanced multi-architecture builds on your Arm VM:
147152

148153
```console
149154
wget https://github.com/docker/buildx/releases/download/v0.26.1/buildx-v0.26.1.linux-arm64

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

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,13 @@ layout: learningpathall
88

99
## Get started
1010

11-
You're about to launch a Google Axion C4A Arm virtual machine on Google Cloud Platform (GCP). This section guides you through each step, from selecting the optimal instance type to configuring your operating system and networking. By the end, you'll have a ready-to-use Arm-based VM, perfect for high-performance workloads and cloud-native development.
12-
You'll learn how to provision a Google Axion C4A Arm virtual machine on Google Cloud Platform (GCP) using the `c4a-standard-4` instance type with 4 vCPUs and 16 GB memory in the Google Cloud Console.
11+
You're about to launch a Google Axion C4A Arm virtual machine on Google Cloud Platform (GCP). This section guides you through each step, from selecting the optimal instance type to configuring your operating system and networking.
1312

14-
## Provision a VM
13+
By the end, you'll have a ready-to-use Arm-based VM, perfect for high-performance workloads and cloud-native development. Specifically, you'll learn how to provision a Google Axion C4A Arm virtual machine on Google Cloud Platform (GCP) using the `c4a-standard-4` instance type with 4 vCPUs and 16 GB memory in the Google Cloud Console.
1514

16-
To create a virtual machine based on the C4A instance type:
15+
## Provision a virtual machine
16+
17+
To create a virtual machine based on the C4A instance type, follow these steps:
1718
- Open the [Google Cloud Console](https://console.cloud.google.com/).
1819
- In the left navigation pane, select **Compute Engine** > **VM instances**.
1920
- Select **Create instance**.
@@ -22,13 +23,14 @@ To create a virtual machine based on the C4A instance type:
2223
- Select a **Region** and **Zone**.
2324
- For **Series**, select **C4A**.
2425
- For **Machine type**, select **c4a-standard-4**.
25-
- The following image shows the **Machine configuration** section with the C4A series and c4a-standard-4 machine type selected.
2626

27-
![Screenshot of the Machine configuration section in Google Cloud Console with C4A series and c4a-standard-4 machine type selected.](images/gcp-vm.png "Creating a Google Axion C4A Arm virtual machine in Google Cloud Console")
27+
The following image shows the **Machine configuration** section with the C4A series and c4a-standard-4 machine type selected:
28+
29+
![Screenshot of the Machine configuration section in Google Cloud Console with C4A series and c4a-standard-4 machine type selected.alt-text #center](images/gcp-vm.png "Creating a Google Axion C4A Arm virtual machine in Google Cloud Console")
2830

2931
- In the **OS and storage** section, select **Change**.
3032
- In the **Operating system** dialog, choose an Arm64-based image such as **SUSE Linux Enterprise Server** or **Ubuntu**.
31-
- Select your preferred version, making sure to choose the Arm architecture.
33+
- Select your preferred version, making sure you select the Arm architecture.
3234
- Select **Select** to confirm your choice.
3335
- In the **Networking** section, enable the **Allow HTTP traffic** option.
3436
- Select **Create** to launch your instance.

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

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ layout: learningpathall
1010

1111
Follow the steps below to run your pipeline on an Arm-based Buildkite agent. You will use Docker Buildx to create a multi-architecture image for both `arm64` and `amd64`.
1212

13-
### Ensure the agent is running
13+
## Ensure the agent is running
1414

1515
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:
1616

@@ -20,15 +20,15 @@ sudo /root/.buildkite-agent/bin/buildkite-agent status
2020

2121
This command checks the current state of your Buildkite agent and displays its connection status. When the agent is properly running and connected, you'll see logs indicating "Registered agent" in the output, confirming that the agent is online and ready to receive jobs from Buildkite. The agent continuously listens for new pipeline jobs and executes the steps you've defined in your configuration.
2222

23-
### Trigger the pipeline
23+
## Trigger the pipeline
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

2727
![Buildkite Dashboard alt-text#center](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

31-
### Monitor the Build
31+
## Monitor the Build
3232

3333
You can see the logs of your build live in the Buildkite UI.
3434

@@ -39,13 +39,13 @@ The steps include:
3939

4040
![Buildkite Dashboard alt-text#center](images/log.png "Monitor the build")
4141

42-
### Verify Multi-Arch Image
42+
## 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

4646
![Docker-Hub alt-text#center](images/multi-arch-image.png "Figure 3: Docker image")
4747

48-
### Run the Flask Application on Arm
48+
## Run the Flask application
4949

5050
```console
5151
docker pull <DOCKER_USERNAME>/multi-arch-app:latest
@@ -61,6 +61,11 @@ http://<VM_IP>
6161
```
6262
You should see output similar to:
6363

64-
![Buildkite Dashboard alt-text#center](images/browser.png "Figure 4: Verify Docker Images")
64+
![Buildkite Dashboard alt-text#center](images/browser.png "Verify Docker i
65+
mages")
6566

6667
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
70+
71+
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)