Skip to content

Commit af7675d

Browse files
authored
Isolated Clusters (#178)
1 parent 13c6821 commit af7675d

File tree

12 files changed

+701
-18
lines changed

12 files changed

+701
-18
lines changed

.github/workflows/deploy.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
lfs: true
1818
- uses: julia-actions/setup-julia@latest
1919
with:
20-
version: 1.9.3
20+
version: 1.9.4
2121
- name: Install dependencies
2222
run: julia --color=yes --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd()))'
2323
- name: Build and deploy

.github/workflows/release.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616
lfs: true
1717
- uses: julia-actions/setup-julia@latest
1818
with:
19-
version: 1.9.3
19+
version: 1.9.4
2020
- name: Install dependencies
2121
run: julia --color=yes --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd()))'
2222
- name: Build and deploy

Dockerfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
FROM julia:1.9.3
1+
FROM julia:1.9.4
22
WORKDIR /workdir
33
COPY Project.toml Project.toml
44
COPY docs/Project.toml docs/Project.toml

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Docs
22

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

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

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

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

14-
```
14+
```bash
1515
make
1616
```
1717

1818
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`.
1919

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

22-
```
22+
```make
2323
RELEASE_VERSION=master make update
2424
```
2525

docs/Manifest.toml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# This file is machine-generated - editing it directly is not advised
22

3-
julia_version = "1.9.3"
3+
julia_version = "1.9.4"
44
manifest_format = "2.0"
5-
project_hash = "6c066df5b0d713de03a4d110004792392e9245d3"
5+
project_hash = "b3a3eb60d80c5437b5b46fccc7820a2fe79e60c7"
66

77
[[deps.ANSIColoredPrinters]]
88
git-tree-sha1 = "574baf8110975760d391c710b6341da1afa48d8c"

docs/Project.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ Docs = "e1c13cdf-5c0d-472c-a597-c85aecc67ad6"
33
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
44

55
[compat]
6-
Documenter = "0.27.23"
6+
Documenter = "0.27.25"

docs/make.jl

+2-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ makedocs(
1616
linkcheck_ignore = [
1717
r"^(?!http)",
1818
],
19-
# strict = false, # TODO: Should be enabled soon, links from repos to CONTRIBUTING have to be updated though...
19+
strict = false, # TODO: Should be enabled soon, links from repos to CONTRIBUTING have to be updated though...
2020
clean = true,
2121
pages = [
2222
"Introduction" => "index.md",
@@ -26,6 +26,7 @@ makedocs(
2626
"Hardware Support" => "overview/hardware.md",
2727
"Operating Systems" => "overview/os.md",
2828
"Kubernetes Integration" => "overview/kubernetes.md",
29+
"Isolated Kubernetes" => "overview/isolated-kubernetes.md",
2930
"Storage" => "overview/storage.md",
3031
"Comparison" => "overview/comparison.md",
3132
],

docs/src/development/proposals/MEP9/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,9 @@ TODO
111111
## References
112112

113113
1. [WireGuard: Next Generation Secure Network Tunnel](https://www.youtube.com/watch?v=88GyLoZbDNw)
114-
2. [How Tailscale works](https://tailscale.com/blog/how-tailscale-works/)
115-
3. [Tailscale is officially SOC 2 compliant](https://tailscale.com/blog/soc2/)
116-
4. [Why not Wireguard](https://blog.ipfire.org/post/why-not-wireguard)
114+
2. [How Tailscale works](https://tailscale.com/blog/how-tailscale-works)
115+
3. [Tailscale is officially SOC 2 compliant](https://tailscale.com/blog/soc2)
116+
4. [Why not Wireguard](https://www.ipfire.org/blog/why-not-wireguard)
117117
5. [Wireguard: Known Limitations](https://www.wireguard.com/known-limitations/)
118118
6. [Wireguard: Things That Might Be Accomplished](https://www.wireguard.com/todo/)
119119
7. [Headscale: Tailscale control protocol v2](https://github.com/juanfont/headscale/issues/526)

docs/src/external/mini-lab/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ The mini-lab is a small, virtual setup to locally run the metal-stack. It deploy
1111
- [Requirements](#requirements)
1212
- [Known Limitations](#known-limitations)
1313
- [Try it out](#try-it-out)
14-
- [Reinstall machine](#reinstall-machine)
15-
- [Free machine](#free-machine)
14+
- [Reinstall machine](#reinstall-machine)
15+
- [Free machine](#free-machine)
1616
- [Flavors](#flavors)
1717

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

docs/src/overview/architecture.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ Some notes on this picture:
108108
- 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.
109109
- 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.
110110

111-
# Machine Provisioning Sequence
111+
## Machine Provisioning Sequence
112112

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

0 commit comments

Comments
 (0)