Merge pull request #290 from sighupio/feat/improved-schema-docs

feat(docs/schema): improve eks, kfdisitribution schema docs
sighupio · Nov 27, 2024 · f5101dc · f5101dc
2 parents f23379b + 0641960
commit f5101dc
Show file tree

Hide file tree

Showing 16 changed files with 7,606 additions and 6,156 deletions.
diff --git a/banners/ekscluster.md b/banners/ekscluster.md
@@ -2,5 +2,11 @@
 
 This document explains the full schema for the `kind: EKSCluster` for the `furyctl.yaml` file used by `furyctl`. This configuration file will be used to deploy a Kubernetes Fury Cluster deployed through AWS's Elastic Kubernetes Service.
 
-An example file can be found [here](https://github.com/sighupio/fury-distribution/blob/feature/schema-docs/templates/config/ekscluster-kfd-v1alpha2.yaml.tpl).
+An example configuration file can be created by running the following command:
 
+```bash
+furyctl create config --kind EKSCluster --version v1.29.4 --name example-cluster
+```
+
+> [!NOTE]
+> Replace the version with your desired version of KFD.
diff --git a/banners/kfddistribution.md b/banners/kfddistribution.md
@@ -2,5 +2,11 @@
 
 This document explains the full schema for the `kind: KFDDistribution` for the `furyctl.yaml` file used by `furyctl`. This configuration file will be used to deploy the Kubernetes Fury Distribution modules on top of an existing Kubernetes cluster.
 
-An example file can be found [here](https://github.com/sighupio/fury-distribution/blob/feature/schema-docs/templates/config/kfddistribution-kfd-v1alpha2.yaml.tpl).
+An example configuration file can be created by running the following command:
 
+```bash
+furyctl create config --kind KFDDistribution --version v1.29.4 --name example-cluster
+```
+
+> [!NOTE]
+> Replace the version with your desired version of KFD.
diff --git a/banners/onpremises.md b/banners/onpremises.md
@@ -2,5 +2,11 @@
 
 This document explains the full schema for the `kind: OnPremises` for the `furyctl.yaml` file used by `furyctl`. This configuration file will be used to deploy the Kubernetes Fury Distribution modules and cluster on premises.
 
-An example file can be found [here](https://github.com/sighupio/fury-distribution/blob/feature/schema-docs/templates/config/onpremises-kfd-v1alpha2.yaml.tpl).
+An example configuration file can be created by running the following command:
 
+```bash
+furyctl create config --kind OnPremises --version v1.29.4 --name example-cluster
+```
+
+> [!NOTE]
+> Replace the version with your desired version of KFD.
diff --git a/defaults/ekscluster-kfd-v1alpha2.yaml b/defaults/ekscluster-kfd-v1alpha2.yaml
@@ -47,7 +47,7 @@ data:
           name: ""
           create: true
           # internal field, should be either the VPC ID taken from the kubernetes
-          # phase or the ID of the created VPC in the Ifra phase
+          # phase or the ID of the created VPC in the Infra phase
           vpcId: ""
       # common configuration for nginx ingress controller
       nginx: