diff --git a/README.md b/README.md index 4a302f9..f6218b4 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,55 @@ -# Chall-Manager +
+

Chall-Manager

+

Challenge Scenarios on Demand, anywhere, anytime, of any size, and for anyone

+ reference + chall-manager docker pulls + go report + Coverage Status +
+ License + CI + CodeQL +
+ OpenSSF Scoreboard +

+ +> [!CAUTION] +> Chall-Manager is currently in public beta phase. +> It could be run in production, but breaking changes are subject to happen in the upcoming months until General Availability. +> +> It has been tested under production workload during the NoBrackets 2024. + +- [What ?](#what-) +- [Why ?](#why-) +- [Trophy list](#trophy-list) +- [Development setup](#development-setup) + +## What ? + +Chall-Manager is a **platform-agnostic** system able to **start Challenges on Demand** of a player: an **Instance**. +It **abstracts the deployment** thus is **able to cover all existing and future** systems with an API and CRUD operations on a resource: Kubernetes Pods, Proxmox VMs, AWS IAM, FPGA, ... at the only cost of a [Pulumi provider](https://www.pulumi.com/registry/). +To **avoid resources overconsumption**, it janitors them once expired. + +To ease deployments, we created _"recipes"_ in a [SDK](sdk/). + +Please [**Read the documentation**](https://ctfer.io/docs/chall-manager/) for better understanding. + +
+ +
+ +## Why ? + +Alternatives exist, but were not sufficient: they focused on **a single technology** (e.g. Docker or Kubernetes only) and for **one specific platform**. + +With Chall-Manager, you are now able to abstract this all thus don't require to follow other's technical choices. + +## Trophy list + +The following list contains all known events were Chall-Manager has been operated in production: +Please [open an issue](https://github.com/ctfer-io/chall-manager/issues/new) to add your event to the list if we did not ourself. + +- 2024/11/20 [NoBracketsCTF 2024](https://github.com/nobrackets-ctf/NoBrackets-2024) ## Development setup diff --git a/SECURITY.md b/SECURITY.md index 1936d75..eb8b26f 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,6 +1,6 @@ # Reporting Security Issues -Please report any security issues you discovered in the chall-manager to ctfer-io@protonmail.com. +Please report any security issues you discovered in `chall-manager`, `chall-manager-janitor` or the security-by-default recipes of the [SDK](sdk/) to ctfer-io@protonmail.com. We will assess the risk, plus make a fix available before we create a GitHub issue. @@ -10,4 +10,8 @@ Thank you for your contribution. ## Refering to this repository -To refer to this repository using a CPE v2.3, please use `cpe:2.3:a:ctfer-io:chall-manager:*:*:*:*:*:*:*:*` with the `version` set to the tag you are using. +To refer to this repository using a CPE v2.3, please use respectively: +- `chall-manager`: `cpe:2.3:a:ctfer-io:chall-manager:*:*:*:*:*:*:*:*` +- `chall-manager-janitor`: `cpe:2.3:a:ctfer-io:chall-manager-janitor:*:*:*:*:*:*:*:*` + +Use with the `version` set to the tag you are using. diff --git a/webdocs/ops-guides/deployment/infrastructure.excalidraw.png b/webdocs/ops-guides/deployment/infrastructure.excalidraw.png index 198d737..ce785a9 100644 Binary files a/webdocs/ops-guides/deployment/infrastructure.excalidraw.png and b/webdocs/ops-guides/deployment/infrastructure.excalidraw.png differ