Underscore in profile name prevents k8s node registration

Open Beginner friendly
#745 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
go, kubernetes
Domain
cli, devtools

Research direction

Look at the code that generates the Kubernetes node name from the profile name, likely in the CLI or VM setup logic. The error shows the node name is 'colima-foo_bar'; find where this string is constructed and add validation or sanitization to replace underscores with hyphens. Test by starting a VM with an underscore profile and checking the k3s logs for the error.

Written by the indexing model from the issue text.

Description

Description

Creating a new Kubernetes VM with an underscore _ in the profile name causes the node registration to fail. Node names need to be RFC 1123 compliant.

Version

Colima Version: 0.5.5
Lima Version: 0.16.0
Qemu Version: 8.0.0

Operating System
  • macOS Intel <= 12 (Monterrey)
  • macOS Intel >= 13 (Ventura)
  • macOS M1 <= 12 (Monterrey)
  • macOS M1 >= 13 (Ventura)
  • Linux
Output of colima status
$ colima status -p foo_bar
INFO[0000] colima [profile=foo_bar] is running using QEMU
INFO[0000] arch: aarch64
INFO[0000] runtime: containerd
INFO[0000] mountType: sshfs
INFO[0000] kubernetes: enabled
Reproduction Steps
  1. colima start -p foo_bar --kubernetes -r containerd
  2. colima ssh
  3. View the k3s log file: less /var/log/k3s.log
E0627 20:00:38.698958    3567 kubelet_node_status.go:92] "Unable to register node with API server" err="Node \"colima-foo_bar\" is invalid: metadata.name: 
Invalid value: \"colima-foo_bar\": a lowercase RFC 1123 subdomain must consist of lower case alphanumeric characters, '-' or '.', and 
must start and end with an alphanumeric character
(e.g. 'example.com', regex used for validation is '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*')" node="colima-foo_bar"

(^^^ edited log line for formatting)

Expected behaviour

Colima's config could either enforce an RFC 1123 compliant profile name, or replace incompatible characters in the node name.

Additional context

No response

Dominant language
Go
Stars
30.9k
Forks
618
Avg merge
6d 6h
Merged PRs (30d)
4

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from abiosoft/colima

All issues in abiosoft/colima

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.