Skip to content

Commit

Permalink
tune: refine README
Browse files Browse the repository at this point in the history
Signed-off-by: Deshi Xiao <[email protected]>
  • Loading branch information
xiaods committed Nov 12, 2022
1 parent bf53a56 commit ba0ee23
Showing 1 changed file with 3 additions and 39 deletions.
42 changes: 3 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
<img src="./docs/k8e-logo.png" alt="logo" style="zoom:30%;" /><br/>
K8e πŸš€ (said 'kuber easy') - Simple Kubernetes Distribution
K8e πŸš€ - Simple Kubernetes Distribution
===============================================
[Kubernetes Easy (k8e)](https://getk8e.com) is a lightweight, Extensible, Enterprise Kubernetes distribution that allows users to uniformly manage, secure, and get out-of-the-box kubernetes cluster for enterprise environments.

The k8e πŸš€ (said 'kuber easy') project builds on upstream project [K3s](https://github.com/rancher/k3s) as codebase, remove Edge/IoT features and extend enterprise features with best practices.
[Kubernetes Easy (k8e)πŸš€](https://getk8e.com) is a lightweight, Extensible, Enterprise Kubernetes distribution that allows users to uniformly manage, secure, and get out-of-the-box kubernetes cluster for enterprise environments.

[![Go Report Card](https://goreportcard.com/badge/github.com/xiaods/k8e)](https://goreportcard.com/report/github.com/xiaods/k8e) [![Hex.pm](https://img.shields.io/hexpm/l/apa)](https://github.com/xiaods/k8e/blob/master/LICENSE)

Expand All @@ -13,43 +11,9 @@ The k8e πŸš€ (said 'kuber easy') project builds on upstream project [K3s](https:
- [x] No dependency on ansible haproxy keepalived, a binary tool, 0 dependency
- [x] natively support cilium network


Quick-Start - Building && Installing
--------------
1. Building `k8e`

The clone will be much faster on this repo if you do
```bash
git clone --depth 1 https://github.com/xiaods/k8e.git
```

This repo includes all of Kubernetes history so `--depth 1` will avoid most of that.

The k8e build process requires some autogenerated code and remote artifacts that are not checked in to version control.
To prepare these resources for your build environment, run:.
```bash
mkdir -p build/data && make download && make generate
```

To build the full release binary, you may now run `make`, which will create `./dist/artifacts/k8e`.

To build the binaries using without running linting (ie; if you have uncommitted changes):
```bash
SKIP_VALIDATE=true make
```
2. Run server.

```bash
sudo ./k8e check-config
sudo ./k8e server &
# Kubeconfig is written to /etc/k8e/k8e.yaml
export KUBECONFIG=/etc/k8e/k8e.yaml
sudo ./k8e kubectl get nodes

# On a different node run the below. NODE_TOKEN comes from
# /var/lib/k8e/server/node-token on your server
sudo ./k8e agent --server https://myserver:6443 --token ${NODE_TOKEN}
```
https://getk8e.com/docs/install/200-quick-start/

Acknowledgments
--------------
Expand Down

0 comments on commit ba0ee23

Please sign in to comment.