English / 简体中文

K3s is a fully certified Kubernetes offering, it can replace the "full-fat" K8s in some cases.

AutoK3s is a lightweight tool for simplifying the cluster management of K3s, it can help you Run K3s Everywhere.

• LongFeatures
• Key Features
• Providers
• Quick Start (tl;dr)
• Demo Video
• Developers' Guide
• Source Code
• License

这是 longalong 根据自己的需要修改过的一个版本，主要增加了以下特性:

• 增加 api 的 auth 能力，由环境变量控制。

  • AUTOK3S_AUTH_TOGGLE 控制是否关闭 auth 能力，默认为开启
  • AUTH_username=passwd 的方式注册访问用户，但需要注意，为了一定程度上保证安全性，password 是经过处理后的

• 增加控制 providers 是否开放的能力，由环境变量控制。

  • AUTOK3S_PROVIDERS=native,alibaba,aws,google,k3d,tencent 如这种格式
  • 默认为开放所有 providers

• 增加 proxy 设置，在下载 airgap 包时可使用代理下载，由环境变量控制。

  • 采用 AUTOK3S_PROXY=domain:proxy,domain:proxy 格式
  • 例如 AUTOK3S_PROXY=github.com:socks5://127.0.0.1:1080,xxx.xx.com:http://127.0.0.1:1087

• 增加环境变量设置 instance name 格式 (有些云厂商的监控可以指定前缀匹配)

  • eg: AUTOK3S_MASTER_INSTANCE_NAME="%s.k3s.master" AUTOK3S_WORKER_INSTANCE_NAME="%s.k3s.worker"

修复了如下问题:

• fix cluster 无 PublicIPAddress 时访问越界崩溃问题，使用 InternalIPAddress 替代

• Shorter provisioning time with API, CLI and UI dashboard.
• Cloud provider Integration(simplifies the setup process of CCM on cloud providers).
• Flexible installation options, like K3s cluster HA and datastore(embedded etcd, RDS, SQLite, etc.).
• Low cost(try spot instances in each cloud).
• Simplify operations by UI dashboard.
• Portability between clouds by leveraging tools like backup-restore-operator.
• Airgap K3s package management and installation.
• SSH Key Management can manage the SSH keys are used to provision K3s clusters.

Now supports the following providers, we encourage submitting PR contribution for more providers:

• aws - Bootstrap K3s onto Amazon EC2
• google - Bootstrap K3s onto Google Compute Engine
• alibaba - Bootstrap K3s onto Alibaba ECS
• tencent - Bootstrap K3s onto Tencent CVM
• k3d - Bootstrap K3d onto Local Machine
• native - Bootstrap K3s onto any VM

Scenario 1 - Run with docker:

# The commands will start autok3s daemon with an interactionable UI.
# Standard Linux (Recommended)
$ docker run -itd --restart=unless-stopped --net=host -v /var/run/docker.sock:/var/run/docker.sock cnrancher/autok3s:v0.8.0

# MacOS
$ docker run -itd --restart=unless-stopped -p 8080:8080 -v /var/run/docker.sock:/var/run/docker.sock -e DOCKER_HOST="" cnrancher/autok3s:v0.8.0

Scenario 2 - Run with docker-compose

# AutoK3s is available at: http://autok3s.vcap.me (vcap.me resolves to 127.0.0.1).
# The cli and container uses the same `AUTOK3S_CONFIG` directory.
docker-compose up -d

Scenario 3 - Run with cli:

# The commands use the shell script on MacOS and Linux, or visit the Releases page to download the executable for Windows.
curl -sS https://rancher-mirror.rancher.cn/autok3s/install.sh  | sh

# The commands will start autok3s daemon and popup default browser with an interactionable UI.
autok3s -d serve

For v0.5.0 or newer version

To uninstall autok3s cli, please execute command below:

/usr/local/bin/autok3s-uninstall.sh

In the demo, we install K3s by k3d provider in around 1 minute, and we can manage K3s clusters by kube-explorer dashboard.

Watch the demo:

Use dapper to manage project compilation, testing and packaging.

• compilation: make autok3s build
• testing: make autok3s unit
• packing: make autok3s package only

Install dapper please follow the dapper project.

AutoK3s is 100% open-source software. The project source code is spread across a number of repos:

• https://github.com/cnrancher/autok3s
• https://github.com/cnrancher/autok3s-ui
• https://github.com/cnrancher/kube-explorer

Copyright (c) 2023 Rancher Labs, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.