From a996803db539b8628af8bc600635c6a09fdc50f0 Mon Sep 17 00:00:00 2001 From: Adriano Pezzuto <2222461+bsctl@users.noreply.github.com> Date: Tue, 22 Aug 2023 09:34:43 +0200 Subject: [PATCH] docs: link to supported CAPI providers --- docs/content/guides/alternative-datastore.md | 2 +- docs/content/guides/backup-and-restore.md | 2 +- docs/content/guides/certs-lifecycle.md | 2 +- docs/content/guides/cluster-api.md | 6 ++++++ docs/content/guides/kamaji-gitops-flux.md | 2 +- docs/mkdocs.yml | 1 + 6 files changed, 11 insertions(+), 4 deletions(-) create mode 100644 docs/content/guides/cluster-api.md diff --git a/docs/content/guides/alternative-datastore.md b/docs/content/guides/alternative-datastore.md index 8f87a77..60526b7 100644 --- a/docs/content/guides/alternative-datastore.md +++ b/docs/content/guides/alternative-datastore.md @@ -1,4 +1,4 @@ -# Use alternative datastores +# Use Alternative Datastores Kamaji offers the possibility of having a different storage system than `etcd` thanks to [kine](https://github.com/k3s-io/kine) integration. One of the implementations is [PostgreSQL](https://www.postgresql.org/). diff --git a/docs/content/guides/backup-and-restore.md b/docs/content/guides/backup-and-restore.md index d6f3f27..1db251d 100644 --- a/docs/content/guides/backup-and-restore.md +++ b/docs/content/guides/backup-and-restore.md @@ -1,4 +1,4 @@ -# Backup and restore +# Backup and Restore As mentioned in the introduction, Kamaji “tenant clusters” are just regular pods scheduled on top of a choosn admin cluster; as such, you can take advantage of the same backup and restore methods that you would use to maintain the standard workload. diff --git a/docs/content/guides/certs-lifecycle.md b/docs/content/guides/certs-lifecycle.md index 6201f72..aa85452 100644 --- a/docs/content/guides/certs-lifecycle.md +++ b/docs/content/guides/certs-lifecycle.md @@ -1,4 +1,4 @@ -# Certificates lifecycle +# Certificates Lifecycle Kamaji is responsible for creating the required certificates, such as: diff --git a/docs/content/guides/cluster-api.md b/docs/content/guides/cluster-api.md new file mode 100644 index 0000000..79727a9 --- /dev/null +++ b/docs/content/guides/cluster-api.md @@ -0,0 +1,6 @@ +# Cluster APIs Support + +The [Cluster API](https://github.com/kubernetes-sigs/cluster-api) brings declarative, Kubernetes-style APIs to creation of Kubernetes clusters, including configuration and management. + +Kamaji offers seamless integration with the most popular Cluster API Infrastructure Providers. Check the currently supported providers and the roadmap on the related [reposistory](https://github.com/clastix/cluster-api-control-plane-provider-kamaji). + diff --git a/docs/content/guides/kamaji-gitops-flux.md b/docs/content/guides/kamaji-gitops-flux.md index 17f410a..544968d 100644 --- a/docs/content/guides/kamaji-gitops-flux.md +++ b/docs/content/guides/kamaji-gitops-flux.md @@ -1,4 +1,4 @@ -# Manage tenant resources GitOps-way from the admin cluster +# Manage Tenant Control Planes with GitOps This guide describe a declarative way to deploy Kubernetes add-ons across multiple Tenant Clusters, the GitOps-way. An admin may need to apply a specific workload into Tenant Clusters and ensure is constantly reconciled, no matter what the tenants will do in their clusters. Examples include installing monitoring agents, ensuring specific policies, installing infrastructure operators like Cert Manager and so on. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 0f4a4a3..ef59cc2 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -66,6 +66,7 @@ nav: - guides/datastore-migration.md - guides/backup-and-restore.md - guides/certs-lifecycle.md + - guides/cluster-api.md - 'Use Cases': use-cases.md - 'Reference': - reference/index.md