Skip to content

docs: link out to container engine install from health #429

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
awphi wants to merge 1 commit into
base: main
Choose a base branch
from
+23 −9
Open

docs: link out to container engine install from health #429

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,18 +63,18 @@ Not sure what these terms mean? The [glossary](docs/introduction/glossary.md) de

**Host machine** (where you run `topo`):

- [Docker](#install-docker)
- [Docker](#install-a-container-engine)
- OpenSSH Client

**Target machine** (the remote Arm system):

- Reachable with SSH
- Linux on ARM64
- [Docker](#install-docker)
- [Docker](#install-a-container-engine)

The host and target can be the same system. If you're working directly on an Arm Linux system, use `--target localhost`.

### Install Docker
### Install a Container Engine

See [Install Docker for Topo](docs/introduction/container-engines.md) for supported installation methods and verification steps.

Expand Down
2 changes: 1 addition & 1 deletion internal/health/check.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ func (c DockerComposeMinVersion) Run(ctx context.Context, r runner.Runner, _ Dep

if !version.IsAtLeastVersion(output.Version, c.MinVersion) {
return &Fix{
Description: fmt.Sprintf("Upgrade Docker Compose to version %s or later", c.MinVersion),
Description: fmt.Sprintf("Upgrade Docker Compose to version %s or later. See %s", c.MinVersion, containerEngineInstallURL),
}, fmt.Errorf("installed docker compose version %s is older than required version %s", output.Version, c.MinVersion)
}

Expand Down
24 changes: 19 additions & 5 deletions internal/health/dependencies.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ const (

type SoftwareDependency int

const containerEngineInstallURL = "https://github.com/arm/topo#install-a-container-engine"

const (
UnsetSoftwareDependency SoftwareDependency = iota
Docker
Expand Down Expand Up @@ -84,10 +86,16 @@ var HostRequiredDependencies = []Dependency{
Label: "Container Engine",
SoftwareEnumID: Docker,
Checks: []Check{
BinaryExists{},
BinaryExists{
Fix: &Fix{
Description: "Install a supported container engine. See " + containerEngineInstallURL,
},
},
CommandSuccessful{
Cmd: "docker info",
Fix: &Fix{Description: "Ensure current user can run docker commands"},
Fix: &Fix{
Description: "Ensure current user can run docker commands. See " + containerEngineInstallURL,
},
},
},
},
Expand All @@ -99,7 +107,7 @@ var HostRequiredDependencies = []Dependency{
CommandSuccessful{
Cmd: "docker compose",
Fix: &Fix{
Description: "Ensure Docker Compose is installed as a plugin for Docker",
Description: "Ensure Docker Compose is installed as a plugin for Docker. See " + containerEngineInstallURL,
},
},
DockerComposeMinVersion{
Expand All @@ -116,10 +124,16 @@ func TargetRequiredDependencies(target ssh.Destination) []Dependency {
Label: "Container Engine",
SoftwareEnumID: Docker,
Checks: []Check{
BinaryExists{},
BinaryExists{
Fix: &Fix{
Description: "Install a supported container engine. See " + containerEngineInstallURL,
},
},
CommandSuccessful{
Cmd: "docker info",
Fix: &Fix{Description: "Ensure current user can run docker commands"},
Fix: &Fix{
Description: "Ensure current user can run docker commands. See " + containerEngineInstallURL,
},
},
},
},
Expand Down