From fdd5e010705c332ec9c827ad1708553aac16e049 Mon Sep 17 00:00:00 2001 From: David Nuzik Date: Mon, 11 Nov 2019 14:59:51 -0700 Subject: [PATCH] Adjust quick-start and install pages regarding downtime - This makes changes to the quick-start and install guides that change wording around HA. - Prevoiusly we only suggested HA for ALL production enviornments this is no longer the case. Single-server is okay if some down time is tolerable. - This commit includes a couple of misc tweaks to fix wording in related areas. --- content/k3s/latest/en/installation/_index.md | 10 +++++----- content/k3s/latest/en/installation/ha/_index.md | 4 ++-- .../k3s/latest/en/installation/single-server/_index.md | 4 +--- content/k3s/latest/en/quick-start/_index.md | 3 ++- 4 files changed, 10 insertions(+), 11 deletions(-) diff --git a/content/k3s/latest/en/installation/_index.md b/content/k3s/latest/en/installation/_index.md index ca16b4cd5e8..05f56d45eb5 100644 --- a/content/k3s/latest/en/installation/_index.md +++ b/content/k3s/latest/en/installation/_index.md @@ -3,22 +3,22 @@ title: "Installation Options" weight: 20 --- -This section contains instructions for installing k3s in testing and production environments. Please ensure you have met the [Node Requirements]({{< baseurl >}}/k3s/latest/en/installation/node-requirements/) before you begin installing k3s. +This section contains instructions for installing k3s in various environments. Please ensure you have met the [Node Requirements]({{< baseurl >}}/k3s/latest/en/installation/node-requirements/) before you begin installing k3s. ### Installation Options * [Single Master Installation]({{< baseurl >}}/k3s/latest/en/installation/single-server/) - Install k3s on a single Linux host. Single master installs are recommended for development and test environments, as setup is simple and the cluster doesn't have to be readily available for a user-base. + Install k3s on a single Linux host. Single master installs are recommended for development, test, or production environments where the cluster doesn't have to be readily available for a user-base and some down time is acceptible. * [High Availability (HA) Installation]({{< baseurl >}}/k3s/latest/en/installation/ha/) - Install k3s on two or more Linux hosts. High Availability installs are recommended for production environments. + Install k3s on two or more Linux hosts. High Availability installs are recommended for production environments that cannot tolerate any down time. * [Air-Gap Installation]({{< baseurl >}}/k3s/latest/en/installation/airgap/) - Install k3s in an air-gapped environment. High Availability is recommended for production environments. + Install k3s in an air-gapped environment. High Availability is recommended for production environments that cannot tolerate any down time. ### Uninstalling -If you installed k3s with the help of the `install.sh` script an uninstall script is generated during installation, which will be created on your node at `/usr/local/bin/k3s-uninstall.sh` (or as `k3s-agent-uninstall.sh`). \ No newline at end of file +If you installed k3s with the help of the `install.sh` script an uninstall script is generated during installation, which will be created on your node at `/usr/local/bin/k3s-uninstall.sh` (or as `k3s-agent-uninstall.sh`). diff --git a/content/k3s/latest/en/installation/ha/_index.md b/content/k3s/latest/en/installation/ha/_index.md index 9f08e206638..d2af22d05c8 100644 --- a/content/k3s/latest/en/installation/ha/_index.md +++ b/content/k3s/latest/en/installation/ha/_index.md @@ -6,7 +6,7 @@ weight: 30 >**Important:** High-Availability (HA) was introduced in the v0.10.0 release of k3s and is _experimental_. Our v1.0 release plans to support HA in production environments. HA should currently only be used for testing purposes in non-production environments. >**Note:** k3s does not utilize etcd by default so only a 2-node cluster is needed for HA at a minimum. The following will guide you through setting up a 2-node cluster with PostgreSQL. You could optionally add one or more nodes for additional redundancy. In the future we plan to add support for additional database providers. -For production environments, we recommend installing k3s in a high-availability configuration so that you can always access your cluster. This procedure walks you through setting up a 2-node cluster with k3s with an external PostgreSQL database. As of v0.10.0 release (Experimental HA) we are supporting PostgreSQL 10.7-R1 thru 11.5-R1 +For production environments that cannot tolerate down time, we recommend installing k3s in a high-availability configuration so that you can always access your cluster. This procedure walks you through setting up a 2-node cluster with k3s with an external PostgreSQL database. As of v0.10.0 release (Experimental HA) we are supporting PostgreSQL 10.7-R1 thru 11.5-R1 # Recommended Architecture ![k3s HA]({{< baseurl >}}/img/k3s/k3s-production-setup-v4.svg) @@ -24,7 +24,7 @@ Installation Outline 3. Join worker nodes ### Create Database for Cluster Datastore -The first step for setting up High Availability (HA) is to create the database for the backend. As of v0.10.0 release (Experimental HA) we are currently supporting PostgreSQL 10.7-R1 thru 11.5-R1. +The first step for setting up High Availability (HA) is to create the database for the backend (cluster datastore). As of v0.10.0 release (Experimental HA) we are currently supporting PostgreSQL 10.7-R1 thru 11.5-R1. ### Create Master Nodes Following the [Node Requirements]({{< baseurl >}}/k3s/latest/en/installation/node-requirements/) page, provision at least two machines. diff --git a/content/k3s/latest/en/installation/single-server/_index.md b/content/k3s/latest/en/installation/single-server/_index.md index 6bd6dd1ca4f..49ebd772060 100644 --- a/content/k3s/latest/en/installation/single-server/_index.md +++ b/content/k3s/latest/en/installation/single-server/_index.md @@ -3,9 +3,7 @@ title: "Single Master Install" weight: 20 --- ->**Note:** This section contains information on flags and environment variables used for starting a single-master -(non-HA) k3s cluster. A High-Availability (HA) k3s cluster is required for production. A single server install is -intended only for development and testing environments. +>**Note:** This section contains information on flags and environment variables used for starting a single-master (non-HA) k3s cluster. A High-Availability (HA) k3s cluster is recommended for production environments that cannot tolerate down time. Installation ------------ diff --git a/content/k3s/latest/en/quick-start/_index.md b/content/k3s/latest/en/quick-start/_index.md index dba7ccd0253..43af73ff5ed 100644 --- a/content/k3s/latest/en/quick-start/_index.md +++ b/content/k3s/latest/en/quick-start/_index.md @@ -3,7 +3,8 @@ title: "Quick-Start Guide" weight: 10 --- ->**Note:** The intent of this guide is to quickly launch a cluster that you can use to evaluate k3s. This guide is not intended for production environments. Production environments should utilize a High-Availiability solution. The [installation options](../installation) section covers in greater detail how k3s can be setup. +>**Note:** The intent of this guide is to quickly luanch a cluster with default options. It is suitable for production environments if you can accept some downtime in production (e.g. on the Edge). A High-Availiability solution should be utilized if down time is not acceptible. +The [installation options](../installation) section covers in greater detail how k3s can be setup. > New to Kubernetes? The official Kubernetes docs already have some great tutorials outlining the basics [here](https://kubernetes.io/docs/tutorials/kubernetes-basics/).