Skip to content

Commit

Permalink
lint fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
johndietz committed Oct 18, 2023
1 parent 3ad9e80 commit 5402521
Showing 1 changed file with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions docs/common/clusters.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The kubefirst 2.3 release introduces kubernetes cluster lifecycle management to the platform to provide our users with the ability
to create their own opinionated workload clusters in a way that takes advantage of their management cluster. We're introducing both
physical clusters, which will be created in your cloud account, as well as virtual clusters, which are also isolated kubernetes
The kubefirst 2.3 release introduces kubernetes cluster lifecycle management to the platform to provide our users with the ability
to create their own opinionated workload clusters in a way that takes advantage of their management cluster. We're introducing both
physical clusters, which will be created in your cloud account, as well as virtual clusters, which are also isolated kubernetes
clusters, but which run inside your management cluster.

![kubefirst Cluster Provisioning](../img/kubefirst/getting-started/cluster-creation.gif)
Expand All @@ -24,9 +24,8 @@ Each cluster that you create from these templates through our management interfa
![kubefirst Cluster Provisioning](../img/kubefirst/getting-started/cluster-argocd.png)

If you inspect your templates for cluster and vcluster, you'll find them to be very similar. They will both create new kubernetes clusters with the following components preloaded:
- infrastructure:
- virtual: vcluster kubernetes cluster that will run in a namespace in your management cluster, with an additional bootstrap app to configure the cluster with crossplane-managed terraform
- physical: crossplane-managed terraform that creates a kubernetes cluster tailored to your cloud and configures the cluster
- infrastructure (virtual): vcluster kubernetes cluster that will run in a namespace in your management cluster, with an additional bootstrap app to configure the cluster with crossplane-managed terraform

Check failure on line 27 in docs/common/clusters.mdx

View workflow job for this annotation

GitHub Actions / markdown-check (.mdx, **.mdx, mdx.markdownlint.json)

Lists should be surrounded by blank lines

docs/common/clusters.mdx:27 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- infrastructure (virtual): vc..."] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md032.md
- infrastructure (physical): crossplane-managed terraform that creates a kubernetes cluster tailored to your cloud and configures the cluster
- ingress-nginx ingress controller
- external-dns preconfigured for your domain
- external-secrets-operator with preconfigured secret store to access vault in the management cluster
Expand All @@ -45,12 +44,10 @@ You will always be able to create anything you need on your own without our user

## Operating your workload clusters

When you create a cluster in our UI we place the gitops content for the cluster and its apps in your gitops repository. You'll be able to see it in your gitops repo commits.
When you create a cluster in our UI we place the gitops content for the cluster and its apps in your gitops repository. You'll be able to see it in your gitops repo commits.

Cluster creation takes about 6 minutes to fully sync in Argo CD for virtual clusters. Physical clusters take anywhere from 5 to 25 minutes to fully sync, depending on the cloud, the weather, or anything in between.
Cluster creation takes about 6 minutes to fully sync in Argo CD for virtual clusters. Physical clusters take anywhere from 5 to 25 minutes to fully sync, depending on the cloud, the weather, or anything in between.

Your workload cluster will have a starting point app-of-apps in Argo CD in the `clusters` app and will share your cluster's name.

When you delete a cluster, kubefirst will remove the binding from your management cluster so that it begins deleting in Argo CD, but we must leave the directory there so that the apps can remove gracefully. Deletion takes time too - anywhere from 5 to 20 minites depending on the cloud.

It's in our plans to add an async cleanup job, but for now, just know for now that we leave the cluster directory in tact, and you're free to remove it once cluster deprovisioning has completed successfully.
When you delete a cluster, kubefirst will remove the binding from your management cluster so that it begins deleting in Argo CD, but we must leave the directory there so that the apps can remove gracefully. You're free to remove it once cluster deprovisioning has completed successfully. Deletion takes time to deprovision resources - can be anywhere from 5 to 15 minites depending on the cloud. Be patient and inspect the deprovision operation in argocd.

0 comments on commit 5402521

Please sign in to comment.