local connect: add opt-in --local-dns for resolving cluster names via a local DNS resolver #342
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| package local | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "io" | ||
|
|
||
| "github.com/signadot/cli/internal/config" | ||
| sbmgr "github.com/signadot/cli/internal/locald/sandboxmanager" | ||
| "github.com/signadot/cli/internal/print" | ||
| "github.com/signadot/cli/internal/sdtab" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| func newHosts(localConfig *config.Local) *cobra.Command { | ||
| cfg := &config.LocalHosts{Local: localConfig} | ||
|
|
||
| cmd := &cobra.Command{ | ||
| Use: "hosts", | ||
| Short: "List the cluster hosts resolvable from the local machine and their IP addresses", | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| return runHosts(cfg, cmd.OutOrStdout(), args) | ||
| }, | ||
| } | ||
| cfg.AddFlags(cmd) | ||
|
|
||
| return cmd | ||
| } | ||
|
|
||
| // printableHost is the JSON/YAML shape of a single resolvable host. Each host | ||
| // carries exactly one address: the root controller assigns a single virtual | ||
| // address per name and reports it as HostEntry.Ip (IPv4-preferred). | ||
| type printableHost struct { | ||
| Name string `json:"name"` | ||
| IP string `json:"ip"` | ||
| } | ||
|
|
||
| func runHosts(cfg *config.LocalHosts, out io.Writer, args []string) error { | ||
| if err := cfg.InitLocalConfig(); err != nil { | ||
| return err | ||
| } | ||
| resp, err := sbmgr.GetHosts() | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| hosts := make([]printableHost, 0, len(resp.Entries)) | ||
| for _, e := range resp.Entries { | ||
| hosts = append(hosts, printableHost{Name: e.Name, IP: e.Ip}) | ||
| } | ||
|
|
||
| switch cfg.OutputFormat { | ||
| case config.OutputFormatDefault: | ||
| return printHosts(out, hosts) | ||
| case config.OutputFormatJSON: | ||
| return print.RawJSON(out, hosts) | ||
| case config.OutputFormatYAML: | ||
| return print.RawK8SYAML(out, hosts) | ||
| default: | ||
| return fmt.Errorf("unsupported output format: %q", cfg.OutputFormat) | ||
| } | ||
| } | ||
|
|
||
| type hostRow struct { | ||
| Name string `sdtab:"NAME"` | ||
| IP string `sdtab:"IP"` | ||
| } | ||
|
|
||
| // printHosts renders the default aligned NAME/IP table, consistent with the | ||
| // other list commands (cluster, routegroup, ...). The entries arrive already | ||
| // sorted by name from the root controller (see rootServer.GetHosts). | ||
| func printHosts(out io.Writer, hosts []printableHost) error { | ||
|
Member
There was a problem hiding this comment. Default output should use type hostRow struct {
Name string `sdtab:"NAME"`
IP string `sdtab:"IP"`
}
func printHosts(out io.Writer, hosts []printableHost) error {
t := sdtab.New[hostRow](out)
t.AddHeader()
for _, h := range hosts {
t.AddRow(hostRow{Name: h.Name, IP: h.IP})
}
return t.Flush()
}
Member
Author
There was a problem hiding this comment. My reasoning for the standard output was that this command is different because it is likely to get many many more outputs than another list using sdtab. So, the headers basically are likely to be invisible, off screen in any case -- why force the acrobatics and extra machinery of json or header filtering on consumers? More generally, removing the headers is a basic UX concern regarding standard unix pipelining. But, since it seems this reasoning only subtly justifies deviating from the unusable-in-pipelines UX elsewhere, I'll add the sdtab. |
||
| t := sdtab.New[hostRow](out) | ||
| t.AddHeader() | ||
| for _, h := range hosts { | ||
| t.AddRow(hostRow{Name: h.Name, IP: h.IP}) | ||
| } | ||
| return t.Flush() | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| package local | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "strings" | ||
| "testing" | ||
| ) | ||
|
|
||
| // TestPrintHosts checks the default table has a header row and one aligned | ||
| // NAME/IP row per host, in the order given (already name-sorted by the daemon). | ||
| func TestPrintHosts(t *testing.T) { | ||
| var b bytes.Buffer | ||
| err := printHosts(&b, []printableHost{ | ||
| {Name: "a.myns.svc.cluster.local", IP: "242.242.0.3"}, | ||
| {Name: "b.other.svc.cluster.local", IP: "242.242.0.4"}, | ||
| }) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| lines := strings.Split(strings.TrimRight(b.String(), "\n"), "\n") | ||
| if len(lines) != 3 { | ||
| t.Fatalf("got %d lines, want 3 (header + 2 rows):\n%s", len(lines), b.String()) | ||
| } | ||
| if !strings.Contains(lines[0], "NAME") || !strings.Contains(lines[0], "IP") { | ||
| t.Errorf("header line missing NAME/IP: %q", lines[0]) | ||
| } | ||
| if !strings.HasPrefix(lines[1], "a.myns.svc.cluster.local") || !strings.Contains(lines[1], "242.242.0.3") { | ||
| t.Errorf("row 1 unexpected: %q", lines[1]) | ||
| } | ||
| if !strings.HasPrefix(lines[2], "b.other.svc.cluster.local") || !strings.Contains(lines[2], "242.242.0.4") { | ||
| t.Errorf("row 2 unexpected: %q", lines[2]) | ||
| } | ||
| } | ||
|
|
||
| // TestPrintHostsEmpty: no hosts still emits just the header (and no panic). | ||
| func TestPrintHostsEmpty(t *testing.T) { | ||
| var b bytes.Buffer | ||
| if err := printHosts(&b, nil); err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| if !strings.Contains(b.String(), "NAME") { | ||
| t.Errorf("empty output missing header: %q", b.String()) | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Schema forward-compat: this bakes a single
ipinto the-o json/-o yamloutput, while the proto already carriesrepeated ipsand this PR lays IPv6 dual-stack groundwork. When AAAA support lands, eitheripgets a breaking rename toipsfor script consumers, or it stays and silently under-reports dual-stack hosts. Emitting"ips": [...]from day one avoids the breaking change; the human-readable view can keep showing one address.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will change the proto to be singleton ip. This doesn't affect ipv6/dual-stack forward compatibility and is simpler, following the table below:
the ipMap representation retains
[]ipas it is the backing for the resolver which needs to answer AAAA and A record requests.