Merge pull request #2526 from SmartManoj/add-environment-variables

Add environment variables documentation

Author: AkihiroSuda

cmd/docker.lima

@@ -1,5 +1,9 @@
 #!/bin/sh
 set -eu
+
+# Environment Variables
+# LIMA_INSTANCE: Specifies the name of the Lima instance to use. Default is "docker".
+
 : "${LIMA_INSTANCE:=docker}"
 : "${DOCKER:=docker}"
 

cmd/kubectl.lima

@@ -1,5 +1,9 @@
 #!/bin/sh
 set -eu
+
+# Environment Variables
+# LIMA_INSTANCE: Specifies the name of the Lima instance to use. Default is empty.
+
 : "${LIMA_INSTANCE:=}"
 : "${KUBECTL:=kubectl}"
 

cmd/lima

@@ -1,5 +1,12 @@
 #!/bin/sh
 set -eu
+
+# Environment Variables
+# LIMA_INSTANCE: Specifies the name of the Lima instance to use. Default is "default".
+# LIMA_SHELL: Specifies the shell interpreter to use inside the Lima instance. Default is the user's shell configured inside the instance.
+# LIMA_WORKDIR: Specifies the initial working directory inside the Lima instance. Default is the current directory from the host.
+# LIMACTL: Specifies the path to the limactl binary. Default is "limactl" in $PATH.
+
 : "${LIMA_INSTANCE:=default}"
 : "${LIMA_SHELL:=}"
 : "${LIMA_WORKDIR:=}"

cmd/lima.bat

@@ -1,4 +1,8 @@
-@echo off
-IF NOT DEFINED LIMACTL (SET LIMACTL=limactl)
-IF NOT DEFINED LIMA_INSTANCE (SET LIMA_INSTANCE=default)
-%LIMACTL% shell %LIMA_INSTANCE% %*
+@echo off
+REM Environment Variables
+REM LIMA_INSTANCE: Specifies the name of the Lima instance to use. Default is "default".
+REM LIMACTL: Specifies the path to the limactl binary. Default is "limactl" in %PATH%.
+
+IF NOT DEFINED LIMACTL (SET LIMACTL=limactl)
+IF NOT DEFINED LIMA_INSTANCE (SET LIMA_INSTANCE=default)
+%LIMACTL% shell %LIMA_INSTANCE% %*

cmd/limactl/usernet.go

@@ -73,6 +73,9 @@ func usernetAction(cmd *cobra.Command, _ []string) error {
 	os.RemoveAll(qemuSocket)
 	os.RemoveAll(fdSocket)
 
+	// Environment Variables
+	// LIMA_USERNET_RESOLVE_IP_ADDRESS_TIMEOUT: Specifies the timeout duration for resolving IP addresses in minutes. Default is 2 minutes.
+
 	return usernet.StartGVisorNetstack(cmd.Context(), &usernet.GVisorNetstackOpts{
 		MTU:           mtu,
 		Endpoint:      endpoint,

website/content/en/docs/config/_index.md

@@ -12,3 +12,5 @@ The current default spec:
 - Disk: 100 GiB
 - Mounts: `~` (read-only), `/tmp/lima` (writable)
 - SSH: 127.0.0.1:60022
+
+For environment variables, see [Environment Variables](./environment-variables/).

website/content/en/docs/config/environment-variables.md

@@ -0,0 +1,57 @@
+---
+title: Environment Variables
+weight: 6
+---
+
+## Environment Variables
+
+This page documents the environment variables used in Lima.
+
+### `LIMA_INSTANCE`
+
+- **Description**: Specifies the name of the Lima instance to use.
+- **Default**: `default`
+- **Usage**: 
+  ```sh
+  export LIMA_INSTANCE=my-instance
+  lima uname -a
+  ```
+
+### `LIMA_SHELL`
+
+- **Description**: Specifies the shell interpreter to use inside the Lima instance.
+- **Default**: User's shell configured inside the instance
+- **Usage**: 
+  ```sh
+  export LIMA_SHELL=/bin/bash
+  lima
+  ```
+
+### `LIMA_WORKDIR`
+
+- **Description**: Specifies the initial working directory inside the Lima instance.
+- **Default**: Current directory from the host
+- **Usage**: 
+  ```sh
+  export LIMA_WORKDIR=/home/user/project
+  lima
+  ```
+
+### `LIMACTL`
+
+- **Description**: Specifies the path to the `limactl` binary.
+- **Default**: `limactl` in `$PATH`
+- **Usage**: 
+  ```sh
+  export LIMACTL=/usr/local/bin/limactl
+  lima
+  ```
+
+### `LIMA_USERNET_RESOLVE_IP_ADDRESS_TIMEOUT`
+
+- **Description**: Specifies the timeout duration for resolving the IP address in usernet.
+- **Default**: 2 minutes
+- **Usage**: 
+  ```sh
+  export LIMA_USERNET_RESOLVE_IP_ADDRESS_TIMEOUT=5
+  ```