k3s/docs/getting-started-guides

PLEASE NOTE: This document applies to the HEAD of the source tree only. If you are using a released version of Kubernetes, you almost certainly want the docs that go with that version.

Documentation for specific releases can be found at releases.k8s.io.

If you are not sure what OSes and infrastructure is supported, the table below lists all the combinations which have been tested recently.

For the easiest "kick the tires" experience, please try the local docker guide.

If you are considering contributing a new guide, please read the guidelines.

IaaS Provider	Config. Mgmt	OS	Networking	Docs	Conforms	Support Level
GKE			GCE	docs		Commercial
Vagrant	Saltstack	Fedora	OVS	docs		Project
GCE	Saltstack	Debian	GCE	docs	✓	Project
Azure	CoreOS	CoreOS	Weave	docs		Community (@errordeveloper, @squillace, @chanezon, @crossorigin)
Docker Single Node	custom	N/A	local	docs		Project (@brendandburns)
Docker Multi Node	Flannel	N/A	local	docs		Project (@brendandburns)
Bare-metal	Ansible	Fedora	flannel	docs		Project
Bare-metal	custom	Fedora	none	docs		Project
Bare-metal	custom	Fedora	flannel	docs		Community (@aveshagarwal)
libvirt	custom	Fedora	flannel	docs		Community (@aveshagarwal)
KVM	custom	Fedora	flannel	docs		Community (@aveshagarwal)
Mesos/GCE				docs		Community (@jdef)
AWS	CoreOS	CoreOS	flannel	docs		Community
GCE	CoreOS	CoreOS	flannel	docs		Community @pires
Vagrant	CoreOS	CoreOS	flannel	docs		Community ( @pires, @AntonioMeireles )
Bare-metal (Offline)	CoreOS	CoreOS	flannel	docs		Community(@jeffbean)
CloudStack	Ansible	CoreOS	flannel	docs		Community (@runseb)
Vmware		Debian	OVS	docs		Community (@pietern)
Bare-metal	custom	CentOS	none	docs		Community(@coolsvap)
AWS	Juju	Ubuntu	flannel	docs		Community ( @whit, @matt, @chuck )
OpenStack/HPCloud	Juju	Ubuntu	flannel	docs		Community ( @whit, @matt, @chuck )
Joyent	Juju	Ubuntu	flannel	docs		Community ( @whit, @matt, @chuck )
AWS	Saltstack	Ubuntu	OVS	docs		Community (@justinsb)
Vmware	CoreOS	CoreOS	flannel	docs		Community (@kelseyhightower)
Azure	Saltstack	Ubuntu	OpenVPN	docs		Community
Bare-metal	custom	Ubuntu	flannel	docs		Community (@resouer @WIZARD-CXY)
Local			none	docs		Community (@preillyme)
libvirt/KVM	CoreOS	CoreOS	libvirt/KVM	docs		Community (@lhuard1A)
oVirt				docs		Community (@simon3z)
Rackspace	CoreOS	CoreOS	flannel	docs		Community (@doublerr)

Don't see anything above that meets your needs? See our Getting Started from Scratch guide.

Note: The above table is ordered by version test/used in notes followed by support level.

Definition of columns:

• IaaS Provider is who/what provides the virtual or physical machines (nodes) that Kubernetes runs on.
• OS is the base operating system of the nodes.
• Config. Mgmt is the configuration management system that helps install and maintain kubernetes software on the nodes.
• Networking is what implements the networking model. Those with networking type none may not support more than one node, or may support multiple VM nodes only in the same physical node.
• Conformance indicates whether a cluster created with this configuration has passed the project's conformance tests for supporting the API and base features of Kubernetes v1.0.0.
• Support Levels
  • Project: Kubernetes Committers regularly use this configuration, so it usually works with the latest release of Kubernetes.
  • Commercial: A commercial offering with its own support arrangements.
  • Community: Actively supported by community contributions. May not work with more recent releases of kubernetes.
  • Inactive: No active maintainer. Not recommended for first-time K8s users, and may be deleted soon.
• Notes is relevant information such as version k8s used.