Condense updates and upgrades

justinsb · Sep 20, 2019 · f21e0d9 · f21e0d9
1 parent f3d7e15
commit f21e0d9
Show file tree

Hide file tree

Showing 10 changed files with 85 additions and 141 deletions.
diff --git a/docs/development/documentation.md b/docs/development/documentation.md
@@ -19,3 +19,8 @@ It does not update the cloud resources, to apply the changes use "kops update cl
 
 * `Example`: Example(s) of how to use the command. This field is formatted as a code snippet in the docs, so make sure if you have comments that these are written as a bash comment (e.g. `# this is a comment`).
 
+## Mkdocs
+
+`make live-docs` runs a docker container to live build and view docs when working on them locally
+
+`make build-docs` will build a final version of docs which will be checked in via automation.
diff --git a/docs/etcd/backup-restore.md b/docs/etcd/backup-restore.md
diff --git a/docs/usage/arguments.md → docs/getting_started/arguments.md b/docs/usage/arguments.md → docs/getting_started/arguments.md
diff --git a/docs/getting_started/aws.md b/docs/getting_started/aws.md
@@ -411,7 +411,7 @@ kops delete cluster --name ${NAME} --yes
 
 We've barely scratched the surface of the capabilities of `kops` in this guide,
 and we recommend researching [other interesting
-modes](../usage/commands.md#other-interesting-modes) to learn more about generating
+modes](commands.md#other-interesting-modes) to learn more about generating
 Terraform configurations, or running your cluster in an HA (Highly Available)
 mode.
 

diff --git a/docs/usage/commands.md → docs/getting_started/commands.md b/docs/usage/commands.md → docs/getting_started/commands.md
diff --git a/docs/kubectl.md → docs/getting_started/kubectl.md b/docs/kubectl.md → docs/getting_started/kubectl.md
diff --git a/docs/operations/cluster_upgrades_and_migrations.md b/docs/operations/cluster_upgrades_and_migrations.md
@@ -5,7 +5,7 @@ At some point you will almost definitely want to upgrade the Kubernetes version
 - Upgrade an existing `kube-up` managed cluster to one managed by `kops`
     + [The simple method with downtime](#kube-up---kops-downtime)
     + [The more complex method with zero-downtime](#kube-up---kops-sans-downtime)
-- [Upgrade a `kops` cluster from one Kubernetes version to another](../upgrade.md)
+- [Upgrade a `kops` cluster from one Kubernetes version to another](cluster_upgrades_and_migrations.md)
 
 ## `kube-up` -> `kops`, with downtime
 

diff --git a/docs/upgrade.md → docs/operations/updates_and_upgrades.md b/docs/upgrade.md → docs/operations/updates_and_upgrades.md
@@ -1,3 +1,39 @@
+# Updates and Upgrades
+
+## Updating kops
+
+### MacOS
+
+From Homebrew:
+
+```bash
+brew update && brew upgrade kops
+```
+
+From Github:
+
+```bash
+rm -rf /usr/local/bin/kops
+wget -O kops https://github.com/kubernetes/kops/releases/download/$(curl -s https://api.github.com/repos/kubernetes/kops/releases/latest | grep tag_name | cut -d '"' -f 4)/kops-darwin-amd64
+chmod +x ./kops
+sudo mv ./kops /usr/local/bin/
+```
+
+You can also rerun [these steps](../development/building.md) if previously built from source.
+
+### Linux
+
+From Github:
+
+```bash
+rm -rf /usr/local/bin/kops
+wget -O kops https://github.com/kubernetes/kops/releases/download/$(curl -s https://api.github.com/repos/kubernetes/kops/releases/latest | grep tag_name | cut -d '"' -f 4)/kops-linux-amd64
+chmod +x ./kops
+sudo mv ./kops /usr/local/bin/
+```
+
+You can also rerun [these steps](../development/building.md) if previously built from source.
+
 ## Upgrading Kubernetes
 
 Upgrading Kubernetes is easy with kops. The cluster spec contains a `kubernetesVersion`, so you can simply edit it with `kops edit`, and apply the updated configuration to your cluster.
@@ -6,7 +42,7 @@ The `kops upgrade` command also automates checking for and applying updates.
 
 It is recommended to run the latest version of Kops to ensure compatibility with the target kubernetesVersion. When applying a Kubernetes minor version upgrade (e.g. `v1.5.3` to `v1.6.0`), you should confirm that the target kubernetesVersion is compatible with the [current Kops release](https://github.com/kubernetes/kops/releases).
 
-Note: if you want to upgrade from a `kube-up` installation, please see the instructions for [how to upgrade kubernetes installed with kube-up](operations/cluster_upgrades_and_migrations.md).
+Note: if you want to upgrade from a `kube-up` installation, please see the instructions for [how to upgrade kubernetes installed with kube-up](cluster_upgrades_and_migrations.md).
 
 ### Manual update
 
@@ -40,4 +76,3 @@ Upgrade uses the latest Kubernetes version considered stable by kops, defined in
 
 ### Other Notes:
 * In general, we recommend that you upgrade your cluster one minor release at a time (1.7 --> 1.8 --> 1.9).  Although jumping minor versions may work if you have not enabled alpha features, you run a greater risk of running into problems due to version deprecation.
-
diff --git a/docs/update_kops.md b/docs/update_kops.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -38,7 +38,9 @@ nav:
     - Deploying to GCE: "getting_started/gce.md"
     - Deploying to OpenStack - Beta: "getting_started/openstack.md"
     - Deploying to Digital Ocean - Alpha: "getting_started/digitalocean.md"
-    - kubectl usage: "kubectl.md"
+    - Kops Commands: "getting_started/commands.md"
+    - Kops Arguments: "getting_started/arguments.md"
+    - kubectl usage: "getting_started/kubectl.md"
   - CLI:
     - kops: "cli/kops.md"
     - kops completion: "cli/kops_completion.md"
@@ -64,10 +66,8 @@ nav:
     - Godocs for Cluster - ClusterSpec: "https://godoc.org/k8s.io/kops/pkg/apis/kops#ClusterSpec"
     - Godocs for Instance Group - InstanceGroupSpec: "https://godoc.org/k8s.io/kops/pkg/apis/kops#InstanceGroupSpec"
 
-  - Usage:
-    - Commands: "usage/commands.md"
-    - Arguments: "usage/arguments.md"
   - Operations:
+    - Updates & Upgrades: "operations/updates_and_upgrades.md"
     - High Availability: "operations/high_availability.md"
     - etcd backup, restore and encryption: "operations/etcd_backup_restore_encryption.md"
     - Instancegroup images: "operations/images.md"
@@ -76,16 +76,11 @@ nav:
     - Cluster Templating: "operations/cluster_template.md"
     - Cluster upgrades and migrations: "operations/cluster_upgrades_and_migrations.md"
     - GPU setup: "gpu.md"
-    - k8s upgrading: "upgrade.md"
-    - kops updating: "update_kops.md"
     - kube-up to kops upgrade: "upgrade_from_kubeup.md"
     - Label management: "labels.md"
     - Secret management: "secrets.md"
     - Moving from a Single Master to Multiple HA Masters: "single-to-multi-master.md"
-    - Upgrading Kubernetes: "tutorial/upgrading-kubernetes.md"
     - Working with Instance Groups: "tutorial/working-with-instancegroups.md"
-    - Developers guide for vSphere support: "vsphere-dev.md"
-    - vSphere support status: "vsphere-development-status.md"
     - Running kops in a CI environment: "continuous_integration.md"
   - Networking:
     - Networking Overview including CNI: "networking.md"
@@ -94,19 +89,36 @@ nav:
     - Subdomain setup: "creating_subdomain.md"
   - Security:
     - Security: "security.md"
+    - Advisories: "advisories/README.md"
     - Bastion setup: "bastion.md"
     - IAM roles: "iam_roles.md"
     - MFA setup: "mfa.md"
+    - Security Groups: "security_groups.md"
   - Advanced:
     - Download Config: "advanced/download_config.md"
     - Subdomain NS Records: "advanced/ns.md"
     - Experimental: "advanced/experimental.md"
     - Cluster boot sequence: "boot-sequence.md"
     - Philosophy: "philosophy.md"
     - State store: "state.md"
+    - AWS China: "aws-china.md"
+    - Calico v3: "calico-v3.md"
+    - Custom CA: "custom_ca.md"
+    - etcd3 Migration: "etcd3-migration.md"
+    - Horizontal Pod Autoscaling: "horizontal_pod_autoscaling.md"
+    - Egress Proxy: "http_proxy.md"
+    - Node Authorization: "node_authorization.md"
+    - Node Resource Allocation: "node_resource_handling.md"
+    - Rotate Secrets: "rotate-secrets.md"
+    - Terraform: "terraform.md"
+    - Authentication: "authentication.md"
   - Development:
+    - Building: "development/building.md"
+    - Releases: "releases.md"
+    - New Kubernetes Version: "development/new_kubernetes_version.md"
     - Developing using Docker: "development/Docker.md"
     - Development with vSphere: "vsphere-dev.md"
+    - vSphere support status: "vsphere-development-status.md"
     - Documentation Guidelines: "development/documentation.md"
     - E2E testing with `kops` clusters: "development/testing.md"
     - Example on how to add a feature: "development/adding_a_feature.md"
@@ -118,3 +130,23 @@ nav:
     - Our release process: "development/release.md"
     - Releasing with Homebrew: "development/homebrew.md"
     - Rolling Update Diagrams: "development/rolling_update.md"
+    - Bazel: "development/bazel.md"
+    - Vendoring: "development/vendoring.md"
+    - Ports: "development/ports.md"
+  - Releases:
+    - 1.15: releases/1.15-NOTES.md
+    - 1.14: releases/1.14-NOTES.md
+    - 1.13: releases/1.13-NOTES.md
+    - 1.12: releases/1.12-NOTES.md
+    - 1.11: releases/1.11-NOTES.md
+    - 1.10: releases/1.10-NOTES.md
+    - 1.9: releases/1.9-NOTES.md
+    - 1.8.1: releases/1.8.1.md
+    - 1.8: releases/1.8-NOTES.md
+    - 1.7.1: releases/1.7.1.md
+    - 1.7: releases/1.7-NOTES.md
+    - 1.6.2: releases/1.6.2.md
+    - 1.6.1: releases/1.6.1.md
+    - 1.6.0: releases/1.6-NOTES.md
+    - 1.6.0-alpha: releases/1.6.0-alpha.1.md
+    - legacy-changes.md: releases/legacy-changes.md