Skip to content

Commit 720ebd6

Browse files
authored
doc: README for macadam v0.3.0 (#431)
* doc: README for macadam v0.3.0 Signed-off-by: Philippe Martin <phmartin@redhat.com> * fix: forgotten v0.2.0 * fix: more info on Linux Fedora supported versions --------- Signed-off-by: Philippe Martin <phmartin@redhat.com>
1 parent 9564a80 commit 720ebd6

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,27 @@ The `macadam` binary is embedded in the extension, nothing needs to be installed
1010

1111
### On Mac/arm64
1212

13-
When initialized, the extension checks if the necessary binaries are present in `/opt/macadam/bin`. If they are not, the extension installs them in this directory.
13+
When initialized, the extension checks if the necessary binaries are present in `/opt/macadam/bin`. Several scenarios can happen:
14+
- the binary is present and its version is the one expected by the extension (or a later version): the monitoring of VMs starts, and if VMs exist, they are listed in the Settings > RHEL VMs.
15+
- no binary is present: the monitoring of the VMs is not started, and even if VMs exist, they are not listed in Settings > RHEL VMs. The binary will be installed the first time the user creates a new VM, and the monitoring of VMs will be started at this moment,
16+
- the binary is present and its version is a prior version than the one expected by the extension: the monitoring is started with the found binary, and if VMs exist, they are listed in Settings > RHEL VMs. The first time the user makes an action on a VM (start, stop, delete, create), the correct binary is installed.
1417

15-
> If this installation fails, you can run the installer manually, using the installer found at https://github.com/crc-org/macadam/releases/tag/v0.2.0. After this, you need to restart the extension which should find and use the binaries.
18+
> If this installation fails, you can run the installer manually, using the installer found at https://github.com/crc-org/macadam/releases/tag/v0.3.0. After this, you need to restart the extension which should find and use the binaries.
1619
1720
### On Fedora Linux/x86_64
1821

19-
The `macadam` binary must be installed in the directory `/usr/local/bin/`: download the binary from https://github.com/crc-org/macadam/releases/tag/v0.2.0, rename it `macadam` and make it executable.
22+
The `macadam` binary must be installed in the directory `/usr/local/bin/`: download the binary from https://github.com/crc-org/macadam/releases/tag/v0.3.0, rename it `macadam` and make it executable.
2023

2124
```
22-
curl -L -o macadam https://github.com/crc-org/macadam/releases/download/v0.2.0/macadam-linux-amd64
25+
curl -L -o macadam https://github.com/crc-org/macadam/releases/download/v0.3.0/macadam-linux-amd64
2326
chmod 755 macadam
2427
sudo mkdir -p /usr/local/bin/
2528
sudo mv macadam /usr/local/bin/
2629
```
2730

2831
The `gvproxy` binary must be installed with the command `dnf install gvisor-tap-vsock`.
2932

33+
> macadam needs gvproxy >= 0.8.3 to work. On recent versions of Fedora, the version installed by the `gvisor-tap-vsock` package is correct. You may need to install it diffently in older Fedora releases.
3034
3135
## Install the extension
3236

0 commit comments

Comments
 (0)