From a57f70b1c7712344b50f0db2ada21495a40d4b1e Mon Sep 17 00:00:00 2001
From: Nikolay Edigaryev
Date: Tue, 28 Nov 2023 19:56:45 +0400
Subject: [PATCH 1/2] Document available VM images on the website
---
docs/quick-start.md | 32 ++++++++++++++++++++++++++++++++
1 file changed, 32 insertions(+)
diff --git a/docs/quick-start.md b/docs/quick-start.md
index 54383b00..79036ed2 100644
--- a/docs/quick-start.md
+++ b/docs/quick-start.md
@@ -28,6 +28,38 @@ tart run sonoma-base
+## VM images
+
+The following macOS images are currently available:
+
+* macOS 14 (Sonoma)
+ * `ghcr.io/cirruslabs/macos-sonoma-vanilla:latest`
+ * `ghcr.io/cirruslabs/macos-sonoma-base:latest`
+ * `ghcr.io/cirruslabs/macos-sonoma-xcode:latest`
+* macOS 13 (Ventura)
+ * `ghcr.io/cirruslabs/macos-ventura-vanilla:latest`
+ * `ghcr.io/cirruslabs/macos-ventura-base:latest`
+ * `ghcr.io/cirruslabs/macos-ventura-xcode:latest`
+* macOS 12 (Monterey)
+ * `ghcr.io/cirruslabs/macos-monterey-vanilla:latest`
+ * `ghcr.io/cirruslabs/macos-monterey-base:latest`
+ * `ghcr.io/cirruslabs/macos-monterey-xcode:latest`
+
+There's also a [full list of images](https://github.com/orgs/cirruslabs/packages?tab=packages&q=macos-) in which you can discovery specific tags (e.g. `ghcr.io/cirruslabs/macos-monterey-xcode:15`) and [macOS-specific Packer templates](https://github.com/cirruslabs/macos-image-templates) that were used to generate these images.
+
+For, Linux the options are as follows:
+
+* Ubuntu
+ * `ghcr.io/cirruslabs/ubuntu:latest`
+* Debian
+ * `ghcr.io/cirruslabs/debian:latest`
+* Fedora
+ * `ghcr.io/cirruslabs/fedora:latest`
+
+These Linux images can be ran natively on [Vetu](https://github.com/cirruslabs/vetu), our virtualization solution for Linux, assuming that Vetu itself is running on an `arm64` machine.
+
+Similarly to macOS, there's also a [full list of images](https://github.com/orgs/cirruslabs/packages?repo_name=linux-image-templates) in which you can discovery specific tags (e.g. `ghcr.io/cirruslabs/ubuntu:22.04`) and [Linux-specific Packer templates](https://github.com/cirruslabs/linux-image-templates) that were used to generate these images.
+
## SSH access
If the guest VM is running and configured to accept incoming SSH connections you can conveniently connect to it like so:
From 1728270df96011a1083ad6b779d8a4839b60fbfe Mon Sep 17 00:00:00 2001
From: Nikolay Edigaryev
Date: Tue, 28 Nov 2023 20:23:45 +0400
Subject: [PATCH 2/2] Fix indents
---
docs/quick-start.md | 24 ++++++++++++------------
1 file changed, 12 insertions(+), 12 deletions(-)
diff --git a/docs/quick-start.md b/docs/quick-start.md
index 79036ed2..e881efb0 100644
--- a/docs/quick-start.md
+++ b/docs/quick-start.md
@@ -33,28 +33,28 @@ tart run sonoma-base
The following macOS images are currently available:
* macOS 14 (Sonoma)
- * `ghcr.io/cirruslabs/macos-sonoma-vanilla:latest`
- * `ghcr.io/cirruslabs/macos-sonoma-base:latest`
- * `ghcr.io/cirruslabs/macos-sonoma-xcode:latest`
+ * `ghcr.io/cirruslabs/macos-sonoma-vanilla:latest`
+ * `ghcr.io/cirruslabs/macos-sonoma-base:latest`
+ * `ghcr.io/cirruslabs/macos-sonoma-xcode:latest`
* macOS 13 (Ventura)
- * `ghcr.io/cirruslabs/macos-ventura-vanilla:latest`
- * `ghcr.io/cirruslabs/macos-ventura-base:latest`
- * `ghcr.io/cirruslabs/macos-ventura-xcode:latest`
+ * `ghcr.io/cirruslabs/macos-ventura-vanilla:latest`
+ * `ghcr.io/cirruslabs/macos-ventura-base:latest`
+ * `ghcr.io/cirruslabs/macos-ventura-xcode:latest`
* macOS 12 (Monterey)
- * `ghcr.io/cirruslabs/macos-monterey-vanilla:latest`
- * `ghcr.io/cirruslabs/macos-monterey-base:latest`
- * `ghcr.io/cirruslabs/macos-monterey-xcode:latest`
+ * `ghcr.io/cirruslabs/macos-monterey-vanilla:latest`
+ * `ghcr.io/cirruslabs/macos-monterey-base:latest`
+ * `ghcr.io/cirruslabs/macos-monterey-xcode:latest`
There's also a [full list of images](https://github.com/orgs/cirruslabs/packages?tab=packages&q=macos-) in which you can discovery specific tags (e.g. `ghcr.io/cirruslabs/macos-monterey-xcode:15`) and [macOS-specific Packer templates](https://github.com/cirruslabs/macos-image-templates) that were used to generate these images.
For, Linux the options are as follows:
* Ubuntu
- * `ghcr.io/cirruslabs/ubuntu:latest`
+ * `ghcr.io/cirruslabs/ubuntu:latest`
* Debian
- * `ghcr.io/cirruslabs/debian:latest`
+ * `ghcr.io/cirruslabs/debian:latest`
* Fedora
- * `ghcr.io/cirruslabs/fedora:latest`
+ * `ghcr.io/cirruslabs/fedora:latest`
These Linux images can be ran natively on [Vetu](https://github.com/cirruslabs/vetu), our virtualization solution for Linux, assuming that Vetu itself is running on an `arm64` machine.