From aaa5603ebe308ed19bf76dafd85735493cebfe28 Mon Sep 17 00:00:00 2001 From: Akihiro Suda Date: Fri, 8 Nov 2024 22:59:04 +0900 Subject: [PATCH 1/7] website: reduce directories Signed-off-by: Akihiro Suda --- .../en/docs/community/{contributing/_index.md => contributing.md} | 0 .../en/docs/community/{governance/_index.md => governance.md} | 0 .../content/en/docs/community/{roadmap/_index.md => roadmap.md} | 0 .../en/docs/community/{subprojects/_index.md => subprojects.md} | 0 website/content/en/docs/config/{mount/_index.md => mount.md} | 0 .../en/docs/config/{multi-arch/_index.md => multi-arch.md} | 0 website/content/en/docs/config/{network/_index.md => network.md} | 0 website/content/en/docs/config/{Port/_index.md => port.md} | 0 website/content/en/docs/config/{vmtype/_index.md => vmtype.md} | 0 website/content/en/docs/dev/{internals/_index.md => internals.md} | 0 website/content/en/docs/dev/{testing/_index.md => testing.md} | 0 website/content/en/docs/faq/{colima/_index.md => colima.md} | 0 .../en/docs/releases/{deprecated/_index.md => deprecated.md} | 0 .../en/docs/releases/{experimental/_index.md => experimental.md} | 0 14 files changed, 0 insertions(+), 0 deletions(-) rename website/content/en/docs/community/{contributing/_index.md => contributing.md} (100%) rename website/content/en/docs/community/{governance/_index.md => governance.md} (100%) rename website/content/en/docs/community/{roadmap/_index.md => roadmap.md} (100%) rename website/content/en/docs/community/{subprojects/_index.md => subprojects.md} (100%) rename website/content/en/docs/config/{mount/_index.md => mount.md} (100%) rename website/content/en/docs/config/{multi-arch/_index.md => multi-arch.md} (100%) rename website/content/en/docs/config/{network/_index.md => network.md} (100%) rename website/content/en/docs/config/{Port/_index.md => port.md} (100%) rename website/content/en/docs/config/{vmtype/_index.md => vmtype.md} (100%) rename website/content/en/docs/dev/{internals/_index.md => internals.md} (100%) rename website/content/en/docs/dev/{testing/_index.md => testing.md} (100%) rename website/content/en/docs/faq/{colima/_index.md => colima.md} (100%) rename website/content/en/docs/releases/{deprecated/_index.md => deprecated.md} (100%) rename website/content/en/docs/releases/{experimental/_index.md => experimental.md} (100%) diff --git a/website/content/en/docs/community/contributing/_index.md b/website/content/en/docs/community/contributing.md similarity index 100% rename from website/content/en/docs/community/contributing/_index.md rename to website/content/en/docs/community/contributing.md diff --git a/website/content/en/docs/community/governance/_index.md b/website/content/en/docs/community/governance.md similarity index 100% rename from website/content/en/docs/community/governance/_index.md rename to website/content/en/docs/community/governance.md diff --git a/website/content/en/docs/community/roadmap/_index.md b/website/content/en/docs/community/roadmap.md similarity index 100% rename from website/content/en/docs/community/roadmap/_index.md rename to website/content/en/docs/community/roadmap.md diff --git a/website/content/en/docs/community/subprojects/_index.md b/website/content/en/docs/community/subprojects.md similarity index 100% rename from website/content/en/docs/community/subprojects/_index.md rename to website/content/en/docs/community/subprojects.md diff --git a/website/content/en/docs/config/mount/_index.md b/website/content/en/docs/config/mount.md similarity index 100% rename from website/content/en/docs/config/mount/_index.md rename to website/content/en/docs/config/mount.md diff --git a/website/content/en/docs/config/multi-arch/_index.md b/website/content/en/docs/config/multi-arch.md similarity index 100% rename from website/content/en/docs/config/multi-arch/_index.md rename to website/content/en/docs/config/multi-arch.md diff --git a/website/content/en/docs/config/network/_index.md b/website/content/en/docs/config/network.md similarity index 100% rename from website/content/en/docs/config/network/_index.md rename to website/content/en/docs/config/network.md diff --git a/website/content/en/docs/config/Port/_index.md b/website/content/en/docs/config/port.md similarity index 100% rename from website/content/en/docs/config/Port/_index.md rename to website/content/en/docs/config/port.md diff --git a/website/content/en/docs/config/vmtype/_index.md b/website/content/en/docs/config/vmtype.md similarity index 100% rename from website/content/en/docs/config/vmtype/_index.md rename to website/content/en/docs/config/vmtype.md diff --git a/website/content/en/docs/dev/internals/_index.md b/website/content/en/docs/dev/internals.md similarity index 100% rename from website/content/en/docs/dev/internals/_index.md rename to website/content/en/docs/dev/internals.md diff --git a/website/content/en/docs/dev/testing/_index.md b/website/content/en/docs/dev/testing.md similarity index 100% rename from website/content/en/docs/dev/testing/_index.md rename to website/content/en/docs/dev/testing.md diff --git a/website/content/en/docs/faq/colima/_index.md b/website/content/en/docs/faq/colima.md similarity index 100% rename from website/content/en/docs/faq/colima/_index.md rename to website/content/en/docs/faq/colima.md diff --git a/website/content/en/docs/releases/deprecated/_index.md b/website/content/en/docs/releases/deprecated.md similarity index 100% rename from website/content/en/docs/releases/deprecated/_index.md rename to website/content/en/docs/releases/deprecated.md diff --git a/website/content/en/docs/releases/experimental/_index.md b/website/content/en/docs/releases/experimental.md similarity index 100% rename from website/content/en/docs/releases/experimental/_index.md rename to website/content/en/docs/releases/experimental.md From 8610d99dfdf2628d650ff08a4e4a5bde0375d827 Mon Sep 17 00:00:00 2001 From: Akihiro Suda Date: Fri, 8 Nov 2024 22:58:11 +0900 Subject: [PATCH 2/7] website: installation: remove "Lima is not regularly tested on ARM Mac" This sentence is still true, but not worth emphasizing in the installation document. Signed-off-by: Akihiro Suda --- website/content/en/docs/installation/_index.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/website/content/en/docs/installation/_index.md b/website/content/en/docs/installation/_index.md index 4881090151d..a946ea00869 100644 --- a/website/content/en/docs/installation/_index.md +++ b/website/content/en/docs/installation/_index.md @@ -2,9 +2,6 @@ title: Installation weight: 1 --- -> **NOTE** -> Lima is not regularly tested on ARM Mac (due to lack of CI). - Prerequisite: - QEMU 7.0 or later (Required, only if QEMU driver is used) From 088e27b081521cae53653c0492b1d678a40ddf71 Mon Sep 17 00:00:00 2001 From: Akihiro Suda Date: Fri, 8 Nov 2024 23:03:51 +0900 Subject: [PATCH 3/7] website: adjust weight Signed-off-by: Akihiro Suda --- website/content/en/docs/config/environment-variables.md | 2 +- website/content/en/docs/config/port.md | 2 +- website/content/en/docs/talks/_index.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/website/content/en/docs/config/environment-variables.md b/website/content/en/docs/config/environment-variables.md index b8d27213025..815c0fdd6e7 100644 --- a/website/content/en/docs/config/environment-variables.md +++ b/website/content/en/docs/config/environment-variables.md @@ -1,6 +1,6 @@ --- title: Environment Variables -weight: 6 +weight: 80 --- ## Environment Variables diff --git a/website/content/en/docs/config/port.md b/website/content/en/docs/config/port.md index 70e3d492ead..9f18bb6228c 100644 --- a/website/content/en/docs/config/port.md +++ b/website/content/en/docs/config/port.md @@ -1,6 +1,6 @@ --- title: Port Forwarding -weight: 50 +weight: 31 --- Lima supports automatic port-forwarding of localhost ports from guest to host. diff --git a/website/content/en/docs/talks/_index.md b/website/content/en/docs/talks/_index.md index 33751a5eb2e..5baa78301ba 100644 --- a/website/content/en/docs/talks/_index.md +++ b/website/content/en/docs/talks/_index.md @@ -1,6 +1,6 @@ --- title: Talks -weight: 10 +weight: 450 --- ## 2022 From 79c47044b775ec86484e98aa474920ec93b42682 Mon Sep 17 00:00:00 2001 From: Akihiro Suda Date: Fri, 8 Nov 2024 23:07:48 +0900 Subject: [PATCH 4/7] website: env var: add LIMA_SSH_PORT_FORWARDER Signed-off-by: Akihiro Suda --- .../content/en/docs/config/environment-variables.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/website/content/en/docs/config/environment-variables.md b/website/content/en/docs/config/environment-variables.md index 815c0fdd6e7..745fb82e2ab 100644 --- a/website/content/en/docs/config/environment-variables.md +++ b/website/content/en/docs/config/environment-variables.md @@ -47,6 +47,17 @@ This page documents the environment variables used in Lima. lima ``` +### `LIMA_SSH_PORT_FORWARDER` + +- **Description**: Specifies to use the SSH port forwarder (slow, stable) instead of gRPC (fast, unstable) +- **Default**: `true` +- **Usage**: + ```sh + export LIMA_SSH_PORT_FORWARDER=false + ``` +- **Note**: It is expected that this variable will be set to `false` by default in future + when the gRPC port forwarder is well matured. + ### `LIMA_USERNET_RESOLVE_IP_ADDRESS_TIMEOUT` - **Description**: Specifies the timeout duration for resolving the IP address in usernet. From be1d1c94386b147bc841cddfb840ed67b3310156 Mon Sep 17 00:00:00 2001 From: Akihiro Suda Date: Fri, 8 Nov 2024 23:12:14 +0900 Subject: [PATCH 5/7] website: chmod -x _index.md Signed-off-by: Akihiro Suda --- website/content/en/docs/_index.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) mode change 100755 => 100644 website/content/en/docs/_index.md diff --git a/website/content/en/docs/_index.md b/website/content/en/docs/_index.md old mode 100755 new mode 100644 From 2d4091aac4c785082c1bd56d9e2a500000ee4da1 Mon Sep 17 00:00:00 2001 From: Akihiro Suda Date: Fri, 8 Nov 2024 23:16:29 +0900 Subject: [PATCH 6/7] website: add the security page Signed-off-by: Akihiro Suda --- website/content/en/docs/security/_index.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 website/content/en/docs/security/_index.md diff --git a/website/content/en/docs/security/_index.md b/website/content/en/docs/security/_index.md new file mode 100644 index 00000000000..56294166feb --- /dev/null +++ b/website/content/en/docs/security/_index.md @@ -0,0 +1,16 @@ +--- +title: Security +weight: 350 +--- + +## Security model + +See . + +## Reporting vulnerabilities + +See . + +## Past vulnerabilities + +See . From 3f17abfb161ac61987b83f585d3f4bd5b69d8782 Mon Sep 17 00:00:00 2001 From: Akihiro Suda Date: Fri, 8 Nov 2024 23:21:31 +0900 Subject: [PATCH 7/7] website: update FAQ Signed-off-by: Akihiro Suda --- website/content/en/docs/faq/_index.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/website/content/en/docs/faq/_index.md b/website/content/en/docs/faq/_index.md index e3b6cab2269..30513332ba6 100644 --- a/website/content/en/docs/faq/_index.md +++ b/website/content/en/docs/faq/_index.md @@ -32,7 +32,7 @@ weight: 6 - [Filesystem sharing](#filesystem-sharing) - ["Filesystem is slow"](#filesystem-is-slow) - ["Filesystem is not writable"](#filesystem-is-not-writable) - - ["Filesystem is unmounted after upgrading Lima to v1.0 (pre-release)"](#filesystem-is-unmounted-after-upgrading-lima-to-v10-pre-release) + - ["Filesystem is unmounted after upgrading Lima to v1.0"](#filesystem-is-unmounted-after-upgrading-lima-to-v10) - [External projects](#external-projects) - ["I am using Rancher Desktop. How to deal with the underlying Lima?"](#i-am-using-rancher-desktop-how-to-deal-with-the-underlying-lima) - ["Hints for debugging other problems?"](#hints-for-debugging-other-problems) @@ -42,9 +42,9 @@ weight: 6 ### Generic #### "How does Lima work?" -- Hypervisor: [QEMU with HVF accelerator (default), or Virtualization.framework](../config/vmtype/) -- Filesystem sharing: [Reverse SSHFS (default), or virtio-9p-pci aka virtfs, or virtiofs](../config/mount/) -- Port forwarding: `ssh -L`, automated by watching `/proc/net/tcp` and `iptables` events in the guest +- Hypervisor: [QEMU (default on Linux), or Virtualization.framework (default on macOS)](../config/vmtype/) +- Filesystem sharing: [Reverse SSHFS, virtio-9p-pci aka virtfs (default for QEMU), or virtiofs (default for Virtualization.framework)](../config/mount/) +- Port forwarding: [`ssh -L`](../config/port), automated by watching `/proc/net/tcp` and `iptables` events in the guest #### "What's my login password?" Password is disabled and locked by default. @@ -53,7 +53,7 @@ You have to use `limactl shell bash` (or `lima bash`) to open a shell. Alternatively, you may also directly ssh into the guest: `ssh -p 60022 -i ~/.lima/_config/user -o NoHostAuthenticationForLocalhost=yes 127.0.0.1`. #### "Does Lima work on ARM Mac?" -Yes, it should work, but not regularly tested on ARM (due to lack of CI). +Yes #### "Can I run non-Ubuntu guests?" AlmaLinux, Alpine, Arch Linux, Debian, Fedora, openSUSE, Oracle Linux, and Rocky are also known to work. @@ -231,9 +231,9 @@ mounts: Run `limactl edit ` to open the YAML editor for an existing instance. -#### "Filesystem is unmounted after upgrading Lima to v1.0 (pre-release)" +#### "Filesystem is unmounted after upgrading Lima to v1.0" -Lima v1.0 (pre-release) changed the default mount type for QEMU from `reverse-sshfs` to `9p`. +Lima v1.0 changed the default mount type for QEMU from `reverse-sshfs` to `9p`. The `9p` mount type is known to be incompatible with the following guest operating systems: - AlmaLinux, CentOS Stream, Oracle Linux, and RockyLinux