Manage kubernetes in the most light and convenient way.
Manage kubernetes in the most light and convenient way
What is KubeClipper
English | 中文
KubeClipper is a lightweight web service that provides a friendly web console GUI, APIs, and a CLI tool for Kubernetes cluster lifecycle management.
KubeClipper provides flexible Kubernetes as a Service (KaaS), which allows users to rapidly deploy K8S clusters
anywhere(cloud, hypervisor, bare metal) and provides continuous lifecycle management capabilities
(installation, deleting, upgrading, backup and restoration, cluster scaling, remote access, plug-in management,
application store).see Feature List for details.
🎯 Project Goal:Manage Kubernetes in the most light and convenient way.
Features
☸️ Cluster Lifecycle Management Supports deployment of Kubernetes on any infrastructure and provides comprehensive cluster lifecycle management.
🌐 Node Management
🚪 Identity and Access Management (IAM) Provides a unified authentication and authorization system with fine-grained role-based access control.
Roadmap & Todo list
Node
Network
Explore the architecture of Kubeclipper on kubeclipper.io.
Quick Start
For users who are new to KubeClipper and want to get started quickly, it is recommended to use the All-in-One installation mode, which can help you quickly deploy KubeClipper with zero configuration.
Preparations
KubeClipper itself does not take up too many resources, but in order to run Kubernetes better in the future, it is recommended that the hardware configuration should not be lower than the minimum requirements.
You only need to prepare a host with reference to the following requirements for machine hardware and operating system.
Hardware recommended configuration
Node requirements
Nodes must be able to connect via SSH
.
You can use the sudo
/ curl
/ wget
/ tar
command on this node.
It is recommended that your operating system is in a clean state (no additional software is installed), otherwise, conflicts may occur.
Deploy KubeClipper Download kcctl
KubeClipper provides command line tools 🔧 kcctl to simplify operations.
You can download the latest version of kcctl directly with the following command:
# Install latest release curl -sfL https://oss.kubeclipper.io/get-kubeclipper.sh | bash -In China, you can add env "KC_REGION=cn", we use registry.aliyuncs.com/google_containers instead of k8s.gcr.io
curl -sfL https://oss.kubeclipper.io/get-kubeclipper.sh | KC_REGION=cn bash -
The latest release version is downloaded by default. You can download the specified version. For example, specify the master development version to be installed
curl -sfL https://oss.kubeclipper.io/get-kubeclipper.sh | KC_REGION=cn KC_VERSION=master bash -
It is highly recommended that you install the latest release to experience more features.
You can also download the specified version on the GitHub Release Page.
Check if the installation is successful with the following command:
kcctl versionGet Started with Installation
In this quick start tutorial, you only need to run just one command for installation:
If you want to install AIO mode
# install default release kcctl deployyou can use KC_VERSION to install the specified version, default is latest release
KC_VERSION=master kcctl deploy
If you want to install multi node, Use kcctl deploy -h
for more information about a command
After you runn this command, kcctl will check your installation environment and enter the installation process, if the conditions are met.
After printing the KubeClipper banner, the installation is complete.
_ __ _ _____ _ _ | | / / | | / __ \ () | |/ / _ _| |_ | / \/ | _ __ _ __ ___ _ __ | | | | | '_ \ / _ \ | | | | '_ | '_ \ / _ \ '| | |\ \ || | |) | / _/\ | | |) | |) | _/ | _| _/_,|_./ _|_/|| ./| ./ _|| | | | | || ||Login Console
When deployed successfully, you can open a browser and visit http://$IP
to enter the KubeClipper console.
You can log in with the default account and password admin / Thinkbig1
.
You may need to configure port forwarding rules and open ports in security groups for external users to access the console.
Create a k8s cluster
When kubeclipper
is deployed successfully, you can use the kcctl tool or console to create a k8s cluster. In the quick start tutorial, we use the kcctl tool to create.
Then create a k8s cluster with the following command:
NODE=$(kcctl get node -o yaml|grep ipv4DefaultIP:|sed 's/ipv4DefaultIP: //')kcctl create cluster --master $NODE --name demo --untaint-master
The cluster creation will be completed in about 3 minutes, or you can use the following command to view the cluster status:
kcctl get cluster -o yaml|grep status -A5
You can also enter the console to view real-time logs.
Once the cluster enter the Running
state , it means that the creation is complete. You can use kubectl get cs
command to view the cluster status.
Development and Debugging
export HostIP="Your-IP" docker run -d \ --net host \ k8s.gcr.io/etcd:3.5.0-0 etcd \ --advertise-client-urls http://${HostIP}:2379 \ --initial-advertise-peer-urls http://${HostIP}:2380 \ --initial-cluster=infra0=http://${HostIP}:2380 \ --listen-client-urls http://${HostIP}:2379,http://127.0.0.1:2379 \ --listen-metrics-urls http://127.0.0.1:2381 \ --listen-peer-urls http://${HostIP}:2380 \ --name infra0 \ --snapshot-count=10000 \ --data-dir=/var/lib/etcd
kubeclipper-server.yaml
etcd.serverList to your locally etcd clustermake build
./dist/kubeclipper-server serve
Contributing
Please follow Community to join us.
Star History
Twice a month we will interview people behind open source businesses. We will talk about how they are building a business on top of open source projects.
We'll never share your email with anyone else.