Merge pull request #2817 from AkihiroSuda/fix-2813-alt

Allow "." and "_" in instance names, disallow them in hostnames

Author: AkihiroSuda

cmd/limactl/guessarg/guessarg.go

@@ -56,7 +56,8 @@ func InstNameFromURL(urlStr string) (string, error) {
 func InstNameFromYAMLPath(yamlPath string) (string, error) {
 	s := strings.ToLower(filepath.Base(yamlPath))
 	s = strings.TrimSuffix(strings.TrimSuffix(s, ".yml"), ".yaml")
-	s = strings.ReplaceAll(s, ".", "-")
+	// "." is allowed in instance names, but replaced to "-" for hostnames.
+	// e.g., yaml: "ubuntu-24.04.yaml" , instance name: "ubuntu-24.04", hostname: "lima-ubuntu-24-04"
 	if err := identifiers.Validate(s); err != nil {
 		return "", fmt.Errorf("filename %q is invalid: %w", yamlPath, err)
 	}

cmd/limactl/show-ssh.go

@@ -86,8 +86,8 @@ func showSSHAction(cmd *cobra.Command, args []string) error {
 		}
 		return err
 	}
-	logrus.Warnf("`limactl show-ssh` is deprecated. Instead, use `ssh -F %s lima-%s`.",
-		filepath.Join(inst.Dir, filenames.SSHConfig), inst.Name)
+	logrus.Warnf("`limactl show-ssh` is deprecated. Instead, use `ssh -F %s %s`.",
+		filepath.Join(inst.Dir, filenames.SSHConfig), inst.Hostname)
 	opts, err := sshutil.SSHOpts(
 		inst.Dir,
 		*inst.Config.SSH.LoadDotSSHPubKeys,

cmd/limactl/tunnel.go

@@ -146,7 +146,7 @@ func tunnelAction(cmd *cobra.Command, args []string) error {
 	default:
 		fmt.Fprintf(stdout, "Set `ALL_PROXY=socks5h://127.0.0.1:%d`, etc.\n", port)
 	}
-	fmt.Fprintf(stdout, "The instance can be connected from the host as <http://lima-%s.internal> via a web browser.\n", inst.Name)
+	fmt.Fprintf(stdout, "The instance can be connected from the host as <http://%s.internal> via a web browser.\n", inst.Hostname)
 
 	// TODO: show the port in `limactl list --json` ?
 	// TODO: add `--stop` flag to shut down the tunnel

pkg/cidata/cidata.TEMPLATE.d/meta-data

@@ -1,2 +1,2 @@
 instance-id: {{.IID}}
-local-hostname: lima-{{.Name}}
+local-hostname: {{.Hostname}}

pkg/cidata/cidata.go

@@ -17,6 +17,7 @@ import (
 
 	"github.com/docker/go-units"
 	"github.com/lima-vm/lima/pkg/debugutil"
+	"github.com/lima-vm/lima/pkg/identifierutil"
 	"github.com/lima-vm/lima/pkg/iso9660util"
 	"github.com/lima-vm/lima/pkg/limayaml"
 	"github.com/lima-vm/lima/pkg/localpathutil"
@@ -128,6 +129,7 @@ func templateArgs(bootScripts bool, instDir, name string, instConfig *limayaml.L
 		Debug:              debugutil.Debug,
 		BootScripts:        bootScripts,
 		Name:               name,
+		Hostname:           identifierutil.HostnameFromInstName(name), // TODO: support customization
 		User:               u.Username,
 		UID:                uid,
 		Home:               fmt.Sprintf("/home/%s.linux", u.Username),

pkg/cidata/template.go

@@ -56,6 +56,7 @@ type Disk struct {
 type TemplateArgs struct {
 	Debug                           bool
 	Name                            string // instance name
+	Hostname                        string // instance hostname
 	IID                             string // instance id
 	User                            string // user name
 	Home                            string // home directory

pkg/hostagent/hostagent.go

@@ -28,6 +28,7 @@ import (
 	hostagentapi "github.com/lima-vm/lima/pkg/hostagent/api"
 	"github.com/lima-vm/lima/pkg/hostagent/dns"
 	"github.com/lima-vm/lima/pkg/hostagent/events"
+	"github.com/lima-vm/lima/pkg/identifierutil"
 	"github.com/lima-vm/lima/pkg/limayaml"
 	"github.com/lima-vm/lima/pkg/networks"
 	"github.com/lima-vm/lima/pkg/osutil"
@@ -288,7 +289,8 @@ func (a *HostAgent) Run(ctx context.Context) error {
 	if limayaml.FirstUsernetIndex(a.instConfig) == -1 && *a.instConfig.HostResolver.Enabled {
 		hosts := a.instConfig.HostResolver.Hosts
 		hosts["host.lima.internal"] = networks.SlirpGateway
-		hosts[fmt.Sprintf("lima-%s", a.instName)] = networks.SlirpIPAddress
+		hostname := identifierutil.HostnameFromInstName(a.instName) // TODO: support customization
+		hosts[hostname] = networks.SlirpIPAddress
 		srvOpts := dns.ServerOptions{
 			UDPPort: a.udpDNSLocalPort,
 			TCPPort: a.tcpDNSLocalPort,

pkg/identifierutil/identifierutil.go

@@ -0,0 +1,9 @@
+package identifierutil
+
+import "strings"
+
+func HostnameFromInstName(instName string) string {
+	s := strings.ReplaceAll(instName, ".", "-")
+	s = strings.ReplaceAll(s, "_", "-")
+	return "lima-" + s
+}

pkg/identifierutil/identifierutil_test.go

@@ -0,0 +1,13 @@
+package identifierutil
+
+import (
+	"testing"
+
+	"gotest.tools/v3/assert"
+)
+
+func TestHostnameFromInstName(t *testing.T) {
+	assert.Equal(t, "lima-default", HostnameFromInstName("default"))
+	assert.Equal(t, "lima-ubuntu-24-04", HostnameFromInstName("ubuntu-24.04"))
+	assert.Equal(t, "lima-foo-bar-baz", HostnameFromInstName("foo_bar.baz"))
+}

pkg/instance/ansible.go

@@ -41,7 +41,7 @@ func runAnsiblePlaybook(ctx context.Context, inst *store.Instance, playbook stri
 func createAnsibleInventory(inst *store.Instance) (string, error) {
 	vars := map[string]interface{}{
 		"ansible_connection":      "ssh",
-		"ansible_host":            "lima-" + inst.Name,
+		"ansible_host":            inst.Hostname,
 		"ansible_ssh_common_args": "-F " + inst.SSHConfigFile,
 	}
 	hosts := map[string]interface{}{