Skip to main content
 

How can we help?

Search

Install and Start K3s

  • Updated

Note

If you're a Standard Stack user, your Acrolinx Platform runs in a single-node Kubernetes cluster. Before you can get Acrolinx up and running, you'll need to install and set up your own Kubernetes cluster via K3s. Familiarize yourself with K3s so you can maintain this installation.

Before you start, make sure that you've:

To install K3s as recommended, do the following:

Tip

Don’t forget to set the correct K3s version. Not sure what this is? It should look something like this: v1.20.7+k3s1. Take a look at the Standard Stack Compatibility Guide to find the most up-to-date version.

  1. Install K3s with the install script available in the K3s official installation guide. To do this, you can copy and paste the install script into your terminal. For example:

    curl -sfL https://get.k3s.io | INSTALL_K3S_VERSION=<k3s version from Standard Software Requirements> K3S_KUBECONFIG_MODE="644" sh -s -

    This will take around 30 seconds.

    Note

    When you use the setting K3S_KUBECONFIG_MODE="644", you prompt the K3s installer to create the file that kubectl uses to access the cluster. It includes read permissions for everyone. This means that everybody with access to the machine can access the cluster. While this is the quickest way to get everything up and running, you might also prefer to restrict access. To learn more, read about cluster access and environment variables in the K3s documentation.

  2. Once the installation finishes, check the K3s service status to make sure it’s running.

    sudo systemctl status k3s

    You should see active (running)in green next to Active. For example:

    k3s.service - Lightweight Kubernetes
   Loaded: loaded (/etc/systemd/system/k3s.service; enabled; vendor preset: disabled)
   Active: active (running) since Fri 2021-03-05 15:46:56 UTC; 8min ago

  3. You’ll also want to make sure that your Kubernetes cluster is ready. To do this, list the available Kubernetes cluster nodes.

    kubectl get nodes

    At this point, you’ll see the <node name> in the NAME column. The STATUS should be Ready and the ROLES should show master.

    // Expected output:
NAME          STATUS   ROLES    AGE     VERSION
<node name>   Ready    master   7h32m   v1.20.7+k3s1

Once you've installed K3s and checked your Kubernetes cluster, you can configure the Acrolinx Operator.

Optional

If you’re not sure which version of K3s you’re using, you can always double check with:

k3s --version

You’ll want to make sure that the version in the output matches the version listed on the Standard Stack Compatibility page. For example:

k3s version v1.22.8+k3s1 (21fed356)