Skip to content

Commit 8eac9f3

Browse files
Orzeliusfrezbo
authored andcommitted
docs: add omni join token example to create qemu command
this will hopefully reduce confusion on what the flag value should look like Signed-off-by: Orzelius <33936483+Orzelius@users.noreply.github.com> (cherry picked from commit fc8ae32)
1 parent e79a94d commit 8eac9f3

File tree

2 files changed

+4
-3
lines changed
  • cmd/talosctl/cmd/mgmt/cluster/create
  • website/content/v1.12/reference

2 files changed

+4
-3
lines changed

cmd/talosctl/cmd/mgmt/cluster/create/cmd.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,8 @@ func addDisksFlag(flagset *pflag.FlagSet, bind *flags.Disks) {
139139
}
140140

141141
func addOmniJoinTokenFlag(cmd *cobra.Command, bindAPIEndpoint *string, cfgPatchAllFlagName, cfgPatchWorkersFlagName, cfgPatchCPsFlagName string) {
142-
cmd.Flags().StringVar(bindAPIEndpoint, omniAPIEndpointFlagName, *bindAPIEndpoint, "the Omni API endpoint (must include a scheme, a port and a join token)")
142+
cmd.Flags().StringVar(bindAPIEndpoint, omniAPIEndpointFlagName, *bindAPIEndpoint,
143+
"the Omni API endpoint (must include a scheme, a hostname and a join token, e.g. 'https://siderolink.omni.example?jointoken=foobar')")
143144

144145
cmd.MarkFlagsMutuallyExclusive(omniAPIEndpointFlagName, cfgPatchAllFlagName)
145146
cmd.MarkFlagsMutuallyExclusive(omniAPIEndpointFlagName, cfgPatchWorkersFlagName)

website/content/v1.12/reference/cli.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ talosctl cluster create dev [flags]
181181
--mtu int MTU of the cluster network (default 1500)
182182
--nameservers strings list of nameservers to use, by default use embedded DNS forwarder
183183
--no-masquerade-cidrs strings list of CIDRs to exclude from NAT
184-
--omni-api-endpoint string the Omni API endpoint (must include a scheme, a port and a join token)
184+
--omni-api-endpoint string the Omni API endpoint (must include a scheme, a hostname and a join token, e.g. 'https://siderolink.omni.example?jointoken=foobar')
185185
--registry-insecure-skip-verify strings list of registry hostnames to skip TLS verification for
186186
--registry-mirror strings list of registry mirrors to use in format: <registry host>=<mirror URL>
187187
--skip-injecting-config skip injecting config from embedded metadata server, write config files to current directory
@@ -306,7 +306,7 @@ talosctl cluster create qemu [flags]
306306
--kubernetes-version string desired kubernetes version to run (default "1.35.0-rc.0")
307307
--memory-controlplanes string(mb,gb) the limit on memory usage for each control plane/VM (default 2.0GiB)
308308
--memory-workers string(mb,gb) the limit on memory usage for each worker/VM (default 2.0GiB)
309-
--omni-api-endpoint string the Omni API endpoint (must include a scheme, a port and a join token)
309+
--omni-api-endpoint string the Omni API endpoint (must include a scheme, a hostname and a join token, e.g. 'https://siderolink.omni.example?jointoken=foobar')
310310
--presets strings list of presets to apply (default [iso])
311311
--schematic-id string image factory schematic id (defaults to an empty schematic)
312312
--talos-version string the desired talos version (default "latest")

0 commit comments

Comments
 (0)