Skip to content

Commit 647d781

Browse files
Refine documentation for Buildkite pipeline setup: improve clarity, section titles, and image descriptions.
1 parent 7f25b6b commit 647d781

File tree

2 files changed

+18
-21
lines changed

2 files changed

+18
-21
lines changed

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

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

99
## Create an application
1010

11-
You can now create an application to containerize with Docker. The example below is a simple Flask-based Python application.
11+
Now you'll create a simple application to containerize with Docker. This example uses Flask, a popular Python web framework.
1212

13-
Create a new public GitHub repository where you can create the Dockerfile and the Python file for the application.
13+
The first step is to create a new public GitHub repository. You'll add both the `Dockerfile` and the Python application file to this repository.
1414

15-
### Create a Dockerfile
15+
## Create a Dockerfile
1616

1717
In a GitHub repo, add a new file named `Dockerfile` with this content:
1818

@@ -30,7 +30,7 @@ EXPOSE 5000
3030
CMD ["python", "app.py"]
3131
```
3232

33-
### Create a Python application
33+
## Create a Python application
3434

3535
In the same repo, add a Python source file named `app.py`:
3636

@@ -48,37 +48,34 @@ if __name__ == "__main__":
4848

4949
This Python code defines a simple Flask web server that listens on all interfaces (0.0.0.0) at port 5000 and responds with "Hello from Arm-based Buildkite runner!" when the root URL (/) is accessed.
5050

51-
### Add the code to your GitHub repository
51+
## Add your code to the GitHub repository
5252

53-
Before triggering the pipeline, your GitHub repository should have:
53+
Before you trigger the Buildkite pipeline, make sure your GitHub repository contains both the `Dockerfile` and the `app.py` file. The `Dockerfile` defines your multi-architecture container image, and `app.py` is your Python microservice.
5454

55-
- `Dockerfile` (defines your multi-arch image)
56-
- `app.py` (your Python microservice)
55+
You'll need the URL of this repository when you create your Buildkite pipeline in the next steps.
5756

58-
You will need the path to the GitHub repository when you create a Buildkite pipeline below.
59-
60-
### Add Docker credentials as Buildkite secrets
57+
## Add Docker credentials as Buildkite secrets
6158

6259
Make sure to add your Docker credentials as secrets in the Buildkite UI.
6360

6461
Navigate to Buildkite and select Agents and then Secrets and add `DOCKER_USERNAME` and `DOCKER_PASSWORD`.
6562

6663
![Buildkite Dashboard alt-text#center](images/secrets.png "Set Secrets")
6764

68-
### Create a Buildkite pipeline for multi-arch builds
65+
## Create a Buildkite pipeline for multi-arch builds
6966

7067
In Buildkite, define your pipeline using YAML through the UI.
7168

7269
Go to the Buildkite Dashboard and select Pipelines and New Pipeline
7370

74-
Fill out the form:
71+
Fill out the form using the following details:
7572

7673
- Git Repository: Enter your GitHub repository URL (SSH or HTTPS).
7774
- Name: Enter a name for your pipeline.
7875

7976
![Buildkite Dashboard alt-text#center](images/pipeline.png "Create Pipeline")
8077

81-
In the Steps (YAML Steps) section, paste your pipeline YAML.
78+
In the Steps (YAML Steps) section, paste your pipeline YAML:
8279

8380
```yaml
8481
steps:
@@ -99,9 +96,9 @@ steps:
9996
10097
![Buildkite Dashboard alt-text#center](images/yaml.png "YAML steps")
10198
102-
Click Create Pipeline.
99+
Select **Create pipeline** to save your new pipeline.
103100
104-
Trigger a new build by clicking New Build on your pipeline’s dashboard.
101+
To start your first build, select **New build** on your pipeline dashboard. This action triggers the pipeline and begins the multi-architecture build process.
105102
106103
![Buildkite Dashboard alt-text#center](images/build-p.png "Create Build")
107104

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ 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-
![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")
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 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
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.
3333

3434
The main steps you'll see are:
@@ -37,13 +37,13 @@ The main steps you'll see are:
3737
- Creating the Buildx builder
3838
- Building and pushing the multi-architecture Docker image
3939

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")
40+
![Screenshot of the Buildkite dashboard displaying real-time build logs, showing each pipeline step and its status for monitoring progress alt-text#center](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-
![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")
46+
![Screenshot of Docker Hub showing the multi-architecture image for the application repository, confirming both arm64 and amd64 platforms are available alt-text#center](images/multi-arch-image.png "Docker image")
4747

4848
## Run the Flask application
4949

@@ -60,7 +60,7 @@ You can now visit the VM’s Public IP to access the Flask application:
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")
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 alt-text#center](images/browser.png "Verify Docker images")
6464

6565
## What you've accomplished
6666

0 commit comments

Comments
 (0)