Skip to content

Commit 159f1a9

Browse files
Merge pull request #1982 from madeline-underwood/Finch
Finch_JA to check
2 parents 9105750 + 3802aad commit 159f1a9

File tree

1 file changed

+21
-22
lines changed

1 file changed

+21
-22
lines changed

content/install-guides/finch.md

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
---
2-
title: Finch
2+
title: Finch on Arm Linux
33
author: Jason Andrews
44

5-
draft: true
6-
75
minutes_to_complete: 10
86

97
official_docs: https://runfinch.com/docs/
@@ -24,19 +22,19 @@ multitool_install_part: false
2422
weight: 1
2523
---
2624

27-
[Finch](https://runfinch.com) is an open-source container development tool from AWS that provides a simple, Docker-compatible CLI for working with containers using containerd and nerdctl under the hood. Finch is designed for Linux, macOS, and Windows, and is especially useful on Arm-based systems for efficient container workflows.
25+
[Finch](https://runfinch.com) is an open-source container development tool from AWS. It offers a simple, Docker-compatible CLI powered by containerd and nerdctl. Designed for Linux, macOS, and Windows, Finch is especially useful on Arm-based systems for efficient container workflows.
2826

29-
This guide explains how to install and use Finch on Arm Linux distributions, specifically Amazon Linux 2023 and Ubuntu 24.04.
27+
This guide explains how to install Finch on Arm Linux distributions, specifically Amazon Linux 2023 and Ubuntu 24.04.
3028

31-
To use Finch as described in this install guide, you need a system running Arm Linux. You can use a physical Arm device, a cloud instance from AWS, Azure, GCP, or OCI, or an Arm-based virtual machine.
29+
To get started, make sure you're using a system running Arm Linux. You can use a physical Arm device, a cloud instance from AWS, Azure, GCP, or OCI, or an Arm-based virtual machine.
3230

3331
To confirm the architecture, run:
3432

3533
```bash
3634
uname -m
3735
```
3836

39-
The output is `aarch64` for 64-bit Arm systems.
37+
The output should be `aarch64` for 64-bit Arm systems.
4038

4139
## How do I install Finch on Amazon Linux 2023 for Arm?
4240

@@ -54,13 +52,13 @@ Enable and start the containerd service:
5452
sudo systemctl start containerd
5553
```
5654

57-
Confirm that the containerd service is running:
55+
Check that the containerd service is running:
5856

5957
```console
6058
sudo systemctl status containerd
6159
```
6260

63-
The output shows the status:
61+
You should see something like:
6462

6563
```output
6664
● containerd.service - containerd container runtime
@@ -76,17 +74,16 @@ The output shows the status:
7674
└─25841 /usr/bin/containerd
7775
```
7876

79-
The `finch` command is now available in your PATH. You can now skip to the section on verifying the Finch installation.
77+
The `finch` command is now available in your PATH. You can now skip to the section on [verifying the Finch installation](#how-do-i-verify-the-finch-installation).
8078

81-
## How do I install Finch on Ubuntu 24.04 for Arm?
8279

83-
Finch does not provide a Debian package for Ubuntu, but you can install it manually as described below.
80+
## How do I install Finch on Ubuntu 24.04 for Arm?
8481

85-
### What are the required Finch dependencies?
82+
Finch doesn't currently provide a Debian package for Ubuntu, but you can install it manually, using the three steps outlined below.
8683

87-
First, install Nerdctl by following the instructions in the [Nerdctl install guide](/install-guides/nerdctl/).
84+
### Step 1: Install Finch dependencies
8885

89-
You will also need various tools to build Finch. Install them using:
86+
Install Nerdctl by following the instructions in the [Nerdctl install guide](/install-guides/nerdctl/). Then install the required tools:
9087

9188
```console
9289
sudo apt install -y \
@@ -95,9 +92,9 @@ sudo apt install -y \
9592
build-essential
9693
```
9794

98-
### How do I build Finch from source code?
95+
### Step 2: Build and install Finch
9996

100-
Run the commands below to download and build Finch from source:
97+
Clone the Finch repository and build the binary:
10198

10299
```console
103100
git clone https://github.com/runfinch/finch.git
@@ -107,7 +104,7 @@ make
107104
sudo make install
108105
```
109106

110-
### How do I configure Finch?
107+
### Step 3: Configure Finch
111108

112109
Create the Finch configuration directories:
113110

@@ -157,19 +154,21 @@ The version is printed:
157154
finch version v1.8.2
158155
```
159156

160-
Run a simple container to confirm Finch is working:
157+
Run a container to confirm functionality:
161158

162159
```bash
163160
sudo finch run --rm armswdev/uname
164161
```
165162

166-
If you see the architecture printed, then Finch is working correctly. The expected output is:
163+
If you see the architecture printed, then Finch is working correctly.
164+
165+
The expected output is:
167166

168167
```output
169168
Architecture is aarch64
170169
```
171170

172-
Print the container images on your system:
171+
Print your local container images:
173172

174173
```bash
175174
sudo finch images
@@ -182,6 +181,6 @@ REPOSITORY TAG IMAGE ID CREATED PLATFORM SIZ
182181
armswdev/uname latest 82762f30a4a3 43 seconds ago linux/arm64 110.4MB 28.89MB
183182
```
184183

185-
Use `sudo finch help` to discover additional Finch commands.
184+
Use `sudo finch help` to explore available commands.
186185

187186
You are ready to use Finch to run containers on your Arm Linux system.

0 commit comments

Comments
 (0)