Skip to content

Commit

Permalink
Merge pull request #16 from supernetes/update-readme
Browse files Browse the repository at this point in the history
docs: fix link in README, add note about controller configuration Secret
  • Loading branch information
twelho authored Dec 5, 2024
2 parents ef82c23 + 6230dac commit 3ed64e6
Showing 1 changed file with 5 additions and 2 deletions.
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

0 comments on commit 3ed64e6

Please sign in to comment.