Skip to content

Commit 30dd1bf

Browse files
committed
Topo template tech review 2
1 parent 0195ae2 commit 30dd1bf

4 files changed

Lines changed: 13 additions & 3 deletions

File tree

content/learning-paths/cross-platform/create-your-own-topo-templates/agent-skills.md

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

1111
If you already have a Docker Compose project and want to convert it to a Topo Template, or you want to create your own Topo Template from scratch, you can do so with an Agent Skill.
1212

13+
These skills are optional authoring aids. The Template you created in this Learning Path works with Topo without them.
14+
1315
Visit [Topo Skills](https://github.com/arm/topo-template-format#authoring-skills) for the most up-to-date list of the available Topo Template skills and instructions on how to install them.
1416

1517
At the time of writing, the [Topo Template Format Specification](https://github.com/arm/topo-template-format) provides the following skills:

content/learning-paths/cross-platform/create-your-own-topo-templates/creating-a-new-template.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,8 @@ RUN sed -i "s|__ACCENT_COLOR__|${ACCENT_COLOR}|g" /usr/share/nginx/html/index.ht
111111

112112
Topo passes configuration values to Templates through Docker build arguments. The `ARG` lines define the values consumed during the image build.
113113

114+
`sed` is a command-line text replacement tool. The `sed` commands replace placeholder text in `index.html` during the image build, so each cloned project can customize the web page without manually editing the source file.
115+
114116
### Create the compose file
115117

116118
Create `compose.yaml`:
@@ -168,6 +170,8 @@ The `x-topo` section is the Topo metadata block:
168170

169171
The argument names in `x-topo.args` match the keys under `services.message-card.build.args`. When Topo resolves the arguments, it writes the selected values into the build arguments.
170172

173+
The same argument name appears in three places: `x-topo.args` defines what Topo asks for, `build.args` passes the value to Docker, and the Dockerfile `ARG` consumes it.
174+
171175
### Clone the local Template
172176

173177
Clone your local Template into a new project directory. You can choose to answer interactive prompts for the arguments (using the first command below), or you can opt to include the arguments in the command (using the second command).
@@ -208,6 +212,12 @@ services:
208212

209213
### Deploy the new project
210214

215+
Check that your target is ready:
216+
217+
```bash
218+
topo health --target user@my-target
219+
```
220+
211221
Deploy the cloned project to your target:
212222

213223
```bash

content/learning-paths/cross-platform/create-your-own-topo-templates/hello-world-template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ weight: 3
66
layout: learningpathall
77
---
88

9-
This section quickly runs through the deployment of the `Hello World` Template, similar to the LLM on CPU Template in the [Deploy containerized workloads to Arm-based Linux targets with Topo](/learning-paths/cross-platform/deploy-containerized-workloads-with-topo/) Learning Path.
9+
This section quickly runs through the deployment of the `Hello World` Template, similar to the `CPU LLM Chat` Template in the [Deploy containerized workloads to Arm-based Linux targets with Topo](/learning-paths/cross-platform/deploy-containerized-workloads-with-topo/) Learning Path.
1010

1111
## Clone the 'Hello World' Topo Template
1212

content/learning-paths/cross-platform/create-your-own-topo-templates/overview.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,6 @@ To create a Topo Template, start with a Docker Compose project and add `x-topo`
5656
2. Hardware requirements (features like SVE or Neon, or required RAM).
5757
3. Project configuration at Topo clone time.
5858

59-
We will achieve this by the end of this Learning Path.
60-
6159
## What you've accomplished and what's next
6260

6361
You should now understand what a Topo Template is, and why you might create one. Next we will take an existing Template and customize it, before moving onto creating a Template from scratch.

0 commit comments

Comments
 (0)