K3S

Disable ? Need Help?  Get free intro and advanced online training ×

Architecture

Components Flags
Quick-Start Guide

Installation When starting K3s server with –cluster-init it will run all control plane components that includes (api
server, controller manager, scheduler, and etcd). However you can run server nodes with certain
Installation Requirements components and execlude others, the following sectiohs will explain how to do that.

Installation Options

Network Options

High Availability with an External DB ETCD Only Nodes

High Availability with Embedded DB
Cluster Datastore Options
Private Registry Con guration
Air-Gap Install
This document assumes you run K3s server with embedded etcd by passing --cluster-init
ag to the server process.
To run a K3s server with only etcd components you can pass --disable-api-server --
disable-controller-manager --disable-scheduler ags to k3s, this will result in running
a server node with only etcd, for example to run K3s server with those ags:

Create PDF in your applications with the Pdfcrowd HTML to PDF API PDFCROWD
 Disable Components Flags
curl -fL https://get.k3s.io | sh -s - server --cluster-init --disa
Kubernetes Dashboard

Uninstalling K3s

You can join other nodes to the cluster normally after that.
Cluster Access

Upgrades

Backup and Restore

Disable ETCD
You can also disable etcd from a server node and this will result in a k3s server running control

Volumes and Storage components other than etcd, that can be accomplished by running k3s server with ag --disable-
etcd for example to join another node with only control components to the etcd node created in the
previous section:
Networking

Helm curl -fL https://get.k3s.io | sh -s - server --token <token> --disa

Advanced Options and Con guration

The end result will be a two nodes one of them is etcd only node and the other one is controlplane
FAQ only node, if you check the node list you should see something like the following:

Known Issues
kubectl get nodes
NAME STATUS ROLES AGE VER
Security ip-172-31-13-32 Ready etcd 5h39m v1.2
ip-172-31-14-69 Ready control-plane,master 5h39m v1.2

Create PDF in your applications with the Pdfcrowd HTML to PDF API PDFCROWD
 Note that you can run kubectl commands only on the k3s server that has the api running, and you
cant run kubectl commands on etcd only nodes.

Re-enabling control components

In both cases you can re-enable any component that you already disabled simply by removing the
corresponding ag that disables them, so for example if you want to revert the etcd only node back to
a full k3s server with all components you can just remove the following 3 ags --disable-api-
server --disable-controller-manager --disable-scheduler , so in our example to
revert back node ip-172-31-13-32 to a full k3s server you can just re-run the curl command
without the disable ags:

curl -fL https://get.k3s.io | sh -s - server --cluster-init

you will notice that all components started again and you can run kubectl commands again:

kubectl get nodes

NAME STATUS ROLES AGE VER
ip-172-31-13-32 Ready control-plane,etcd,master 5h45m v1.2
ip-172-31-14-69 Ready control-plane,master 5h45m v1.2

Create PDF in your applications with the Pdfcrowd HTML to PDF API PDFCROWD
 Notice that role labels has been re-added to the node ip-172-31-13-32 with the correct labels
(control-plane,etcd,master).

Add disable flags using the config

file
In any of the previous situation you can use the con g le instead of running the curl commands with
the associated ags, for example to run an etcd only node you can add the following options to the
/etc/rancher/k3s/config.yaml le:

---
disable-api-server: true
disable-controller-manager: true
disable-scheduler: true
cluster-init: true

and then start K3s using the curl command without any arguents:

curl -fL https://get.k3s.io | sh -

Create PDF in your applications with the Pdfcrowd HTML to PDF API PDFCROWD
 EDIT THIS PAGE

GET THE LATEST NEWS PRODUCTS COMMUNITY RESOURCES COMPANY

Rancher Events Rancher 2.x Docs About Us

email address
RKE Online Meetups Rancher 1.6 Docs Customers

k3s Training RKE Docs Partners

Read Privacy Policy.
Get Support Tutorials k3s Docs Careers

Pricing Kubernetes Master RancherOS Docs Blog

Classes
Request a Demo eBooks and White Press
Get Certi ed! Papers
CONNECT WITH US Contact Us
Rancher Writing Videos and Podcasts
Program China Site
Getting Started Guide
Forums Japan Site
Why Kubernetes
Slack
GitHub

Create PDF in your applications with the Pdfcrowd HTML to PDF API PDFCROWD
 © Copyright 2021 Rancher. All Rights Reserved. Privacy Policy Agreements Terms of Service

Create PDF in your applications with the Pdfcrowd HTML to PDF API PDFCROWD