website: create website
This commit introduces a the Kilo website. It is generated with Docusaurus and can be deployed with standard services like Netlify. Signed-off-by: Lucas Servén Marín <lserven@gmail.com>
This commit is contained in:
@@ -1,3 +1,9 @@
|
||||
---
|
||||
id: annotations
|
||||
title: Annotations
|
||||
hide_title: true
|
||||
---
|
||||
|
||||
# Annotations
|
||||
|
||||
The following annotations can be added to any Kubernetes Node object to configure the Kilo network.
|
||||
|
@@ -1,10 +1,15 @@
|
||||
---
|
||||
id: kgctl
|
||||
hide_title: true
|
||||
---
|
||||
|
||||
# kgctl
|
||||
|
||||
Kilo provides a command line tool for inspecting and interacting with clusters: `kgctl`.
|
||||
This tool can be used to understand a mesh's topology, get the WireGuard configuration for a peer, or graph a cluster.
|
||||
`kgctl` requires a Kubernetes configuration file to be provided, either by setting the `KUBECONFIG` environment variable or by providing the `--kubeconfig` flag.
|
||||
|
||||
## Getting Started
|
||||
## Installation
|
||||
|
||||
Installing `kgctl` currently requires building the binary from source.
|
||||
*Note*: the [Go toolchain must be installed](https://golang.org/doc/install) in order to build the binary.
|
||||
@@ -60,7 +65,7 @@ kgctl graph | circo -Tsvg > cluster.svg
|
||||
|
||||
This will generate an SVG like:
|
||||
|
||||
<img src="./graphs/location.svg">
|
||||
<img src="./graphs/location.svg" />
|
||||
|
||||
### showconf
|
||||
|
||||
|
@@ -1,3 +1,9 @@
|
||||
---
|
||||
id: multi-cluster-services
|
||||
title: Multi-cluster Services
|
||||
hide_title: true
|
||||
---
|
||||
|
||||
# Multi-cluster Services
|
||||
|
||||
Just as Kilo can connect a Kubernetes cluster to external services over WireGuard, it can connect multiple independent Kubernetes clusters.
|
||||
|
@@ -1,3 +1,9 @@
|
||||
---
|
||||
id: topology
|
||||
title: Topology
|
||||
hide_title: true
|
||||
---
|
||||
|
||||
# Topology
|
||||
|
||||
Kilo allows the topology of the encrypted network to be customized.
|
||||
@@ -30,7 +36,7 @@ Analyzing the cluster with `kgctl` would produce a result like:
|
||||
kgctl graph | circo -Tsvg > cluster.svg
|
||||
```
|
||||
|
||||
<img src="./graphs/location.svg">
|
||||
<img src="./graphs/location.svg" />
|
||||
|
||||
## Full Mesh
|
||||
|
||||
@@ -44,7 +50,7 @@ Analyzing the cluster with `kgctl` would produce a result like:
|
||||
kgctl graph | circo -Tsvg > cluster.svg
|
||||
```
|
||||
|
||||
<img src="./graphs/full-mesh.svg">
|
||||
<img src="./graphs/full-mesh.svg" />
|
||||
|
||||
## Mixed
|
||||
|
||||
@@ -64,7 +70,7 @@ Analyzing the cluster with `kgctl` would produce a result like:
|
||||
kgctl graph | circo -Tsvg > cluster.svg
|
||||
```
|
||||
|
||||
<img src="./graphs/mixed.svg">
|
||||
<img src="./graphs/mixed.svg" />
|
||||
|
||||
If the cluster also had nodes in AWS, then the following snippet could be used:
|
||||
|
||||
@@ -80,4 +86,4 @@ This would in turn produce a graph like:
|
||||
kgctl graph | circo -Tsvg > cluster.svg
|
||||
```
|
||||
|
||||
<img src="./graphs/complex.svg">
|
||||
<img src="./graphs/complex.svg" />
|
||||
|
@@ -1,3 +1,9 @@
|
||||
---
|
||||
id: vpn-server
|
||||
title: VPN Sever
|
||||
hide_title: true
|
||||
---
|
||||
|
||||
# VPN Server
|
||||
|
||||
The cluster VPN created by Kilo can also be used by peers as a gateway to access the Internet.
|
||||
|
@@ -1,3 +1,9 @@
|
||||
---
|
||||
id: vpn
|
||||
title: VPN
|
||||
hide_title: true
|
||||
---
|
||||
|
||||
# VPN
|
||||
|
||||
Kilo enables peers outside of a Kubernetes cluster to connect to the created WireGuard network.
|
||||
|
Reference in New Issue
Block a user