Skip to content

De-deprecate LIMA_SSH_PORT_FORWARDER #3709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 9, 2025
Merged

De-deprecate LIMA_SSH_PORT_FORWARDER #3709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions pkg/hostagent/hostagent.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ type HostAgent struct {
instName string
instSSHAddress string
sshConfig *ssh.SSHConfig
portForwarder *portForwarder // legacy SSH port forwarder (deprecated)
portForwarder *portForwarder // legacy SSH port forwarder
grpcPortForwarder *portfwd.Forwarder

onClose []func() error // LIFO
Expand Down Expand Up @@ -660,7 +660,6 @@ func (a *HostAgent) processGuestAgentEvents(ctx context.Context, client *guestag
}
}
if useSSHFwd {
logrus.Warn("LIMA_SSH_PORT_FORWARDER is deprecated")
a.portForwarder.OnEvent(ctx, ev)
} else {
a.grpcPortForwarder.OnEvent(ctx, client, ev)
Expand Down
3 changes: 1 addition & 2 deletions website/content/en/docs/config/environment-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,6 @@ This page documents the environment variables used in Lima.
```sh
export LIMA_SSH_PORT_FORWARDER=false
```
- **Note**: Deprecated since v1.1. It is expected that this variable will be removed in future.
- **The history of the default value**:
| Version | Default value |
|---------------|---------------------|
Expand Down Expand Up @@ -170,4 +169,4 @@ This page documents the environment variables used in Lima.
- **Usage**:
```sh
export QEMU_SYSTEM_X86_64=/usr/local/bin/qemu-system-x86_64
```
```
1 change: 0 additions & 1 deletion website/content/en/docs/releases/deprecated.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ The following features are deprecated:
- CentOS 7 support
- Loading non-strict YAMLs (i.e., YAMLs with unknown properties)
- `limactl show-ssh` command (Use `ssh -F ~/.lima/default/ssh.config lima-default` instead)
- `LIMA_SSH_PORT_FORWARDER=true` (since Lima v1.1)
- Ansible provisioning mode (Use `ansible-playbook playbook.yaml` after the start instead)

## Removed features
Expand Down