From 198de17d0709b6b772a7335246479b894bb51d7a Mon Sep 17 00:00:00 2001 From: Richard Case Date: Mon, 13 May 2024 08:24:19 +0100 Subject: [PATCH] docs: started to update readme Signed-off-by: Richard Case --- .gitignore | 1 + README.md | 19 +++++++++++++++++-- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 7568c21..2ddab1d 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,4 @@ _out/ .vscode/ .idea/ child.kubeconfig +.venv/ diff --git a/README.md b/README.md index bdeb8c7..9d6a794 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,20 @@ # Cluster API Add-on Provider for Fleet -A add-on provider for Cluster API that will register a newly provisioned CAPI cluster with Fleet so that applications can be automatically deployed to the created cluster using GitOps. +> NOTE: this is a work in progress. The project is looking for more contributors. -> NOTE: this is a work in progress \ No newline at end of file +## What is Cluster API Add-on Provider for Fleet (CAAPF)? + +Cluster API Add-on Provider for Fleet (CAAPF) is a Cluster API (CAPI) provider that provides integration with [Fleet](https://github.com/rancher/fleet) to enable the easy deployment of applications to a CAPI provisioned cluster. + +It provides the following functionality: + +- The provider will register a newly provisioned CAPI cluster with Fleet so that applications can be automatically deployed to the created cluster using GitOps. +- The provider will automatically create a [Fleet Cluster Group](https://fleet.rancher.io/cluster-group) for every [CAPI ClusterClass](https://cluster-api.sigs.k8s.io/tasks/experimental-features/cluster-class/). This enables you to deploy the same applications to all clusters created from the same ClusterClass. + +## Getting started + +Coming soon! + +## Get in contact + +You can get in contact with us via the [#cluster-api](https://rancher-users.slack.com/archives/C060L985ZGC) channel on the [Rancher Users Slack](https://slack.rancher.io/).