diff --git a/README.md b/README.md index c47512fc..7f38d0e6 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,10 @@ This section provides instructions on how to install K3k and the `k3kcli`. ### Prerequisites * [Helm](https://helm.sh) must be installed to use the charts. Please refer to Helm's [documentation](https://helm.sh/docs) to get started. +* An existing [RKE2](https://docs.rke2.io/install/quickstart) Kubernetes cluster (recommended). +* A configured storage provider with a default storage class. +**Note:** If you do not have a storage provider, you can configure the cluster to use ephemeral or static storage. Please consult the [k3kcli advance usage](./docs/advanced-usage.md#using-the-cli) for instructions on using these options. ### Install the K3k controller diff --git a/docs/advanced-usage.md b/docs/advanced-usage.md index dfd220eb..6d30e6ab 100644 --- a/docs/advanced-usage.md +++ b/docs/advanced-usage.md @@ -6,7 +6,7 @@ This document provides advanced usage information for k3k, including detailed us The `Cluster` resource provides a variety of fields for customizing the behavior of your virtual clusters. You can check the [CRD documentation](./crds/crd-docs.md) for the full specs. -**Note:** Most of these customization options can also be configured using the `k3kcli` tool. Refer to the `k3kcli` documentation for more details. +**Note:** Most of these customization options can also be configured using the `k3kcli` tool. Refer to the [k3kcli](./cli/cli-docs.md) documentation for more details. @@ -112,3 +112,35 @@ The `clusterDNS` field specifies the IP address for the CoreDNS service. It need ### `serverArgs` The `serverArgs` field allows you to specify additional arguments to be passed to the K3s server pods. + +## Using the cli + +You can check the [k3kcli documentation](./cli/cli-docs.md) for the full specs. + +### Examples for no storage provider: + +* Ephemeral Storage: + + ```bash + + k3kcli cluster create my-cluster --persistence-type ephemeral + + ``` + +* Static Storage (Requires pre-provisioned PVs): + + ```bash + + k3kcli cluster create my-cluster --persistence-type static + + ``` + + (You will need to ensure that persistent volumes that match the requirements of your k3k cluster exist before creation) + +*Important Notes:* + +* When using `--persistence-type static`, you must manually create PersistentVolumes (PVs) that match the storage requirements of your K3K cluster. + +* Using `--persistence-type ephemeral` will result in data loss if the nodes are restarted. + +* It is highly recommended to use `--persistence-type dynamic` with a configured storage class. \ No newline at end of file