Skip to content

Commit

Permalink
docs: update README & add example to vcluster connect
Browse files Browse the repository at this point in the history
  • Loading branch information
FabianKramm committed Jan 5, 2022
1 parent d2b5dcb commit 8b4cdf3
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Learn more in the [documentation](https://vcluster.com/docs/what-are-virtual-clu
### Features

- **Certified Kubernetes Distribution** - vcluster itself is a [certified Kubernetes distribution](https://www.cncf.io/certification/software-conformance/) and is 100% Kubernetes API conform. Everything that works in a regular Kubernetes cluster works in vcluster
- **Lightweight & Low-Overhead** - Based on k3s, bundled in a single pod and with super-low resource consumption
- **Lightweight & Low-Overhead** - Based on k3s, bundled in a single pod and with super-low resource consumption. Other distributions such as k0s or vanilla k8s are also supported
- **No Performance Degradation** - Pods are scheduled in the underlying host cluster, so they get no performance hit at all while running
- **Reduced Overhead On Host Cluster** - Split up large multi-tenant clusters into smaller vcluster to reduce complexity and increase scalability. Since most vcluster api requests and objects will not reach the host cluster at all, vcluster can greatly decrease pressure on the underlying Kubernetes cluster
- **Easy Provisioning** - Create via vcluster CLI, helm, kubectl, Argo or any of your favorite tools (it is basically just a StatefulSet)
Expand Down
3 changes: 3 additions & 0 deletions docs/pages/fragments/connect.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
```bash
vcluster connect vcluster-1 -n host-namespace-1

# OR: create a view only config
vcluster connect vcluster-1 -n host-namespace-1 --service-account viewer --cluster-role view
```

0 comments on commit 8b4cdf3

Please sign in to comment.