feat: Upgrade kubernetes to 1.17.0

Primarily doc/constant changes. Added additionnal bits to `docs` target in makefile to generate osctl docs as well as config files. Explicitly define a HOME variable so we get consistent home directories for talosconfig variables in our docs. Signed-off-by: Brad Beam <brad.beam@talos-systems.com>
2025-11-25 18:35:12 +00:00 · 2019-12-10 17:44:07 +00:00
parent 5fb12f735a
commit 9584b47cd7
54 changed files with 106 additions and 78 deletions
--- a/docs/osctl/osctl.md
+++ b/docs/osctl/osctl.md
@@ -14,7 +14,7 @@ A CLI for out-of-band management of Kubernetes nodes created by Talos
  -e, --endpoints strings    override default endpoints in Talos configuration
  -h, --help                 help for osctl
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_cluster.md
+++ b/docs/osctl/osctl_cluster.md
@@ -20,7 +20,7 @@ A collection of commands for managing local docker-based clusters
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_cluster_create.md
+++ b/docs/osctl/osctl_cluster_create.md
@@ -16,8 +16,8 @@ osctl cluster create [flags]
 ```
      --cpus string                 the share of CPUs as fraction (each container) (default "1.5")
  -h, --help                        help for create
-      --image string                the image to use (default "docker.io/autonomy/talos:v0.3.0-alpha.10-51-g3a93e65b-dirty")
-      --kubernetes-version string   desired kubernetes version to run (default "1.16.2")
+      --image string                the image to use (default "docker.io/autonomy/talos:v0.3.0-alpha.10-58-g5fb12f73-dirty")
+      --kubernetes-version string   desired kubernetes version to run (default "1.17.0")
      --masters int                 the number of masters to create (default 1)
      --memory int                  the limit on memory usage in MB (each container) (default 1024)
      --mtu string                  MTU of the docker bridge network (default "1500")
@@ -31,7 +31,7 @@ osctl cluster create [flags]
  -e, --endpoints strings    override default endpoints in Talos configuration
      --name string          the name of the cluster (default "talos_default")
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_cluster_destroy.md
+++ b/docs/osctl/osctl_cluster_destroy.md
@@ -24,7 +24,7 @@ osctl cluster destroy [flags]
  -e, --endpoints strings    override default endpoints in Talos configuration
      --name string          the name of the cluster (default "talos_default")
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_config.md
+++ b/docs/osctl/osctl_config.md
@@ -19,7 +19,7 @@ Manage the client configuration
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_config_add.md
+++ b/docs/osctl/osctl_config_add.md
@@ -26,7 +26,7 @@ osctl config add <context> [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_config_context.md
+++ b/docs/osctl/osctl_config_context.md
@@ -23,7 +23,7 @@ osctl config context <context> [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_config_endpoint.md
+++ b/docs/osctl/osctl_config_endpoint.md
@@ -23,7 +23,7 @@ osctl config endpoint <endpoint>... [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_config_generate.md
+++ b/docs/osctl/osctl_config_generate.md
@@ -17,8 +17,8 @@ osctl config generate <cluster name> https://<load balancer IP or DNS name> [fla
      --additional-sans strings     additional Subject-Alt-Names for the APIServer certificate
  -h, --help                        help for generate
      --install-disk string         the disk to install to (default "/dev/sda")
-      --install-image string        the image used to perform an installation (default "docker.io/autonomy/installer:v0.3.0-alpha.10-51-g3a93e65b-dirty")
-      --kubernetes-version string   desired kubernetes version to run (default "1.16.2")
+      --install-image string        the image used to perform an installation (default "docker.io/autonomy/installer:v0.3.0-alpha.10-58-g5fb12f73-dirty")
+      --kubernetes-version string   desired kubernetes version to run (default "1.17.0")
  -o, --output-dir string           destination to output generated files
      --version string              the desired machine config version to generate (default "v1alpha1")
 ```
@@ -29,7 +29,7 @@ osctl config generate <cluster name> https://<load balancer IP or DNS name> [fla
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_containers.md
+++ b/docs/osctl/osctl_containers.md
@@ -25,7 +25,7 @@ osctl containers [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_cp.md
+++ b/docs/osctl/osctl_cp.md
@@ -30,7 +30,7 @@ osctl cp <src-path> -|<local-path> [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_dmesg.md
+++ b/docs/osctl/osctl_dmesg.md
@@ -23,7 +23,7 @@ osctl dmesg [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_docs.md
+++ b/docs/osctl/osctl_docs.md
@@ -23,7 +23,7 @@ osctl docs <output> [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_gen.md
+++ b/docs/osctl/osctl_gen.md
@@ -19,7 +19,7 @@ Generate CAs, certificates, and private keys
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_gen_ca.md
+++ b/docs/osctl/osctl_gen_ca.md
@@ -26,7 +26,7 @@ osctl gen ca [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_gen_crt.md
+++ b/docs/osctl/osctl_gen_crt.md
@@ -27,7 +27,7 @@ osctl gen crt [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_gen_csr.md
+++ b/docs/osctl/osctl_gen_csr.md
@@ -25,7 +25,7 @@ osctl gen csr [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_gen_key.md
+++ b/docs/osctl/osctl_gen_key.md
@@ -24,7 +24,7 @@ osctl gen key [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_gen_keypair.md
+++ b/docs/osctl/osctl_gen_keypair.md
@@ -25,7 +25,7 @@ osctl gen keypair [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_install.md
+++ b/docs/osctl/osctl_install.md
@@ -29,7 +29,7 @@ osctl install [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_interfaces.md
+++ b/docs/osctl/osctl_interfaces.md
@@ -23,7 +23,7 @@ osctl interfaces [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_kubeconfig.md
+++ b/docs/osctl/osctl_kubeconfig.md
@@ -25,7 +25,7 @@ osctl kubeconfig [local-path] [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_logs.md
+++ b/docs/osctl/osctl_logs.md
@@ -26,7 +26,7 @@ osctl logs <id> [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_ls.md
+++ b/docs/osctl/osctl_ls.md
@@ -26,7 +26,7 @@ osctl ls [path] [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_memory.md
+++ b/docs/osctl/osctl_memory.md
@@ -24,7 +24,7 @@ osctl memory [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_mounts.md
+++ b/docs/osctl/osctl_mounts.md
@@ -23,7 +23,7 @@ osctl mounts [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_processes.md
+++ b/docs/osctl/osctl_processes.md
@@ -25,7 +25,7 @@ osctl processes [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_read.md
+++ b/docs/osctl/osctl_read.md
@@ -23,7 +23,7 @@ osctl read <path> [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_reboot.md
+++ b/docs/osctl/osctl_reboot.md
@@ -23,7 +23,7 @@ osctl reboot [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_reset.md
+++ b/docs/osctl/osctl_reset.md
@@ -23,7 +23,7 @@ osctl reset [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_restart.md
+++ b/docs/osctl/osctl_restart.md
@@ -25,7 +25,7 @@ osctl restart [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_routes.md
+++ b/docs/osctl/osctl_routes.md
@@ -23,7 +23,7 @@ osctl routes [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_service.md
+++ b/docs/osctl/osctl_service.md
@@ -25,7 +25,7 @@ osctl service [<id> [start|stop|restart|status]] [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_shutdown.md
+++ b/docs/osctl/osctl_shutdown.md
@@ -23,7 +23,7 @@ osctl shutdown [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_stats.md
+++ b/docs/osctl/osctl_stats.md
@@ -25,7 +25,7 @@ osctl stats [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_time.md
+++ b/docs/osctl/osctl_time.md
@@ -24,7 +24,7 @@ osctl time [--check server] [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_upgrade.md
+++ b/docs/osctl/osctl_upgrade.md
@@ -24,7 +24,7 @@ osctl upgrade [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_validate.md
+++ b/docs/osctl/osctl_validate.md
@@ -25,7 +25,7 @@ osctl validate [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/osctl/osctl_version.md
+++ b/docs/osctl/osctl_version.md
@@ -25,7 +25,7 @@ osctl version [flags]
      --context string       Context to be used in command
  -e, --endpoints strings    override default endpoints in Talos configuration
      --nodes strings        target the specified nodes
-      --talosconfig string   The path to the Talos configuration file (default "/home/smira/.talos/config")
+      --talosconfig string   The path to the Talos configuration file (default "/home/user/.talos/config")
 ```

 ### SEE ALSO
--- a/docs/website/content/v0.3/en/configuration/v1alpha1.md
+++ b/docs/website/content/v0.3/en/configuration/v1alpha1.md
@@ -35,7 +35,7 @@ machine:
    force: false
 cluster:
  controlPlane:
-    version: 1.16.2
+    version: 1.17.0
    endpoint: https://1.2.3.4
  clusterName: example
  network:
@@ -341,7 +341,7 @@ Examples:

 ```yaml
 controlPlane:
-  version: 1.16.2
+  version: 1.17.0
  endpoint: https://1.2.3.4
  localAPIServerPort: 443

@@ -688,7 +688,7 @@ Type: `string`
 Examples:

 ```yaml
-1.16.2
+1.17.0
 ```

 > Note: The version must be of the format `major.minor.patch`, _without_ a leading `v`.