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

docs: fix link in README, add note about controller configuration Secret #16

Merged
merged 1 commit into from
Dec 5, 2024
Merged
Changes from all commits
Commits
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
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Bootstrapping Utilities for Supernetes

This repository contains tooling that helps with setting up a [Talos Linux](https://www.talos.dev/) Kubernetes cluster for developing and evaluating [Supernetes](https://github.com/twelho/talos-bootstrap.git). More specifically, the tools help with
This repository contains tooling that helps with setting up a [Talos Linux](https://www.talos.dev/) Kubernetes cluster for developing and evaluating [Supernetes](https://github.com/supernetes/supernetes). More specifically, the tools help with

- creating an unprovisioned Talos Linux cluster in [CSC's cPouta](https://research.csc.fi/-/cpouta) OpenStack environment, and
- bootstrapping an unprovisioned Talos Linux cluster using [talos-bootstrap](https://github.com/twelho/talos-bootstrap).
Expand Down Expand Up @@ -62,10 +62,13 @@ The full configuration is applied using [talos-bootstrap](https://github.com/twe
bootstrap supernetes-cluster.yaml
```

and wait for the bootstrap process to finish. Your cluster should now be configured with [Flux](https://fluxcd.io/) automatically reconciling in the Supernetes controller.
and wait for the bootstrap process to finish. Your cluster should now be configured with [FluxCD](https://fluxcd.io/) automatically reconciling in the Supernetes controller.

Refer to the documentation of [talos-bootstrap](https://github.com/twelho/talos-bootstrap) for details, such as how to apply patches and additional manifests etc.

> [!IMPORTANT]
> Don't forget to additionally apply the Supernetes controller configuration Secret (see the [configuration section in the Supernetes repository](https://github.com/supernetes/supernetes?tab=readme-ov-file#configuration)) with `kubectl apply -f controller.yaml`.

## Authors

- Dennis Marttinen ([@twelho](https://github.com/twelho))
Expand Down
Loading