Skip to content

Commit

Permalink
feat(docs/schema): improve eks, kfdisitribution schema docs
Browse files Browse the repository at this point in the history
Port the improvements done for on-prem schema in #268 to the EKS and KFDDistribution schemas and banners used to render the markdown.

Some minor improvements to On-premises too.

fixes sighupio/product-management#543 sighupio/furyctl#287
  • Loading branch information
ralgozino committed Nov 11, 2024
1 parent 718217b commit faa3966
Show file tree
Hide file tree
Showing 16 changed files with 6,409 additions and 5,031 deletions.
8 changes: 7 additions & 1 deletion banners/ekscluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
8 changes: 7 additions & 1 deletion banners/kfddistribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
8 changes: 7 additions & 1 deletion banners/onpremises.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion defaults/ekscluster-kfd-v1alpha2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading

0 comments on commit faa3966

Please sign in to comment.