Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Isolated Clusters #178

Merged
merged 39 commits into from
Feb 2, 2024
Merged
Show file tree
Hide file tree
Changes from 33 commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
14f83d1
Draft Isolated Clusters
majst01 Jan 29, 2024
f75f99c
Fixes
majst01 Jan 29, 2024
78d0035
Fix links
majst01 Jan 29, 2024
8dfedbe
Progress
majst01 Jan 29, 2024
a55ce15
Progress
majst01 Jan 29, 2024
76ff8c6
Updated diagram
majst01 Jan 29, 2024
9215033
Progress
majst01 Jan 29, 2024
7ec3ee5
Progress
majst01 Jan 30, 2024
f270728
Progress
majst01 Jan 30, 2024
7242184
Describe design choice
majst01 Jan 30, 2024
0e7aa2c
Adopt firewall-controller-manager changes
majst01 Jan 30, 2024
1ce313b
Update docs/src/overview/isolated-kubernetes.md
majst01 Jan 30, 2024
21cd554
Update docs/src/overview/isolated-kubernetes.md
majst01 Jan 30, 2024
6d281cf
Update docs/src/overview/isolated-kubernetes.md
majst01 Jan 30, 2024
e951873
Update docs/src/overview/isolated-kubernetes.md
majst01 Jan 30, 2024
3d3e670
Update docs/src/overview/isolated-kubernetes.md
majst01 Jan 30, 2024
3d7b7c4
Update docs/src/overview/isolated-kubernetes.md
majst01 Jan 30, 2024
69c9f48
Update docs/src/overview/isolated-kubernetes.md
majst01 Jan 30, 2024
ecfe3fd
Update docs/src/overview/isolated-kubernetes.md
majst01 Jan 30, 2024
92ffc28
Update docs/src/overview/isolated-kubernetes.md
majst01 Jan 30, 2024
bb2865d
Update docs/src/overview/isolated-kubernetes.md
majst01 Jan 30, 2024
a03b983
Update docs/src/overview/isolated-kubernetes.md
majst01 Jan 30, 2024
5e6f5bf
Update docs/src/overview/isolated-kubernetes.md
majst01 Jan 30, 2024
abe777f
Update docs/src/overview/isolated-kubernetes.md
majst01 Jan 30, 2024
73b459e
Update docs/src/overview/isolated-kubernetes.md
majst01 Jan 30, 2024
2b736ed
Update docs/src/overview/isolated-kubernetes.md
majst01 Jan 30, 2024
a124ae4
Update docs/src/overview/isolated-kubernetes.md
majst01 Jan 30, 2024
954ab47
Update docs/src/overview/isolated-kubernetes.md
majst01 Jan 30, 2024
7e67eed
Update docs/src/overview/isolated-kubernetes.md
majst01 Jan 30, 2024
2642f1d
Update docs/src/overview/isolated-kubernetes.md
majst01 Jan 30, 2024
43b2184
Update docs/src/overview/isolated-kubernetes.md
majst01 Jan 30, 2024
b176b14
Update docs/src/overview/isolated-kubernetes.md
majst01 Jan 30, 2024
cf2687c
Update docs/src/overview/isolated-kubernetes.md
majst01 Jan 30, 2024
6b2a6be
Review findings
majst01 Jan 31, 2024
1f6bafd
Review findings
majst01 Jan 31, 2024
99a863e
Progress
majst01 Jan 31, 2024
70a907d
Better CWNP description
majst01 Feb 1, 2024
02c60bf
Fix table
majst01 Feb 1, 2024
d205427
Incorporate suggestions from ChatGPT
robertvolkmann Feb 1, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
lfs: true
- uses: julia-actions/setup-julia@latest
with:
version: 1.9.3
version: 1.9.4
- name: Install dependencies
run: julia --color=yes --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd()))'
- name: Build and deploy
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
lfs: true
- uses: julia-actions/setup-julia@latest
with:
version: 1.9.3
version: 1.9.4
- name: Install dependencies
run: julia --color=yes --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd()))'
- name: Build and deploy
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM julia:1.9.3
FROM julia:1.9.4
WORKDIR /workdir
COPY Project.toml Project.toml
COPY docs/Project.toml docs/Project.toml
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Docs

[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://docs.metal-stack.io/)
[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://docs.metal-stack.io/dev/)
[![Stable Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://docs.metal-stack.io/)
[![Devel Docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://docs.metal-stack.io/dev/)

This repository contains the documentation of metal-stack at [docs.metal-stack.io](https://docs.metal-stack.io/).

Expand All @@ -11,15 +11,15 @@ It is being generated using [Julia Documenter](https://github.com/JuliaDocs/Docu

To generate the documentation you can use the following command (only Docker is required):

```
```bash
make
```

The result is being written to `docs/build` and is fully static. You can simply view it in your browser by opening `docs/build/index.html`.

To update the docs that is included from external repositories (e.g. metalctl, mini-lab, ...), you can run the following target:

```
```make
RELEASE_VERSION=master make update
```

Expand Down
4 changes: 2 additions & 2 deletions docs/Manifest.toml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# This file is machine-generated - editing it directly is not advised

julia_version = "1.9.3"
julia_version = "1.9.4"
manifest_format = "2.0"
project_hash = "6c066df5b0d713de03a4d110004792392e9245d3"
project_hash = "b3a3eb60d80c5437b5b46fccc7820a2fe79e60c7"

[[deps.ANSIColoredPrinters]]
git-tree-sha1 = "574baf8110975760d391c710b6341da1afa48d8c"
Expand Down
2 changes: 1 addition & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Docs = "e1c13cdf-5c0d-472c-a597-c85aecc67ad6"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

[compat]
Documenter = "0.27.23"
Documenter = "0.27.25"
3 changes: 2 additions & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ makedocs(
linkcheck_ignore = [
r"^(?!http)",
],
# strict = false, # TODO: Should be enabled soon, links from repos to CONTRIBUTING have to be updated though...
strict = false, # TODO: Should be enabled soon, links from repos to CONTRIBUTING have to be updated though...
clean = true,
pages = [
"Introduction" => "index.md",
Expand All @@ -26,6 +26,7 @@ makedocs(
"Hardware Support" => "overview/hardware.md",
"Operating Systems" => "overview/os.md",
"Kubernetes Integration" => "overview/kubernetes.md",
"Isolated Kubernetes" => "overview/isolated-kubernetes.md",
"Storage" => "overview/storage.md",
"Comparison" => "overview/comparison.md",
],
Expand Down
6 changes: 3 additions & 3 deletions docs/src/development/proposals/MEP9/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,9 @@ TODO
## References

1. [WireGuard: Next Generation Secure Network Tunnel](https://www.youtube.com/watch?v=88GyLoZbDNw)
2. [How Tailscale works](https://tailscale.com/blog/how-tailscale-works/)
3. [Tailscale is officially SOC 2 compliant](https://tailscale.com/blog/soc2/)
4. [Why not Wireguard](https://blog.ipfire.org/post/why-not-wireguard)
2. [How Tailscale works](https://tailscale.com/blog/how-tailscale-works)
3. [Tailscale is officially SOC 2 compliant](https://tailscale.com/blog/soc2)
4. [Why not Wireguard](https://www.ipfire.org/blog/why-not-wireguard)
5. [Wireguard: Known Limitations](https://www.wireguard.com/known-limitations/)
6. [Wireguard: Things That Might Be Accomplished](https://www.wireguard.com/todo/)
7. [Headscale: Tailscale control protocol v2](https://github.com/juanfont/headscale/issues/526)
6 changes: 3 additions & 3 deletions docs/src/external/mini-lab/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ The mini-lab is a small, virtual setup to locally run the metal-stack. It deploy
- [Requirements](#requirements)
- [Known Limitations](#known-limitations)
- [Try it out](#try-it-out)
- [Reinstall machine](#reinstall-machine)
- [Free machine](#free-machine)
- [Reinstall machine](#reinstall-machine)
- [Free machine](#free-machine)
- [Flavors](#flavors)

<!-- /TOC -->
Expand All @@ -23,7 +23,7 @@ The mini-lab is a small, virtual setup to locally run the metal-stack. It deploy
- kvm as hypervisor for the VMs (you can check through the `kvm-ok` command)
- [docker](https://www.docker.com/) >= 20.10.13 (for using kind and our deployment base image)
- [kind](https://github.com/kubernetes-sigs/kind/releases) == v0.20.0 (for hosting the metal control plane)
- [containerlab](https://containerlab.srlinux.dev/install/) >= v0.47.1
- [containerlab](https://containerlab.dev/install/) >= v0.47.1
- the lab creates a docker network on your host machine (`172.17.0.1`), this hopefully does not overlap with other networks you have
- (recommended) haveged to have enough random entropy (only needed if the PXE process does not work)

Expand Down
2 changes: 1 addition & 1 deletion docs/src/overview/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Some notes on this picture:
- By design, a partition only has very few ports open for incoming-connections from the internet. This contributes to a smaller attack surface and higher security of your infrastructure.
- With the help of NSQ, it is not required to have connections from the metal control plane to the metal-core. The metal-core instances register at the message bus and can then consume partition-specfic topics, e.g. when a machine deletion gets issued by a user.

# Machine Provisioning Sequence
## Machine Provisioning Sequence

The following sequence diagram illustrates some of the main principles of the machine provisioning lifecycle.

Expand Down
Loading
Loading