Skip to content

Commit 9612c65

Browse files
ben-c8ybph-c8y
andauthored
Clarify mac readme (#99)
Trying to clarify that for Apama 26.x you'll be using native ARM64 packages but have to use x86 on 10.15. And that although you are using dev containers, you can't use the Dev Container repo described above for x86 linux --------- Co-authored-by: Bevan Philip <bevan.philip@cumulocity.com>
1 parent 84469f9 commit 9612c65

1 file changed

Lines changed: 22 additions & 2 deletions

File tree

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ For the older 10.15 release:
4545

4646
For Apama 26.x and higher there is no Windows installation package of Apama, so we recommend using the VS Code [WSL](https://code.visualstudio.com/docs/remote/wsl) extension which allows VS Code running on Windows to use a Linux-based Apama installation package.
4747

48-
1. Install the latest version of [WSL](https://learn.microsoft.com/en-us/windows/wsl/install), using the **Debian** distribution of Linux. This may take some time and often requires a restart. See the WSL and also VS Code instructions for full details, but typical steps on a recent version of Windows would be:
48+
1. Install the latest version of [WSL](https://learn.microsoft.com/en-us/windows/wsl/install), and add the **Debian** distribution of Linux. This may take some time and often requires a restart. See the WSL and also VS Code instructions for full details, but typical steps on a recent version of Windows would be:
4949
* Open a PowerShell terminal "as Administrator"
5050
* `wsl --install`
5151
* `wsl --install -d Debian`
@@ -70,7 +70,27 @@ The versions of Apama and the SDKs can be configured: see the DevContainer READM
7070
To use DevContainers, you will need a containerization environment on your computer. [Microsoft's VS Code documentation](https://code.visualstudio.com/remote/advancedcontainers/docker-options) should give you some guidance in that area.
7171

7272
### Using the extension on macOS
73-
For users on macOS (Intel or Apple Silicon), we recommend using [colima](https://github.com/abiosoft/colima) and the DevContainer approach mentioned above.
73+
#### Using Lima to create a virtual machine
74+
For users on macOS (Intel or Apple Silicon), we recommend using the [lima](https://github.com/lima-vm/lima) virtualization runtime.
75+
76+
Once Lima has been installed, create a virtual machine with Debian as the image. If you are on 26.x and on an Apple Silicon machine, create an ARM64 VM. Otherwise, create an x86 VM.
77+
78+
```bash
79+
# ARM64
80+
limactl create --name debian template://debian-12
81+
82+
# x86
83+
limactl create --name debian-x86 --arch x86_64 --rosetta template://debian-12
84+
```
85+
86+
Once your virtual machine is created, start it up, and shell into it. Then install Apama using the instructions from "Using a Linux installation".
87+
88+
Use the [Visual Studio Code Remote Development Extension Pack](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack) to connect to your virtual machine.
89+
90+
Tip: to show your Lima VMs in Remote-SSH, run `echo -e "\nInclude ${LIMA_HOME:-$HOME/.lima}/debian-x86/ssh.config" >> ~/.ssh/config` in a terminal ([source](https://github.com/lima-vm/lima/discussions/1890)).
91+
92+
#### Dev Container
93+
Another possible approach is to use [colima](https://github.com/abiosoft/colima) and the Dev Container approach mentioned in "Using a Development Container".
7494

7595
This is currently an x86 image.
7696

0 commit comments

Comments
 (0)