From dd93b980e063804659380089ac9e69eaf73fd42c Mon Sep 17 00:00:00 2001 From: Dipankar Das <65275144+dipankardas011@users.noreply.github.com> Date: Mon, 2 Dec 2024 11:34:20 +0530 Subject: [PATCH 1/5] updated the header Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com> --- content/en/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/_index.md b/content/en/_index.md index 12fecd3..bb127e4 100644 --- a/content/en/_index.md +++ b/content/en/_index.md @@ -2,7 +2,7 @@ title: Ksctl Docs --- -{{< blocks/cover title="Welcome to Ksctl Documentation!" image_anchor="top" height="full" >}} +{{< blocks/cover title="Welcome to Ksctl Documentation(dev)!" image_anchor="top" height="full" >}} ![Propsal design](/img/ksctl-logo.svg) From ce07c8ff28ffb7d94699b0ddf920399475ca8926 Mon Sep 17 00:00:00 2001 From: Dipankar Das <65275144+dipankardas011@users.noreply.github.com> Date: Mon, 2 Dec 2024 12:25:40 +0530 Subject: [PATCH 2/5] moved the develop branch Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com> --- content/en/_index.md | 2 +- .../{develop => }/Cloud Providers/_index.md | 0 .../docs/{develop => }/Cloud Providers/aws.md | 0 .../{develop => }/Cloud Providers/azure.md | 0 .../{develop => }/Cloud Providers/civo.md | 0 .../docs/{develop => }/Cloud Providers/gcp.md | 0 .../{develop => }/Cloud Providers/local.md | 0 .../en/docs/{develop => }/Concepts/_index.md | 0 .../Concepts/ksctl cloud controller.md | 0 .../Concepts/ksctl distro controller.md | 0 .../{develop => }/Concepts/ksctl manager.md | 0 .../Contribution guidelines/_index.md | 0 .../Contribution guidelines/cli.md | 0 .../Contribution guidelines/core.md | 0 .../Contribution guidelines/docs.md | 0 .../{develop => }/Getting started/_index.md | 0 .../{develop => }/Ksctl Operators/_index.md | 0 .../{develop => }/Ksctl Operators/agent.md | 0 .../Ksctl Operators/application.md | 0 .../Ksctl Operators/stateimporter.md | 0 .../Kubernetes Distributions/_index.md | 0 .../Kubernetes Distributions/k3s.md | 0 .../Kubernetes Distributions/kubeadm.md | 0 .../en/docs/{develop => }/Reference/_index.md | 0 .../en/docs/{develop => }/Reference/ksctl.md | 0 .../Reference/ksctl_connect-cluster.md | 0 .../Reference/ksctl_create-cluster.md | 0 .../Reference/ksctl_create-cluster_aws.md | 0 .../Reference/ksctl_create-cluster_azure.md | 0 .../Reference/ksctl_create-cluster_civo.md | 0 .../Reference/ksctl_create-cluster_ha-aws.md | 0 .../ksctl_create-cluster_ha-aws_add-nodes.md | 0 .../ksctl_create-cluster_ha-azure.md | 0 ...ksctl_create-cluster_ha-azure_add-nodes.md | 0 .../Reference/ksctl_create-cluster_ha-civo.md | 0 .../ksctl_create-cluster_ha-civo_add-nodes.md | 0 .../Reference/ksctl_create-cluster_local.md | 0 .../{develop => }/Reference/ksctl_cred.md | 0 .../Reference/ksctl_delete-cluster.md | 0 .../Reference/ksctl_delete-cluster_aws.md | 0 .../Reference/ksctl_delete-cluster_azure.md | 0 .../Reference/ksctl_delete-cluster_civo.md | 0 .../Reference/ksctl_delete-cluster_ha-aws.md | 0 .../ksctl_delete-cluster_ha-aws_del-nodes.md | 0 .../ksctl_delete-cluster_ha-azure.md | 0 ...ksctl_delete-cluster_ha-azure_del-nodes.md | 0 .../Reference/ksctl_delete-cluster_ha-civo.md | 0 .../ksctl_delete-cluster_ha-civo_del-nodes.md | 0 .../Reference/ksctl_delete-cluster_local.md | 0 .../Reference/ksctl_get-clusters.md | 0 .../Reference/ksctl_info-cluster.md | 0 .../Reference/ksctl_self-update.md | 0 .../{develop => }/Reference/ksctl_version.md | 0 .../en/docs/{develop => }/Storage/_index.md | 0 .../en/docs/{develop => }/Storage/external.md | 0 .../en/docs/{develop => }/Storage/local.md | 0 content/en/docs/_index.md | 5 +- .../docs/{develop => }/architecture/_index.md | 0 .../architecture/api-components.md | 0 content/en/docs/develop/_index.md | 10 - .../en/docs/stable/Cloud Providers/_index.md | 9 - content/en/docs/stable/Cloud Providers/aws.md | 134 ----- .../en/docs/stable/Cloud Providers/azure.md | 127 ----- .../en/docs/stable/Cloud Providers/civo.md | 73 --- content/en/docs/stable/Cloud Providers/gcp.md | 17 - .../en/docs/stable/Cloud Providers/local.md | 20 - content/en/docs/stable/Concepts/_index.md | 43 -- .../stable/Concepts/ksctl cloud controller.md | 10 - .../Concepts/ksctl distro controller.md | 11 - .../en/docs/stable/Concepts/ksctl manager.md | 25 - .../stable/Contribution guidelines/_index.md | 151 ------ .../stable/Contribution guidelines/cli.md | 23 - .../stable/Contribution guidelines/core.md | 36 -- .../stable/Contribution guidelines/docs.md | 23 - .../en/docs/stable/Getting started/_index.md | 71 --- .../en/docs/stable/Ksctl Operators/_index.md | 30 -- .../en/docs/stable/Ksctl Operators/agent.md | 18 - .../stable/Ksctl Operators/application.md | 467 ------------------ .../stable/Ksctl Operators/stateimporter.md | 25 - .../stable/Kubernetes Distributions/_index.md | 10 - .../stable/Kubernetes Distributions/k3s.md | 21 - .../Kubernetes Distributions/kubeadm.md | 16 - content/en/docs/stable/Reference/_index.md | 22 - content/en/docs/stable/Reference/ksctl.md | 32 -- .../stable/Reference/ksctl_connect-cluster.md | 57 --- .../stable/Reference/ksctl_create-cluster.md | 39 -- .../Reference/ksctl_create-cluster_aws.md | 47 -- .../Reference/ksctl_create-cluster_azure.md | 47 -- .../Reference/ksctl_create-cluster_civo.md | 47 -- .../Reference/ksctl_create-cluster_ha-aws.md | 53 -- .../ksctl_create-cluster_ha-aws_add-nodes.md | 43 -- .../ksctl_create-cluster_ha-azure.md | 54 -- ...ksctl_create-cluster_ha-azure_add-nodes.md | 44 -- .../Reference/ksctl_create-cluster_ha-civo.md | 54 -- .../ksctl_create-cluster_ha-civo_add-nodes.md | 44 -- .../Reference/ksctl_create-cluster_local.md | 45 -- .../en/docs/stable/Reference/ksctl_cred.md | 30 -- .../stable/Reference/ksctl_delete-cluster.md | 39 -- .../Reference/ksctl_delete-cluster_aws.md | 41 -- .../Reference/ksctl_delete-cluster_azure.md | 42 -- .../Reference/ksctl_delete-cluster_civo.md | 42 -- .../Reference/ksctl_delete-cluster_ha-aws.md | 43 -- .../ksctl_delete-cluster_ha-aws_del-nodes.md | 42 -- .../ksctl_delete-cluster_ha-azure.md | 43 -- ...ksctl_delete-cluster_ha-azure_del-nodes.md | 43 -- .../Reference/ksctl_delete-cluster_ha-civo.md | 43 -- .../ksctl_delete-cluster_ha-civo_del-nodes.md | 43 -- .../Reference/ksctl_delete-cluster_local.md | 41 -- .../stable/Reference/ksctl_get-clusters.md | 40 -- .../stable/Reference/ksctl_info-cluster.md | 43 -- .../stable/Reference/ksctl_self-update.md | 30 -- .../en/docs/stable/Reference/ksctl_version.md | 24 - content/en/docs/stable/Storage/_index.md | 11 - content/en/docs/stable/Storage/external.md | 48 -- content/en/docs/stable/Storage/local.md | 49 -- content/en/docs/stable/_index.md | 10 - content/en/docs/stable/architecture/_index.md | 11 - .../stable/architecture/api-components.md | 23 - netlify.toml | 2 +- 119 files changed, 3 insertions(+), 2785 deletions(-) rename content/en/docs/{develop => }/Cloud Providers/_index.md (100%) rename content/en/docs/{develop => }/Cloud Providers/aws.md (100%) rename content/en/docs/{develop => }/Cloud Providers/azure.md (100%) rename content/en/docs/{develop => }/Cloud Providers/civo.md (100%) rename content/en/docs/{develop => }/Cloud Providers/gcp.md (100%) rename content/en/docs/{develop => }/Cloud Providers/local.md (100%) rename content/en/docs/{develop => }/Concepts/_index.md (100%) rename content/en/docs/{develop => }/Concepts/ksctl cloud controller.md (100%) rename content/en/docs/{develop => }/Concepts/ksctl distro controller.md (100%) rename content/en/docs/{develop => }/Concepts/ksctl manager.md (100%) rename content/en/docs/{develop => }/Contribution guidelines/_index.md (100%) rename content/en/docs/{develop => }/Contribution guidelines/cli.md (100%) rename content/en/docs/{develop => }/Contribution guidelines/core.md (100%) rename content/en/docs/{develop => }/Contribution guidelines/docs.md (100%) rename content/en/docs/{develop => }/Getting started/_index.md (100%) rename content/en/docs/{develop => }/Ksctl Operators/_index.md (100%) rename content/en/docs/{develop => }/Ksctl Operators/agent.md (100%) rename content/en/docs/{develop => }/Ksctl Operators/application.md (100%) rename content/en/docs/{develop => }/Ksctl Operators/stateimporter.md (100%) rename content/en/docs/{develop => }/Kubernetes Distributions/_index.md (100%) rename content/en/docs/{develop => }/Kubernetes Distributions/k3s.md (100%) rename content/en/docs/{develop => }/Kubernetes Distributions/kubeadm.md (100%) rename content/en/docs/{develop => }/Reference/_index.md (100%) rename content/en/docs/{develop => }/Reference/ksctl.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_connect-cluster.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_create-cluster.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_create-cluster_aws.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_create-cluster_azure.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_create-cluster_civo.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_create-cluster_ha-aws.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_create-cluster_ha-aws_add-nodes.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_create-cluster_ha-azure.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_create-cluster_ha-azure_add-nodes.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_create-cluster_ha-civo.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_create-cluster_ha-civo_add-nodes.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_create-cluster_local.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_cred.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_delete-cluster.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_delete-cluster_aws.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_delete-cluster_azure.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_delete-cluster_civo.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_delete-cluster_ha-aws.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_delete-cluster_ha-aws_del-nodes.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_delete-cluster_ha-azure.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_delete-cluster_ha-azure_del-nodes.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_delete-cluster_ha-civo.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_delete-cluster_ha-civo_del-nodes.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_delete-cluster_local.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_get-clusters.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_info-cluster.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_self-update.md (100%) rename content/en/docs/{develop => }/Reference/ksctl_version.md (100%) rename content/en/docs/{develop => }/Storage/_index.md (100%) rename content/en/docs/{develop => }/Storage/external.md (100%) rename content/en/docs/{develop => }/Storage/local.md (100%) rename content/en/docs/{develop => }/architecture/_index.md (100%) rename content/en/docs/{develop => }/architecture/api-components.md (100%) delete mode 100644 content/en/docs/develop/_index.md delete mode 100644 content/en/docs/stable/Cloud Providers/_index.md delete mode 100644 content/en/docs/stable/Cloud Providers/aws.md delete mode 100644 content/en/docs/stable/Cloud Providers/azure.md delete mode 100644 content/en/docs/stable/Cloud Providers/civo.md delete mode 100644 content/en/docs/stable/Cloud Providers/gcp.md delete mode 100644 content/en/docs/stable/Cloud Providers/local.md delete mode 100644 content/en/docs/stable/Concepts/_index.md delete mode 100644 content/en/docs/stable/Concepts/ksctl cloud controller.md delete mode 100644 content/en/docs/stable/Concepts/ksctl distro controller.md delete mode 100644 content/en/docs/stable/Concepts/ksctl manager.md delete mode 100644 content/en/docs/stable/Contribution guidelines/_index.md delete mode 100644 content/en/docs/stable/Contribution guidelines/cli.md delete mode 100644 content/en/docs/stable/Contribution guidelines/core.md delete mode 100644 content/en/docs/stable/Contribution guidelines/docs.md delete mode 100644 content/en/docs/stable/Getting started/_index.md delete mode 100644 content/en/docs/stable/Ksctl Operators/_index.md delete mode 100644 content/en/docs/stable/Ksctl Operators/agent.md delete mode 100644 content/en/docs/stable/Ksctl Operators/application.md delete mode 100644 content/en/docs/stable/Ksctl Operators/stateimporter.md delete mode 100644 content/en/docs/stable/Kubernetes Distributions/_index.md delete mode 100644 content/en/docs/stable/Kubernetes Distributions/k3s.md delete mode 100644 content/en/docs/stable/Kubernetes Distributions/kubeadm.md delete mode 100644 content/en/docs/stable/Reference/_index.md delete mode 100644 content/en/docs/stable/Reference/ksctl.md delete mode 100644 content/en/docs/stable/Reference/ksctl_connect-cluster.md delete mode 100644 content/en/docs/stable/Reference/ksctl_create-cluster.md delete mode 100644 content/en/docs/stable/Reference/ksctl_create-cluster_aws.md delete mode 100644 content/en/docs/stable/Reference/ksctl_create-cluster_azure.md delete mode 100644 content/en/docs/stable/Reference/ksctl_create-cluster_civo.md delete mode 100644 content/en/docs/stable/Reference/ksctl_create-cluster_ha-aws.md delete mode 100644 content/en/docs/stable/Reference/ksctl_create-cluster_ha-aws_add-nodes.md delete mode 100644 content/en/docs/stable/Reference/ksctl_create-cluster_ha-azure.md delete mode 100644 content/en/docs/stable/Reference/ksctl_create-cluster_ha-azure_add-nodes.md delete mode 100644 content/en/docs/stable/Reference/ksctl_create-cluster_ha-civo.md delete mode 100644 content/en/docs/stable/Reference/ksctl_create-cluster_ha-civo_add-nodes.md delete mode 100644 content/en/docs/stable/Reference/ksctl_create-cluster_local.md delete mode 100644 content/en/docs/stable/Reference/ksctl_cred.md delete mode 100644 content/en/docs/stable/Reference/ksctl_delete-cluster.md delete mode 100644 content/en/docs/stable/Reference/ksctl_delete-cluster_aws.md delete mode 100644 content/en/docs/stable/Reference/ksctl_delete-cluster_azure.md delete mode 100644 content/en/docs/stable/Reference/ksctl_delete-cluster_civo.md delete mode 100644 content/en/docs/stable/Reference/ksctl_delete-cluster_ha-aws.md delete mode 100644 content/en/docs/stable/Reference/ksctl_delete-cluster_ha-aws_del-nodes.md delete mode 100644 content/en/docs/stable/Reference/ksctl_delete-cluster_ha-azure.md delete mode 100644 content/en/docs/stable/Reference/ksctl_delete-cluster_ha-azure_del-nodes.md delete mode 100644 content/en/docs/stable/Reference/ksctl_delete-cluster_ha-civo.md delete mode 100644 content/en/docs/stable/Reference/ksctl_delete-cluster_ha-civo_del-nodes.md delete mode 100644 content/en/docs/stable/Reference/ksctl_delete-cluster_local.md delete mode 100644 content/en/docs/stable/Reference/ksctl_get-clusters.md delete mode 100644 content/en/docs/stable/Reference/ksctl_info-cluster.md delete mode 100644 content/en/docs/stable/Reference/ksctl_self-update.md delete mode 100644 content/en/docs/stable/Reference/ksctl_version.md delete mode 100644 content/en/docs/stable/Storage/_index.md delete mode 100644 content/en/docs/stable/Storage/external.md delete mode 100644 content/en/docs/stable/Storage/local.md delete mode 100644 content/en/docs/stable/_index.md delete mode 100644 content/en/docs/stable/architecture/_index.md delete mode 100644 content/en/docs/stable/architecture/api-components.md diff --git a/content/en/_index.md b/content/en/_index.md index bb127e4..4e36d7c 100644 --- a/content/en/_index.md +++ b/content/en/_index.md @@ -9,7 +9,7 @@ title: Ksctl Docs Learn More - + Getting Started diff --git a/content/en/docs/develop/Cloud Providers/_index.md b/content/en/docs/Cloud Providers/_index.md similarity index 100% rename from content/en/docs/develop/Cloud Providers/_index.md rename to content/en/docs/Cloud Providers/_index.md diff --git a/content/en/docs/develop/Cloud Providers/aws.md b/content/en/docs/Cloud Providers/aws.md similarity index 100% rename from content/en/docs/develop/Cloud Providers/aws.md rename to content/en/docs/Cloud Providers/aws.md diff --git a/content/en/docs/develop/Cloud Providers/azure.md b/content/en/docs/Cloud Providers/azure.md similarity index 100% rename from content/en/docs/develop/Cloud Providers/azure.md rename to content/en/docs/Cloud Providers/azure.md diff --git a/content/en/docs/develop/Cloud Providers/civo.md b/content/en/docs/Cloud Providers/civo.md similarity index 100% rename from content/en/docs/develop/Cloud Providers/civo.md rename to content/en/docs/Cloud Providers/civo.md diff --git a/content/en/docs/develop/Cloud Providers/gcp.md b/content/en/docs/Cloud Providers/gcp.md similarity index 100% rename from content/en/docs/develop/Cloud Providers/gcp.md rename to content/en/docs/Cloud Providers/gcp.md diff --git a/content/en/docs/develop/Cloud Providers/local.md b/content/en/docs/Cloud Providers/local.md similarity index 100% rename from content/en/docs/develop/Cloud Providers/local.md rename to content/en/docs/Cloud Providers/local.md diff --git a/content/en/docs/develop/Concepts/_index.md b/content/en/docs/Concepts/_index.md similarity index 100% rename from content/en/docs/develop/Concepts/_index.md rename to content/en/docs/Concepts/_index.md diff --git a/content/en/docs/develop/Concepts/ksctl cloud controller.md b/content/en/docs/Concepts/ksctl cloud controller.md similarity index 100% rename from content/en/docs/develop/Concepts/ksctl cloud controller.md rename to content/en/docs/Concepts/ksctl cloud controller.md diff --git a/content/en/docs/develop/Concepts/ksctl distro controller.md b/content/en/docs/Concepts/ksctl distro controller.md similarity index 100% rename from content/en/docs/develop/Concepts/ksctl distro controller.md rename to content/en/docs/Concepts/ksctl distro controller.md diff --git a/content/en/docs/develop/Concepts/ksctl manager.md b/content/en/docs/Concepts/ksctl manager.md similarity index 100% rename from content/en/docs/develop/Concepts/ksctl manager.md rename to content/en/docs/Concepts/ksctl manager.md diff --git a/content/en/docs/develop/Contribution guidelines/_index.md b/content/en/docs/Contribution guidelines/_index.md similarity index 100% rename from content/en/docs/develop/Contribution guidelines/_index.md rename to content/en/docs/Contribution guidelines/_index.md diff --git a/content/en/docs/develop/Contribution guidelines/cli.md b/content/en/docs/Contribution guidelines/cli.md similarity index 100% rename from content/en/docs/develop/Contribution guidelines/cli.md rename to content/en/docs/Contribution guidelines/cli.md diff --git a/content/en/docs/develop/Contribution guidelines/core.md b/content/en/docs/Contribution guidelines/core.md similarity index 100% rename from content/en/docs/develop/Contribution guidelines/core.md rename to content/en/docs/Contribution guidelines/core.md diff --git a/content/en/docs/develop/Contribution guidelines/docs.md b/content/en/docs/Contribution guidelines/docs.md similarity index 100% rename from content/en/docs/develop/Contribution guidelines/docs.md rename to content/en/docs/Contribution guidelines/docs.md diff --git a/content/en/docs/develop/Getting started/_index.md b/content/en/docs/Getting started/_index.md similarity index 100% rename from content/en/docs/develop/Getting started/_index.md rename to content/en/docs/Getting started/_index.md diff --git a/content/en/docs/develop/Ksctl Operators/_index.md b/content/en/docs/Ksctl Operators/_index.md similarity index 100% rename from content/en/docs/develop/Ksctl Operators/_index.md rename to content/en/docs/Ksctl Operators/_index.md diff --git a/content/en/docs/develop/Ksctl Operators/agent.md b/content/en/docs/Ksctl Operators/agent.md similarity index 100% rename from content/en/docs/develop/Ksctl Operators/agent.md rename to content/en/docs/Ksctl Operators/agent.md diff --git a/content/en/docs/develop/Ksctl Operators/application.md b/content/en/docs/Ksctl Operators/application.md similarity index 100% rename from content/en/docs/develop/Ksctl Operators/application.md rename to content/en/docs/Ksctl Operators/application.md diff --git a/content/en/docs/develop/Ksctl Operators/stateimporter.md b/content/en/docs/Ksctl Operators/stateimporter.md similarity index 100% rename from content/en/docs/develop/Ksctl Operators/stateimporter.md rename to content/en/docs/Ksctl Operators/stateimporter.md diff --git a/content/en/docs/develop/Kubernetes Distributions/_index.md b/content/en/docs/Kubernetes Distributions/_index.md similarity index 100% rename from content/en/docs/develop/Kubernetes Distributions/_index.md rename to content/en/docs/Kubernetes Distributions/_index.md diff --git a/content/en/docs/develop/Kubernetes Distributions/k3s.md b/content/en/docs/Kubernetes Distributions/k3s.md similarity index 100% rename from content/en/docs/develop/Kubernetes Distributions/k3s.md rename to content/en/docs/Kubernetes Distributions/k3s.md diff --git a/content/en/docs/develop/Kubernetes Distributions/kubeadm.md b/content/en/docs/Kubernetes Distributions/kubeadm.md similarity index 100% rename from content/en/docs/develop/Kubernetes Distributions/kubeadm.md rename to content/en/docs/Kubernetes Distributions/kubeadm.md diff --git a/content/en/docs/develop/Reference/_index.md b/content/en/docs/Reference/_index.md similarity index 100% rename from content/en/docs/develop/Reference/_index.md rename to content/en/docs/Reference/_index.md diff --git a/content/en/docs/develop/Reference/ksctl.md b/content/en/docs/Reference/ksctl.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl.md rename to content/en/docs/Reference/ksctl.md diff --git a/content/en/docs/develop/Reference/ksctl_connect-cluster.md b/content/en/docs/Reference/ksctl_connect-cluster.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_connect-cluster.md rename to content/en/docs/Reference/ksctl_connect-cluster.md diff --git a/content/en/docs/develop/Reference/ksctl_create-cluster.md b/content/en/docs/Reference/ksctl_create-cluster.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_create-cluster.md rename to content/en/docs/Reference/ksctl_create-cluster.md diff --git a/content/en/docs/develop/Reference/ksctl_create-cluster_aws.md b/content/en/docs/Reference/ksctl_create-cluster_aws.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_create-cluster_aws.md rename to content/en/docs/Reference/ksctl_create-cluster_aws.md diff --git a/content/en/docs/develop/Reference/ksctl_create-cluster_azure.md b/content/en/docs/Reference/ksctl_create-cluster_azure.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_create-cluster_azure.md rename to content/en/docs/Reference/ksctl_create-cluster_azure.md diff --git a/content/en/docs/develop/Reference/ksctl_create-cluster_civo.md b/content/en/docs/Reference/ksctl_create-cluster_civo.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_create-cluster_civo.md rename to content/en/docs/Reference/ksctl_create-cluster_civo.md diff --git a/content/en/docs/develop/Reference/ksctl_create-cluster_ha-aws.md b/content/en/docs/Reference/ksctl_create-cluster_ha-aws.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_create-cluster_ha-aws.md rename to content/en/docs/Reference/ksctl_create-cluster_ha-aws.md diff --git a/content/en/docs/develop/Reference/ksctl_create-cluster_ha-aws_add-nodes.md b/content/en/docs/Reference/ksctl_create-cluster_ha-aws_add-nodes.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_create-cluster_ha-aws_add-nodes.md rename to content/en/docs/Reference/ksctl_create-cluster_ha-aws_add-nodes.md diff --git a/content/en/docs/develop/Reference/ksctl_create-cluster_ha-azure.md b/content/en/docs/Reference/ksctl_create-cluster_ha-azure.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_create-cluster_ha-azure.md rename to content/en/docs/Reference/ksctl_create-cluster_ha-azure.md diff --git a/content/en/docs/develop/Reference/ksctl_create-cluster_ha-azure_add-nodes.md b/content/en/docs/Reference/ksctl_create-cluster_ha-azure_add-nodes.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_create-cluster_ha-azure_add-nodes.md rename to content/en/docs/Reference/ksctl_create-cluster_ha-azure_add-nodes.md diff --git a/content/en/docs/develop/Reference/ksctl_create-cluster_ha-civo.md b/content/en/docs/Reference/ksctl_create-cluster_ha-civo.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_create-cluster_ha-civo.md rename to content/en/docs/Reference/ksctl_create-cluster_ha-civo.md diff --git a/content/en/docs/develop/Reference/ksctl_create-cluster_ha-civo_add-nodes.md b/content/en/docs/Reference/ksctl_create-cluster_ha-civo_add-nodes.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_create-cluster_ha-civo_add-nodes.md rename to content/en/docs/Reference/ksctl_create-cluster_ha-civo_add-nodes.md diff --git a/content/en/docs/develop/Reference/ksctl_create-cluster_local.md b/content/en/docs/Reference/ksctl_create-cluster_local.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_create-cluster_local.md rename to content/en/docs/Reference/ksctl_create-cluster_local.md diff --git a/content/en/docs/develop/Reference/ksctl_cred.md b/content/en/docs/Reference/ksctl_cred.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_cred.md rename to content/en/docs/Reference/ksctl_cred.md diff --git a/content/en/docs/develop/Reference/ksctl_delete-cluster.md b/content/en/docs/Reference/ksctl_delete-cluster.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_delete-cluster.md rename to content/en/docs/Reference/ksctl_delete-cluster.md diff --git a/content/en/docs/develop/Reference/ksctl_delete-cluster_aws.md b/content/en/docs/Reference/ksctl_delete-cluster_aws.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_delete-cluster_aws.md rename to content/en/docs/Reference/ksctl_delete-cluster_aws.md diff --git a/content/en/docs/develop/Reference/ksctl_delete-cluster_azure.md b/content/en/docs/Reference/ksctl_delete-cluster_azure.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_delete-cluster_azure.md rename to content/en/docs/Reference/ksctl_delete-cluster_azure.md diff --git a/content/en/docs/develop/Reference/ksctl_delete-cluster_civo.md b/content/en/docs/Reference/ksctl_delete-cluster_civo.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_delete-cluster_civo.md rename to content/en/docs/Reference/ksctl_delete-cluster_civo.md diff --git a/content/en/docs/develop/Reference/ksctl_delete-cluster_ha-aws.md b/content/en/docs/Reference/ksctl_delete-cluster_ha-aws.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_delete-cluster_ha-aws.md rename to content/en/docs/Reference/ksctl_delete-cluster_ha-aws.md diff --git a/content/en/docs/develop/Reference/ksctl_delete-cluster_ha-aws_del-nodes.md b/content/en/docs/Reference/ksctl_delete-cluster_ha-aws_del-nodes.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_delete-cluster_ha-aws_del-nodes.md rename to content/en/docs/Reference/ksctl_delete-cluster_ha-aws_del-nodes.md diff --git a/content/en/docs/develop/Reference/ksctl_delete-cluster_ha-azure.md b/content/en/docs/Reference/ksctl_delete-cluster_ha-azure.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_delete-cluster_ha-azure.md rename to content/en/docs/Reference/ksctl_delete-cluster_ha-azure.md diff --git a/content/en/docs/develop/Reference/ksctl_delete-cluster_ha-azure_del-nodes.md b/content/en/docs/Reference/ksctl_delete-cluster_ha-azure_del-nodes.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_delete-cluster_ha-azure_del-nodes.md rename to content/en/docs/Reference/ksctl_delete-cluster_ha-azure_del-nodes.md diff --git a/content/en/docs/develop/Reference/ksctl_delete-cluster_ha-civo.md b/content/en/docs/Reference/ksctl_delete-cluster_ha-civo.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_delete-cluster_ha-civo.md rename to content/en/docs/Reference/ksctl_delete-cluster_ha-civo.md diff --git a/content/en/docs/develop/Reference/ksctl_delete-cluster_ha-civo_del-nodes.md b/content/en/docs/Reference/ksctl_delete-cluster_ha-civo_del-nodes.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_delete-cluster_ha-civo_del-nodes.md rename to content/en/docs/Reference/ksctl_delete-cluster_ha-civo_del-nodes.md diff --git a/content/en/docs/develop/Reference/ksctl_delete-cluster_local.md b/content/en/docs/Reference/ksctl_delete-cluster_local.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_delete-cluster_local.md rename to content/en/docs/Reference/ksctl_delete-cluster_local.md diff --git a/content/en/docs/develop/Reference/ksctl_get-clusters.md b/content/en/docs/Reference/ksctl_get-clusters.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_get-clusters.md rename to content/en/docs/Reference/ksctl_get-clusters.md diff --git a/content/en/docs/develop/Reference/ksctl_info-cluster.md b/content/en/docs/Reference/ksctl_info-cluster.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_info-cluster.md rename to content/en/docs/Reference/ksctl_info-cluster.md diff --git a/content/en/docs/develop/Reference/ksctl_self-update.md b/content/en/docs/Reference/ksctl_self-update.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_self-update.md rename to content/en/docs/Reference/ksctl_self-update.md diff --git a/content/en/docs/develop/Reference/ksctl_version.md b/content/en/docs/Reference/ksctl_version.md similarity index 100% rename from content/en/docs/develop/Reference/ksctl_version.md rename to content/en/docs/Reference/ksctl_version.md diff --git a/content/en/docs/develop/Storage/_index.md b/content/en/docs/Storage/_index.md similarity index 100% rename from content/en/docs/develop/Storage/_index.md rename to content/en/docs/Storage/_index.md diff --git a/content/en/docs/develop/Storage/external.md b/content/en/docs/Storage/external.md similarity index 100% rename from content/en/docs/develop/Storage/external.md rename to content/en/docs/Storage/external.md diff --git a/content/en/docs/develop/Storage/local.md b/content/en/docs/Storage/local.md similarity index 100% rename from content/en/docs/develop/Storage/local.md rename to content/en/docs/Storage/local.md diff --git a/content/en/docs/_index.md b/content/en/docs/_index.md index f008e32..2ee96a1 100644 --- a/content/en/docs/_index.md +++ b/content/en/docs/_index.md @@ -1,12 +1,9 @@ --- title: Documentation -linkTitle: Docs -menu: {main: {weight: 20}} +description: develop branch documentation weight: 20 --- -**Status: _Technical Preview_** - {{% pageinfo %}} This is the `main` branch documentation {{% /pageinfo %}} diff --git a/content/en/docs/develop/architecture/_index.md b/content/en/docs/architecture/_index.md similarity index 100% rename from content/en/docs/develop/architecture/_index.md rename to content/en/docs/architecture/_index.md diff --git a/content/en/docs/develop/architecture/api-components.md b/content/en/docs/architecture/api-components.md similarity index 100% rename from content/en/docs/develop/architecture/api-components.md rename to content/en/docs/architecture/api-components.md diff --git a/content/en/docs/develop/_index.md b/content/en/docs/develop/_index.md deleted file mode 100644 index d5c43b0..0000000 --- a/content/en/docs/develop/_index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Develop Documentation -linkTitle: Develop -description: develop branch documentation -weight: 20 ---- - -{{% pageinfo %}} -This is the `main` branch documentation -{{% /pageinfo %}} diff --git a/content/en/docs/stable/Cloud Providers/_index.md b/content/en/docs/stable/Cloud Providers/_index.md deleted file mode 100644 index e5912f3..0000000 --- a/content/en/docs/stable/Cloud Providers/_index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Cloud Provider -weight: 4 -description: > - Info about the cloud providers available ---- -{{% pageinfo %}} -This Page includes more info about different cloud providers -{{% /pageinfo %}} diff --git a/content/en/docs/stable/Cloud Providers/aws.md b/content/en/docs/stable/Cloud Providers/aws.md deleted file mode 100644 index ef65700..0000000 --- a/content/en/docs/stable/Cloud Providers/aws.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -title: Amazon Web Services -description: > - Amazon Web Services -categories: [Cloud Provider] -tags: [aws, ha, managed, core] ---- - -{{% pageinfo %}} -Aws support for HA and Managed Clusters -{{% /pageinfo %}} - - -{{% alert color="warning" title="Caution" %}} -we need credentials to access clusters - -these are confidential information so shouldn't be shared with anyone -{{% /alert %}} - - -## How these credentials are used by ksctl - -1. Environment Variables - -```bash -export AWS_ACCESS_KEY_ID="" -export AWS_SECRET_ACCESS_KEY="" -``` - -2. Using command line - -```bash -ksctl cred -``` - -## Current Features - -### Cluster features -#### Highly Available cluster - -clusters which are managed by the user not by cloud provider - -you can choose between k3s and kubeadm as your bootstrap tool - -custom components being used -- Etcd database VM -- HAProxy loadbalancer VM for controlplane nodes -- controlplane VMs -- workerplane VMs - -#### Managed Cluster Elastic Kubernetes Service - -we provision Roles `ksctl-*` 2 for each cluster: -- `ksctl--wp-role` for the EKS NodePool -- `ksctl--cp-role` for the EKS controlplane - -we utilize the iam:AssumeRole to assume the role and create the cluster - - -##### Policies aka permissions for the user -here is the policy and role which we are using - -1. **iam-role-full-access(Custom Policy)** -```json -{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "VisualEditor6", - "Effect": "Allow", - "Action": [ - "iam:CreateInstanceProfile", - "iam:DeleteInstanceProfile", - "iam:GetRole", - "iam:GetInstanceProfile", - "iam:RemoveRoleFromInstanceProfile", - "iam:CreateRole", - "iam:DeleteRole", - "iam:AttachRolePolicy", - "iam:PutRolePolicy", - "iam:ListInstanceProfiles", - "iam:AddRoleToInstanceProfile", - "iam:ListInstanceProfilesForRole", - "iam:PassRole", - "iam:CreateServiceLinkedRole", - "iam:DetachRolePolicy", - "iam:DeleteRolePolicy", - "iam:DeleteServiceLinkedRole", - "iam:GetRolePolicy", - "iam:SetSecurityTokenServicePreferences" - ], - "Resource": [ - "arn:aws:iam::*:role/ksctl-*", - "arn:aws:iam::*:instance-profile/*" - ] - } - ] -} -``` - -2. **eks-full-access(Custom Policy)** -```json -{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "VisualEditor0", - "Effect": "Allow", - "Action": [ - "eks:ListNodegroups", - "eks:ListClusters", - "eks:*" - ], - "Resource": "*" - } - ] -} -``` - -3. **AmazonEC2FullAccess(Aws)** -4. **IAMReadOnlyAccess(Aws)** - -{{% alert color="info" title="Validaty of Kubeconfig" %}} -The Kubeconfig generated after you ran - -```shell -ksctl switch aws --name here-you-go --region us-east-1 -``` - -we are using sst token to authenticate with the cluster, so the kubeconfig is valid for 15 minutes - -once you see that there is a error of unauthorized then you need to re-run the above command - -{{% /alert %}} diff --git a/content/en/docs/stable/Cloud Providers/azure.md b/content/en/docs/stable/Cloud Providers/azure.md deleted file mode 100644 index 54e6fee..0000000 --- a/content/en/docs/stable/Cloud Providers/azure.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -title: Azure -description: > - Azure Cloud Provider -categories: [Cloud Provider] -tags: [azure, ha, managed, core] ---- - -{{% pageinfo %}} -Azure support for HA and Managed Clusters -{{% /pageinfo %}} - - -{{% alert color="warning" title="Caution" %}} -we need credentials to access clusters - -these are confidential information so shouldn't be shared with anyone -{{% /alert %}} - - -### Azure Subscription ID - -subscription id using your subscription - -![azure-subscription](/img/azure/azure-subs-id.png) - - -### Azure Tenant ID - -#### Azure Dashboard - -Azure Dashboard contains all the credentials required - - -![azure-dashboard](/img/azure/azure-dashboard.png) - -lets get the tenant id from the Azure - -![](/img/azure/azure-tenantid.png) - - - -### Azure Client ID - -it represents the id of app created - - -![](/img/azure/azure-app-reg.png) - -![](/img/azure/azure-create-app-reg.png) - -![](/img/azure/azure-clientid.png) - - - -### Azure Client Secret - -it represents the secret associated with the app in order to use it - -![create app secret](/img/azure/azure-client-secret1.png) - - -![after-click](/img/azure/azure-client-secret.png) - - -![copy-secret](/img/azure/azure-client-secret2.png) - -### Assign Role to your app - -head over to subscriptions page and click **Access Control (IAM)** -select the **Role Assignment** and then click **Add > Add Role Assignment** -create a new role and when selecting the identity specify the name of the app -Here you can customize the role this app has - -![role-assign-app](/img/azure/azure-role-app.png) - - -## How these credentials are used by ksctl - - -1. Environment Variables - -```bash -export AZURE_TENANT_ID="" -export AZURE_SUBSCRIPTION_ID="" -export AZURE_CLIENT_ID="" -export AZURE_CLIENT_SECRET="" -``` - -2. Using command line - -```bash -ksctl cred -``` - -## Current Features - -### Cluster features -#### Highly Available cluster -clusters which are managed by the user not by cloud provider - -you can choose between k3s and kubeadm as your bootstrap tool - -custom components being used -- Etcd database VM -- HAProxy loadbalancer VM for controlplane nodes -- controlplane VMs -- workerplane VMs - -#### Managed Cluster -clusters which are managed by the cloud provider - -### Other capabilities - -#### Create, Update, Delete, Switch - -{{% alert title="Update the cluster infrastructure" %}} - -**Managed cluster**: till now it's not supported - -**HA cluster** -- addition and deletion of new workerplane node -- SSH access to each cluster node (DB, LB, Controplane, WorkerPlane) _Public Access_, secured by private key - -{{% /alert %}} - - diff --git a/content/en/docs/stable/Cloud Providers/civo.md b/content/en/docs/stable/Cloud Providers/civo.md deleted file mode 100644 index 0c9d514..0000000 --- a/content/en/docs/stable/Cloud Providers/civo.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: Civo -description: > - Civo Cloud Provider -categories: [Cloud Provider] -tags: [civo, ha, managed, core] ---- - -{{% pageinfo %}} -Civo support for HA and Managed Clusters -{{% /pageinfo %}} - -{{% alert color="warning" title="Caution" %}} -we need credentials to access clusters - -these are confidential information so shouldn't be shared with anyone -{{% /alert %}} - - -## Getting credentials - -### under settings look for the profile -![](/img/civo/civo-settings.png) -![](/img/civo/profile.png) - -### copy the credentials -![](/img/civo/security-api.png) - -## How to add credentials to ksctl - -1. Environment Variables - -```bash -export CIVO_TOKEN="" -``` - -2. Using command line - -```bash -ksctl cred -``` - -## Current Features - -### Cluster features -#### Highly Available cluster -clusters which are managed by the user not by cloud provider - -you can choose between k3s and kubeadm as your bootstrap tool - -custom components being used -- Etcd database VM -- HAProxy loadbalancer instance for controlplane nodes -- controlplane instances -- workerplane instances - -#### Managed Cluster -clusters which are managed by the cloud provider - -### Other capabilities - -#### Create, Update, Delete, Switch - -{{% alert title="Update the cluster infrastructure" %}} - -**Managed cluster**: till now it's not supported - -**HA cluster** -- addition and deletion of new workerplane node -- SSH access to each cluster node (DB, LB, Controplane) _Public Access_, secured by private key -- SSH access to each workplane _Private Access_ via local network, secured by private key -{{% /alert %}} - diff --git a/content/en/docs/stable/Cloud Providers/gcp.md b/content/en/docs/stable/Cloud Providers/gcp.md deleted file mode 100644 index 553c18c..0000000 --- a/content/en/docs/stable/Cloud Providers/gcp.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Google Cloud Platform -description: > - Google Cloud Platform -categories: [Cloud Provider] -tags: [aws, ha, managed, core] ---- - -{{% pageinfo %}} -Gcp support for HA and Managed Clusters -{{% /pageinfo %}} - -{{% alert color="warning" title="Caution" %}} -we need credentials to access clusters - -these are confidential information so shouldn't be shared with anyone -{{% /alert %}} diff --git a/content/en/docs/stable/Cloud Providers/local.md b/content/en/docs/stable/Cloud Providers/local.md deleted file mode 100644 index d7ce767..0000000 --- a/content/en/docs/stable/Cloud Providers/local.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Local -description: > - Local Provider -categories: [Cloud Provider] -tags: [docker, kind, managed,core] ---- - -{{% pageinfo %}} -It creates cluster on the host machine utilizing kind -{{% /pageinfo %}} - -{{% alert title="Note" %}}**Prequisites**: Docker{{% /alert %}} - - -## Current features - -currently using Kind `Kubernetes in Docker` - -{{< alert color="warning" title="About HA Cluster" >}}local system are constrained to fewer CPUs and memory so no HA cluster{{< /alert >}} diff --git a/content/en/docs/stable/Concepts/_index.md b/content/en/docs/stable/Concepts/_index.md deleted file mode 100644 index 4491cd8..0000000 --- a/content/en/docs/stable/Concepts/_index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Concepts -description: > - Concepts around ksctl core ---- - -{{% pageinfo %}} -This section will help you to learn about the underlying system of Ksctl. It will help you to obtain a deeper understanding of how Ksctl works. -{{% /pageinfo %}} - -## Sequence diagrams for 2 major operations - -### Create Cloud-Managed Clusters -```mermaid -sequenceDiagram - participant cm as Manager Cluster Managed - participant cc as Cloud Controller - participant kc as Ksctl Kubernetes Controller - cm->>cc: transfers specs from user or machine - cc->>cc: to create the cloud infra (network, subnet, firewall, cluster) - cc->>cm: 'kubeconfig' and other cluster access to the state - cm->>kc: shares 'kubeconfig' - kc->>kc: installs kubectl agent, stateimporter and controllers - kc->>cm: status of creation -``` - -### Create Self-Managed HA clusters -```mermaid -sequenceDiagram - participant csm as Manager Cluster Self-Managed - participant cc as Cloud Controller - participant bc as Bootstrap Controller - participant kc as Ksctl Kubernetes Controller - csm->>cc: transfers specs from user or machine - cc->>cc: to create the cloud infra (network, subnet, firewall, vms) - cc->>csm: return state to be used by BootstrapController - csm->>bc: transfers infra state like ssh key, pub IPs, etc - bc->>bc: bootstrap the infra by either (k3s or kubeadm) - bc->>csm: 'kubeconfig' and other cluster access to the state - csm->>kc: shares 'kubeconfig' - kc->>kc: installs kubectl agent, stateimporter and controllers - kc->>csm: status of creation -``` diff --git a/content/en/docs/stable/Concepts/ksctl cloud controller.md b/content/en/docs/stable/Concepts/ksctl cloud controller.md deleted file mode 100644 index 2ac325d..0000000 --- a/content/en/docs/stable/Concepts/ksctl cloud controller.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Cloud Controller -description: > - The Component of Ksctl responsible for creating and managing clusters for different Cloud platforms. -categories: [Examples] ---- - -{{% pageinfo %}} -It is responsible for controlling the sequence of tasks for every cloud provider to be executed -{{% /pageinfo %}} diff --git a/content/en/docs/stable/Concepts/ksctl distro controller.md b/content/en/docs/stable/Concepts/ksctl distro controller.md deleted file mode 100644 index a278f5f..0000000 --- a/content/en/docs/stable/Concepts/ksctl distro controller.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Distribution Controller -description: > - The Component of Ksctl responsible for selecting the type of Bootstrap solution (Kubeadm or K3s). -categories: [Examples] ---- - - -{{% pageinfo %}} -It is responsible for controlling the execution sequence for configuring Cloud Resources wrt to the Kubernetes distribution choosen -{{% /pageinfo %}} diff --git a/content/en/docs/stable/Concepts/ksctl manager.md b/content/en/docs/stable/Concepts/ksctl manager.md deleted file mode 100644 index 45d8924..0000000 --- a/content/en/docs/stable/Concepts/ksctl manager.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Core Manager -description: > - The Component of Ksctl responsible for managing Cloud controller and Distribution controller. It has multiple types of managers -categories: [Examples] ---- - -{{% pageinfo %}} -It is responsible for managing client requests and calls the corresponding controller -{{% /pageinfo %}} - -## Types - -### ManagerClusterKsctl -`Role`: Perform ksctl **getCluster**, **switchCluster** - -### ManagerClusterKubernetes -`Role`: Perform ksctl **addApplicationAndCrds** -Currently to be used by machine to machine not by ksctl cli - -### ManagerClusterManaged -`Role`: Perform ksctl **createCluster**, **deleteCluster** - -### ManagerClusterSelfManaged -`Role`: Perform ksctl **createCluster**, **deleteCluster**, **addWorkerNodes**, **delWorkerNodes** diff --git a/content/en/docs/stable/Contribution guidelines/_index.md b/content/en/docs/stable/Contribution guidelines/_index.md deleted file mode 100644 index 9c8d4c6..0000000 --- a/content/en/docs/stable/Contribution guidelines/_index.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -title: Contribution Guidelines -weight: 10 -description: How to contribute to the docs ---- - -{{% pageinfo %}} -You can do almost all the tests in your local except e2e tests which requires you to provide cloud credentials -{{% /pageinfo %}} - -Provide a generic tasks for new and existing contributors - -## Types of changes - -There are many ways to contribute to the ksctl project. Here are a few examples: - -* **New changes to docs:** You can contribute by writing new documentation, fixing typos, or improving the clarity of existing documentation. -* **New features:** You can contribute by proposing new features, implementing new features, or fixing bugs. -* **Cloud support:** You can contribute by adding support for new cloud providers. -* **Kubernetes distribution support:** You can contribute by adding support for new Kubernetes distributions. - -Phases a change / feature goes through - -1. Raise a issue regarding it (used for prioritizing) -2. what all changes does it demands -3. if all goes well you will be assigned -4. If its about adding Cloud Support then usages of CloudFactory is needed and sperate the logic of vm, firewall, etc. to their respective files and do have a helper file for behind the scenes logic for ease of use -5. If its about adding Distribution support do check its compatability with different cloud providers vm configs and firewall rules which needs to be done - -## Formating for PR & Issue subject line - -### Subject / Title - -```markdown -# Releated to enhancement -enhancement: - -# Related to feature -feat: <Title> - -# Related to Bug fix or other types of fixes -fix: <Title> - -# Related to update -update: <Title> -``` - -### Body - -Follow the PR or Issue template -add all the significant changes to the PR description - -### Commit messages - -mention the detailed description in the git commits. -what? why? How? - -**Each commit must be sign-off and should follow conventional commit guidelines.** - -### Conventional Commits - -The commit message should be structured as follows: - -``` -<type>(optional scope): <description> - -[optional body] - -[optional footer(s)] -``` - -For more detailed information on conventional commits, you can refer to the [official Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/). - -### Sign-off - -Each commit must be signed-off. You can do this by adding a sign-off line to your commit messages. -When committing changes in your local branch, add the -S flag to the git commit command: - -```bash -$ git commit -S -m "YOUR_COMMIT_MESSAGE" -# Creates a signed commit -``` - -You can find more comprehensive details on how to sign off git commits by referring to the [GitHub section on signing commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). - -### Verification of Commit Signatures - -You have the option to sign commits and tags locally, which adds a layer of assurance regarding the origin of your changes. GitHub designates commits or tags as either "Verified" or "Partially verified" if they possess a GPG, SSH, or S/MIME signature that is cryptographically valid. - -**GPG Commit Signature Verification** - -To sign commits using GPG and ensure their verification on GitHub, adhere to these steps: - -* Check for existing GPG keys. -* Generate a new GPG key. -* Add the GPG key to your GitHub account. -* Inform Git about your signing key. -* Proceed to sign commits. - -**SSH Commit Signature Verification** - -To sign commits using SSH and ensure their verification on GitHub, follow these steps: - -* Check for existing SSH keys. -* Generate a new SSH key. -* Add an SSH signing key to your GitHub account. -* Inform Git about your signing key. -* Proceed to sign commits. - -**S/MIME Commit Signature Verification** - -To sign commits using S/MIME and ensure their verification on GitHub, follow these steps: - -* Inform Git about your signing key. -* Proceed to sign commits. - -For more detailed instructions, refer to [GitHub's documentation on commit signature verification](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) - -# Development - -First you have to fork the ksctl repository. [fork](https://github.com/ksctl/ksctl/fork) - -```bash -cd <path> # to you directory where you want to clone ksctl -mkdir <directory name> # create a directory -cd <directory name> # go inside the directory -git clone https://github.com/${YOUR_GITHUB_USERNAME}/ksctl.git # clone you fork repository -cd ksctl # go inside the ksctl directory -git remote add upstream https://github.com/ksctl/ksctl.git # set upstream -git remote set-url --push upstream no_push # no push to upstream -``` - -## Trying out code changes - - -Before submitting a code change, it is important to test your changes thoroughly. You can do this by running the unit tests and integration tests. - -## Submitting changes - -Once you have tested your changes, you can submit them to the ksctl project by creating a pull request. -Make sure you use the provided PR template - -## Getting help - -If you need help contributing to the ksctl project, you can ask for help on the kubesimplify Discord server, ksctl-cli channel or else raise issue or discussion - -## Thank you for contributing! - -We appreciate your contributions to the ksctl project! - -Some of our contributors [ksctl contributors](https://github.com/ksctl/ksctl/graphs/contributors) diff --git a/content/en/docs/stable/Contribution guidelines/cli.md b/content/en/docs/stable/Contribution guidelines/cli.md deleted file mode 100644 index cbfc5e7..0000000 --- a/content/en/docs/stable/Contribution guidelines/cli.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Contribution Guidelines for CLI -description: How to contribute to the ksctl-cli ---- - -{{% pageinfo %}} -Repository: ksctl/cli -{{% /pageinfo %}} - - -## How to Build from source -### Linux -```bash -make install_linux # for linux -``` -### Mac OS -```bash -make install_macos # for macos -``` -### Windows -```bash -.\builder.ps1 # for windows -``` \ No newline at end of file diff --git a/content/en/docs/stable/Contribution guidelines/core.md b/content/en/docs/stable/Contribution guidelines/core.md deleted file mode 100644 index c9c0d34..0000000 --- a/content/en/docs/stable/Contribution guidelines/core.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Contribution Guidelines for Core -description: How to contribute to the ksctl ---- - -{{% pageinfo %}} -Repository: ksctl/ksctl -{{% /pageinfo %}} - - -## Test out both All Mock and Unit tests and lints -```bash -make test -``` - -## Test out both All Unit tests -```bash -make unit_test_all -``` - -## Test out both All Mock tests -```bash -make mock_all -``` - -## for E2E tests on local -set the required token as ENV vars -then -```bash -cd test/e2e - -# then the syntax for running -go run . -op create -file azure/create.json - -# for operations you can refer file test/e2e/consts.go -``` diff --git a/content/en/docs/stable/Contribution guidelines/docs.md b/content/en/docs/stable/Contribution guidelines/docs.md deleted file mode 100644 index 98e736c..0000000 --- a/content/en/docs/stable/Contribution guidelines/docs.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Contribution Guidelines for Docs -description: How to contribute to the ksctl-docs ---- - -{{% pageinfo %}} -Repository: ksctl/docs -{{% /pageinfo %}} - - -## How to Build from source -```bash -# Prequisites -npm install -D postcss -npm install -D postcss-cli -npm install -D autoprefixer -npm install hugo-extended -``` - -### Install Dependencies -```bash -hugo serve -``` diff --git a/content/en/docs/stable/Getting started/_index.md b/content/en/docs/stable/Getting started/_index.md deleted file mode 100644 index fa096eb..0000000 --- a/content/en/docs/stable/Getting started/_index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: Getting Started -description: What does your user need to know to try your project? -categories: [Examples, Placeholders] -tags: [test, docs] -weight: 2 ---- - -{{% pageinfo %}} -Getting Started Documentation -{{% /pageinfo %}} - -# Installation & Uninstallation Instructions - -## Ksctl CLI -Lets begin with installation of the tools -their are various method - -### Single command method - -{{% alert title="Install" %}}Steps to Install Ksctl cli tool{{% /alert %}} - -```shell -curl -sfL https://get.ksctl.com | python3 - -``` - -{{% alert title="Uninstall" %}}Steps to Uninstall Ksctl cli tool{{% /alert %}} - -{{< tabpane text=true >}} - {{% tab header="**Operating System**:" disabled=true /%}} - {{% tab header="Linux" %}} -```shell -bash <(curl -s https://raw.githubusercontent.com/ksctl/cli/main/scripts/uninstall.sh) -``` - {{% /tab %}} - {{% tab header="MacOS" %}} -```shell -zsh <(curl -s https://raw.githubusercontent.com/ksctl/cli/main/scripts/uninstall.sh) -``` - {{% /tab %}} -{{< /tabpane >}} - - -### From Source Code - -{{% alert color= "warning" title="Caution!" %}}Under-Development binaries{{% /alert %}} -{{% alert title="Note" %}}The Binaries to testing ksctl cli is available in ksctl/cli repo{{% /alert %}} - -{{< tabpane text=true >}} - {{% tab header="**Operating System**:" disabled=true /%}} - {{% tab header="Linux/MacOS" %}} -```shell -make install_linux - -# macOS on M1 -make install_macos - -# macOS on INTEL -make install_macos_intel - -# For uninstalling -make uninstall -``` - {{% /tab %}} -{{< /tabpane >}} - -{{% alert color="info" title="How to start with cli" %}} - -[Here is the CLI references](https://docs.ksctl.com/docs/stable/reference/) -{{% /alert %}} - diff --git a/content/en/docs/stable/Ksctl Operators/_index.md b/content/en/docs/stable/Ksctl Operators/_index.md deleted file mode 100644 index 649690f..0000000 --- a/content/en/docs/stable/Ksctl Operators/_index.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Ksctl Components -description: Place of all the documentation for the Operators used specifically for k8s clusters -tags: [docs] ---- - -## Components -- ksctl agent -- ksctl stateimporter -- ksctl application controller - -## Sequence diagram on how its deployed -```mermaid -flowchart TD -Base(Ksctl Infra and Bootstrap) -->|Cluster is created| KC(Ksctl controller) -KC -->|Creates| Storage{storageProvider=='local'} -Storage -->|Yes| KSI(Ksctl Storage Importer) -Storage -->|No| KA(Ksctl Agent) -KSI -->KA -KA -->|Health| D(Deploy other ksctl controllers) -``` - -{{% alert title="Some Docs" color="primary" %}} -Here is the new event driven architecture Diagram -![Diagram](https://raw.githubusercontent.com/ksctl/enhancements/main/poc/ksctl-components/overall.svg) - -For more information about this -[Refer](https://github.com/ksctl/enhancements/tree/main/poc/ksctl-components) - -{{% /alert %}} diff --git a/content/en/docs/stable/Ksctl Operators/agent.md b/content/en/docs/stable/Ksctl Operators/agent.md deleted file mode 100644 index 9b9f0c5..0000000 --- a/content/en/docs/stable/Ksctl Operators/agent.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Ksctl Agent -description: Documentation on ksctl agent -categories: [Examples, Placeholders] -tags: [docs] ---- - - -{{% pageinfo %}} -It is a ksctl's solution to infrastructure management and also kubernetes management. - -Especially inside the kubertes cluster -{{% /pageinfo %}} - - -It is a GRPC server running as a deployment. and a fleet of controllers will call it to perform certain operations. For instance, application installation via `stack.application.ksctl.com/v1alpha`, etc. - -It will be installed on all kubernetes cluster created via ksctl from >= v1.2.0 \ No newline at end of file diff --git a/content/en/docs/stable/Ksctl Operators/application.md b/content/en/docs/stable/Ksctl Operators/application.md deleted file mode 100644 index 9ef1e79..0000000 --- a/content/en/docs/stable/Ksctl Operators/application.md +++ /dev/null @@ -1,467 +0,0 @@ ---- -title: Ksctl Application Controller -description: Documentation on ksctl application controller -categories: [Examples, Placeholders] -tags: [docs] ---- - -{{% pageinfo %}} -It helps in deploying applications using crd to help manage with installaztion, upgrades, downgrades, uninstallaztion. from one version to another and provide a single place of truth where to look for which applications are installed -{{% /pageinfo %}} - -## Types - -### Stack - -For defining a hetrogenous components we came up with a stack which contains `M` number of components which are different applications with their versions - - -{{% alert title="Info" color="info" %}} -this is current available on all clusters created by `ksctl@v1.2.0` -{{% /alert %}} - -{{% alert title="Note" color="info" %}} -It has a dependency on `ksctl agent` -{{% /alert %}} - -{{% alert title="About Lifecycle of application stack" color="info" %}} -once you have `kubectl apply` the stack it will start deploying the applications in the stack, if you want to upgrade the applications in the stack you can edit the stack and change the version of the application and apply the stack again, it will uninstall the previous version and install the new version. Basically it performs reinstall of the stack which might cause downtime -{{% /alert %}} - -### Supported Apps and CNI -| Name | Type | Category | Ksctl_Name | More Info | -|- | - | - | - | - | -| Argo-CD | standard | CI/CD | standard-argocd | [Link](#argo-cd) | -| Argo-Rollouts | standard | CI/CD | standard-argorollouts | [Link](#argo-rollouts) | -| Istio | standard | Service Mesh | standard-istio | [Link](#istio) | -| Cilium | standard | - | cilium | [Link](#cilium) | -| Flannel | standard | - | flannel | [Link](#flannel) | -| Kube-Prometheus | standard | Monitoring | standard-kubeprometheus | [Link](#kube-prometheus) | -| SpinKube | production | Wasm | production-spinkube | [Link](#spinkube) | -| WasmEdge and Wasmtime | production | Wasm | production-kwasm | [Link](#kwasm) | - - -{{% alert title="Note on wasm category apps" color="info" %}} -Only one of the app under the category `wasm` can be installed at a time we you might need to uninstall one to get another running - -also the current implementation of the wasm catorgoty apps annotate all the nodes with kwasm as true -{{% /alert %}} - - -{{% alert title="Components in Stack" color="info" %}} -All the stack are a collection of components so when you are overriding the stack values you need to tell which component it belongs to and then specifiy the value in a `map[string]any` format -{{% /alert %}} - -#### **Argo-CD** -**How to use it (Basic Usage)** - -```yaml -apiVersion: application.ksctl.com/v1alpha1 -kind: Stack -metadata: - name: argocd -spec: - stacks: - - stackId: standard-argocd - appType: app -``` - - -**Overrides available** - -```yaml -apiVersion: application.ksctl.com/v1alpha1 -kind: Stack -metadata: - name: argocd -spec: - stacks: - - stackId: standard-argocd - appType: app - overrides: - argocd: - version: <string> # version of the argocd - noUI: <bool> # to disable the UI - namespace: <string> # namespace to install argocd - namespaceInstall: <bool> # to install namespace specific argocd -``` - -#### **Argo-Rollouts** - -**How to use it (Basic Usage)** - -```yaml -apiVersion: application.ksctl.com/v1alpha1 -kind: Stack -metadata: - name: argorollouts -spec: - stacks: - - stackId: standard-argorollouts - appType: app -``` - -**Overrides available** - -```yaml -apiVersion: application.ksctl.com/v1alpha1 -kind: Stack -metadata: - name: argorollouts -spec: - stacks: - - stackId: standard-argorollouts - appType: app - overrides: - argorollouts: - version: <string> # version of the argorollouts - namespace: <string> # namespace to install argocd - namespaceInstall: <bool> # to install namespace specific argocd -``` - -#### **Istio** - -**How to use it (Basic Usage)** - -```yaml -apiVersion: application.ksctl.com/v1alpha1 -kind: Stack -metadata: - name: istio -spec: - stacks: - - stackId: standard-istio - appType: app -``` - -**Overrides available** - -```yaml -apiVersion: application.ksctl.com/v1alpha1 -kind: Stack -metadata: - name: istio -spec: - stacks: - - stackId: standard-istio - appType: app - overrides: - istio: - version: <string> # version of the istio - helmBaseChartOverridings: <map[string]any> # helm chart overridings, istio/base - helmIstiodChartOverridings: <map[string]any> # helm chart overridings, istio/istiod -``` - -#### **Cilium** - -Currently we cannot install via the ksctl crd as cni are needed to be installed when configuring otherwise it will cause network issues - -still we have cilium can be installed and only configuration available are `version`, we are working towards how can we allow users to specify the overridings in the cluster creation - -anyways here is how it is done - -> we can consider using a file spec instead of cmd parameter, until that is done you have to wait - -**How to use it (Basic Usage)** - -```yaml -apiVersion: application.ksctl.com/v1alpha1 -kind: Stack -metadata: - name: cilium -spec: - stacks: - - stackId: cilium - appType: app -``` - -**Overrides available** - -```yaml -apiVersion: application.ksctl.com/v1alpha1 -kind: Stack -metadata: - name: cilium -spec: - stacks: - - stackId: cilium - appType: app - overrides: - cilium: - version: <string> # version of the cilium - ciliumChartOverridings: <map[string]any> # helm chart overridings, cilium -``` - -#### **Flannel** - -Currently we cannot install via the ksctl crd as cni are needed to be installed when configuring otherwise it will cause network issues - -still we have flannel can be installed and only configuration available are `version`, we are working towards how can we allow users to specify the overridings in the cluster creation - -> we can consider using a file spec instead of cmd parameter, until that is done you have to wait - -**How to use it (Basic Usage)** - -```yaml -apiVersion: application.ksctl.com/v1alpha1 -kind: Stack -metadata: - name: flannel -spec: - stacks: - - stackId: flannel - appType: cni -``` - -**Overrides available** - -```yaml -apiVersion: application.ksctl.com/v1alpha1 -kind: Stack -metadata: - name: flannel -spec: - stacks: - - stackId: flannel - appType: cni - overrides: - flannel: - version: <string> # version of the flannel -``` - -#### **Kube-Prometheus** - -**How to use it (Basic Usage)** - -```yaml -apiVersion: application.ksctl.com/v1alpha1 -kind: Stack -metadata: - name: monitoring -spec: - stacks: - - stackId: standard-kubeprometheus - appType: app -``` - -**Overrides available** - -```yaml -apiVersion: application.ksctl.com/v1alpha1 -kind: Stack -metadata: - name: monitoring -spec: - stacks: - - stackId: standard-kubeprometheus - appType: app - overrides: - kube-prometheus: - version: <string> # version of the kube-prometheus - helmKubePromChartOverridings: <map[string]any> # helm chart overridings, kube-prometheus -``` - - -#### **SpinKube** - -**How to use it (Basic Usage)** - -```yaml -apiVersion: application.ksctl.com/v1alpha1 -kind: Stack -metadata: - name: wasm-spinkube -spec: - stacks: - - stackId: production-spinkube - appType: app -``` - -**Demo app** -```shell -kubectl apply -f https://raw.githubusercontent.com/spinkube/spin-operator/main/config/samples/simple.yaml -kubectl port-forward svc/simple-spinapp 8083:80 -curl localhost:8083/hello -``` - - -**Overrides available** -```yaml -apiVersion: application.ksctl.com/v1alpha1 -kind: Stack -metadata: - name: wasm-spinkube -spec: - stacks: - - stackId: production-wasmedge-kwasm - appType: app - overrides: - spinkube-operator: - version: <string> # version of the spinkube-operator-shim-executor are same for shim-execuator, runtime-class, shim-executor-crd, spinkube-operator - helmOperatorChartOverridings: <map[string]any> # helm chart overridings, spinkube-operator - - spinkube-operator-shim-executor: - version: <string> # version of the spinkube-operator-shim-executor are same for shim-execuator, runtime-class, shim-executor-crd, spinkube-operator - - spinkube-operator-runtime-class: - version: <string> # version of the spinkube-operator-shim-executor are same for shim-execuator, runtime-class, shim-executor-crd, spinkube-operator - - spinkube-operator-crd: - version: <string> # version of the spinkube-operator-shim-executor are same for shim-execuator, runtime-class, shim-executor-crd, spinkube-operator - - cert-manager: - version: <string> - certmanagerChartOverridings: <map[string]any> # helm chart overridings, cert-manager - - kwasm-operator: - version: <string> - kwasmOperatorChartOverridings: <map[string]any> # helm chart overridings, kwasm/kwasm-operator -``` - - -#### **Kwasm** - -**How to use it (Basic Usage)** - -```yaml -apiVersion: application.ksctl.com/v1alpha1 -kind: Stack -metadata: - name: wasm-kwasm -spec: - stacks: - - stackId: production-kwasm - appType: app -``` - -**Demo app(wasmedge)** -```yaml ---- -apiVersion: v1 -kind: Pod -metadata: - name: "myapp" - namespace: default - labels: - app: nice -spec: - runtimeClassName: wasmedge - containers: - - name: myapp - image: "docker.io/cr7258/wasm-demo-app:v1" - ports: - - containerPort: 8080 - name: http - restartPolicy: Always ---- -apiVersion: v1 -kind: Service -metadata: - name: nice -spec: - selector: - app: nice - type: ClusterIP - ports: - - name: nice - protocol: TCP - port: 8080 - targetPort: 8080 -``` - -**Demo app(wasmtime)** -```yaml -apiVersion: batch/v1 -kind: Job -metadata: - name: nice - namespace: default - labels: - app: nice -spec: - template: - metadata: - name: nice - labels: - app: nice - spec: - runtimeClassName: wasmtime - containers: - - name: nice - image: "meteatamel/hello-wasm:0.1" - restartPolicy: OnFailure -``` - -```shell -#### For wasmedge -# once up and running -kubectl port-forward svc/nice 8080:8080 - -# then you can curl the service -curl localhost:8080 -``` - -```shell -#### For wasmtime -# just check the logs -``` - -**Overrides available** -```yaml -apiVersion: application.ksctl.com/v1alpha1 -kind: Stack -metadata: - name: wasm-wasmedge -spec: - stacks: - - stackId: production-kwasm - appType: app - overrides: - kwasm-operator: - version: <string> - kwasmOperatorChartOverridings: <map[string]any> # helm chart overridings, kwasm/kwasm-operator -``` - -#### Example usage - -Lets deploy `argocd@v2.9.X`, `kube-prometheus-stack@v55.X.Y` -```yaml -apiVersion: application.ksctl.com/v1alpha1 -kind: Stack -metadata: - name: monitoring-plus-gitops -spec: - components: - - appName: standard-argocd - appType: app - version: v2.9.12 - - - appName: standard-kubeprometheus - appType: app - version: "55.0.0" -``` - -You can see once its deployed it fetch and deploys them - -Lets try to upgrade them to their latest versions -```bash -kubeclt edit stack monitoring-plus-gitops -``` - -```yaml -apiVersion: application.ksctl.com/v1alpha1 -kind: Stack -metadata: - name: monitoring-plus-gitops -spec: - components: - - appName: standard-argocd - appType: app - version: latest - - - appName: standard-kubeprometheus - appType: app - version: latest -``` - -once edited it will uninstall the previous install and reinstalls the latest deployments diff --git a/content/en/docs/stable/Ksctl Operators/stateimporter.md b/content/en/docs/stable/Ksctl Operators/stateimporter.md deleted file mode 100644 index 5175a53..0000000 --- a/content/en/docs/stable/Ksctl Operators/stateimporter.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Ksctl State-Importer -description: Documentation on ksctl stateimporter -categories: [Examples, Placeholders] -tags: [docs] ---- - -{{% pageinfo %}} -It is a helper deployment to transfer state information from one storage option to another. -{{% /pageinfo %}} - -It is used to transfer data in `~/.ksctl` location (provided the cluster is created via `storageProvider: store-local`). - - -It utilizes the these 2 methods: -- `Export`: [StorageFactory Interface](https://github.com/ksctl/ksctl/blob/d3c2d74fe03ab1e8ad48d45290662c878196889b/pkg/types/typesStorage.go#L34) -- `Import`: [StorageFactory Interface](https://github.com/ksctl/ksctl/blob/d3c2d74fe03ab1e8ad48d45290662c878196889b/pkg/types/typesStorage.go#L37) - -so before the ksctl agent is deployed we first create this pod which in turn runs a http server having `storageProvider: store-kubernetes` and uses `storage.Import()` method - -once we get 200 OK responses from the http server we remove the pod and move to ksctl agent deployment so that it can use the state file present in configmaps, secrets - -{{% alert title="Warning" color="warning" %}} -If the storageType is external (mongodb), we don't need this to be happening instead we create kubernetes secret where the external storage solution environment variable is set and also we need to customize the ksctl agent deployment -{{% /alert %}} \ No newline at end of file diff --git a/content/en/docs/stable/Kubernetes Distributions/_index.md b/content/en/docs/stable/Kubernetes Distributions/_index.md deleted file mode 100644 index df75c03..0000000 --- a/content/en/docs/stable/Kubernetes Distributions/_index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Kubernetes Distributions -description: Various Kubernetes Distributions -tags: [ha, core] -categories: [Kubernetes Provider] ---- - -{{% pageinfo %}} -**K3s** and **Kubeadm** only work for HA self-managed clusters -{{% /pageinfo %}} diff --git a/content/en/docs/stable/Kubernetes Distributions/k3s.md b/content/en/docs/stable/Kubernetes Distributions/k3s.md deleted file mode 100644 index d5aee76..0000000 --- a/content/en/docs/stable/Kubernetes Distributions/k3s.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: K3s -description: K3s Kubernetes Distributions -tags: [k3s, ha, core] -categories: [Kubernetes Provider] ---- - -{{% pageinfo %}} -K3s for HA Cluster on supported provider -{{% /pageinfo %}} - -K3s is used for self-managed clusters. Its a lightweight k8s distribution. -We are using it as follows: -* controlplane (k3s server) -* workerplane (k3s agent) -* datastore (etcd members) - -{{% alert color= "info" title="Info" %}} -Here the Default CNI is flannel -{{% /alert %}} - diff --git a/content/en/docs/stable/Kubernetes Distributions/kubeadm.md b/content/en/docs/stable/Kubernetes Distributions/kubeadm.md deleted file mode 100644 index f6b61fd..0000000 --- a/content/en/docs/stable/Kubernetes Distributions/kubeadm.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Kubeadm -description: Kubeadm Kubernetes Distributions -categories: [Kubernetes Provider] -tags: [Kubeadm, ha, core] ---- - -{{% pageinfo %}} -Kubeadm for HA Cluster on supported provider -{{% /pageinfo %}} - -Kubeadm support is added with etcd as datastore - -{{% alert color= "info" title="Info" %}} -Here the Default CNI is flannel -{{% /alert %}} diff --git a/content/en/docs/stable/Reference/_index.md b/content/en/docs/stable/Reference/_index.md deleted file mode 100644 index d28a268..0000000 --- a/content/en/docs/stable/Reference/_index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Reference -description: Low level reference docs for your project. -weight: 9 ---- - -{{% pageinfo %}} -The Below CLI Command Reference are mapped from `ksctl/cli` repo -{{% /pageinfo %}} - - -# CLI Command Reference - -Docs are available now in cli repo -Here are the links for the documentation files - -[CLI Root Command](ksctl.md) - -{{% alert title="Info" color="info" %}} -These cli commands are available with cli specific versions from ksctl@v1.2.0 onwards -[v1.2.0 cli references](https://github.com/ksctl/cli/tree/v1.2.0/gen/docs.md) -{{% /alert %}} diff --git a/content/en/docs/stable/Reference/ksctl.md b/content/en/docs/stable/Reference/ksctl.md deleted file mode 100644 index 2791497..0000000 --- a/content/en/docs/stable/Reference/ksctl.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: ksctl -description: Command documentation for ksctl ---- - -## ksctl - -CLI tool for managing multiple K8s clusters - -### Synopsis - -Ksctl ascii [logo] - -### Options - -``` - -h, --help help for ksctl - -t, --toggle Help message for toggle -``` - -### SEE ALSO - -* [ksctl connect-cluster](ksctl_connect-cluster.md) - Use to switch between clusters -* [ksctl create-cluster](ksctl_create-cluster.md) - Use to create a cluster -* [ksctl cred](ksctl_cred.md) - Login to your Cloud-provider Credentials -* [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster -* [ksctl get-clusters](ksctl_get-clusters.md) - Use to get clusters -* [ksctl info-cluster](ksctl_info-cluster.md) - Use to info cluster -* [ksctl self-update](ksctl_self-update.md) - update the ksctl cli -* [ksctl version](ksctl_version.md) - Print the version number of ksctl - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_connect-cluster.md b/content/en/docs/stable/Reference/ksctl_connect-cluster.md deleted file mode 100644 index a4efb92..0000000 --- a/content/en/docs/stable/Reference/ksctl_connect-cluster.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: ksctl_connect-cluster -description: Command documentation for ksctl_connect-cluster ---- - -## ksctl connect-cluster - -Use to switch between clusters - -### Synopsis - -Ksctl ascii [logo] - -``` -ksctl connect-cluster [flags] -``` - -### Examples - -``` - -ksctl connect-context --provider civo --name <clustername> --region <region> -ksctl connect --provider civo --name <clustername> --region <region> -ksctl switch --provider civo --name <clustername> --region <region> -ksctl connect --provider civo --name <clustername> --region <region> -ksctl connect-context --provider local --name <clustername> -ksctl connect-context --provider azure --name <clustername> --region <region> -ksctl connect-context --provider ha-civo --name <clustername> --region <region> -ksctl connect-context --provider ha-azure --name <clustername> --region <region> -ksctl connect-context --provider ha-aws --name <clustername> --region <region> -ksctl connect-context --provider aws --name <clustername> --region <region> - - For Storage specific - -ksctl connect-context -s store-local -p civo -n <clustername> -r <region> -ksctl connect-context -s external-store-mongodb -p civo -n <clustername> -r <region> - -``` - -### Options - -``` - --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] - -h, --help help for connect-cluster - -m, --mode string Mode of access can be shell or k9s or none - -n, --name string Cluster Name (default "demo") - -p, --provider string Provider - -r, --region string Region - -s, --storage string storage provider - -v, --verbose int for verbose output -``` - -### SEE ALSO - -* [ksctl](ksctl.md) - CLI tool for managing multiple K8s clusters - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_create-cluster.md b/content/en/docs/stable/Reference/ksctl_create-cluster.md deleted file mode 100644 index d27c405..0000000 --- a/content/en/docs/stable/Reference/ksctl_create-cluster.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ksctl_create-cluster -description: Command documentation for ksctl_create-cluster ---- - -## ksctl create-cluster - -Use to create a cluster - -### Synopsis - -Ksctl ascii [logo] - -### Examples - -``` - -ksctl create --help - -``` - -### Options - -``` - -h, --help help for create-cluster -``` - -### SEE ALSO - -* [ksctl](ksctl.md) - CLI tool for managing multiple K8s clusters -* [ksctl create-cluster aws](ksctl_create-cluster_aws.md) - Use to create a EKS cluster in Aws -* [ksctl create-cluster azure](ksctl_create-cluster_azure.md) - Use to create a AKS cluster in Azure -* [ksctl create-cluster civo](ksctl_create-cluster_civo.md) - Use to create a Civo managed k3s cluster -* [ksctl create-cluster ha-aws](ksctl_create-cluster_ha-aws.md) - Use to create a self-managed Highly Available cluster on AWS -* [ksctl create-cluster ha-azure](ksctl_create-cluster_ha-azure.md) - Use to create a self-managed Highly-Available cluster on Azure -* [ksctl create-cluster ha-civo](ksctl_create-cluster_ha-civo.md) - Use to create a self-managed Highly Available cluster on Civo -* [ksctl create-cluster local](ksctl_create-cluster_local.md) - Use to create a kind cluster - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_create-cluster_aws.md b/content/en/docs/stable/Reference/ksctl_create-cluster_aws.md deleted file mode 100644 index 6ece79f..0000000 --- a/content/en/docs/stable/Reference/ksctl_create-cluster_aws.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ksctl_create-cluster_aws -description: Command documentation for ksctl_create-cluster_aws ---- - -## ksctl create-cluster aws - -Use to create a EKS cluster in Aws - -### Synopsis - -Ksctl ascii [logo] - -``` -ksctl create-cluster aws [flags] -``` - -### Examples - -``` - -ksctl create-cluster aws -n demo -r ap-south-1 -s store-local --nodeSizeMP t2.micro --noMP 3 - -``` - -### Options - -``` - --bootstrap string Kubernetes Bootstrap - --cni string CNI - --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] - -h, --help help for aws - -n, --name string Cluster Name (default "demo") - --noMP int Number of Managed Nodes (default -1) - --nodeSizeMP string Node size of managed cluster nodes - -r, --region string Region - -s, --storage string storage provider - -v, --verbose int for verbose output - --version string Kubernetes Version - -y, --yes approval to avoid showMsg (default true) -``` - -### SEE ALSO - -* [ksctl create-cluster](ksctl_create-cluster.md) - Use to create a cluster - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_create-cluster_azure.md b/content/en/docs/stable/Reference/ksctl_create-cluster_azure.md deleted file mode 100644 index 364fc44..0000000 --- a/content/en/docs/stable/Reference/ksctl_create-cluster_azure.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ksctl_create-cluster_azure -description: Command documentation for ksctl_create-cluster_azure ---- - -## ksctl create-cluster azure - -Use to create a AKS cluster in Azure - -### Synopsis - -Ksctl ascii [logo] - -``` -ksctl create-cluster azure [flags] -``` - -### Examples - -``` - -ksctl create-cluster azure -n demo -r eastus -s store-local --nodeSizeMP Standard_DS2_v2 --noMP 3 - -``` - -### Options - -``` - --bootstrap string Kubernetes Bootstrap - --cni string CNI - --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] - -h, --help help for azure - -n, --name string Cluster Name (default "demo") - --noMP int Number of Managed Nodes (default -1) - --nodeSizeMP string Node size of managed cluster nodes - -r, --region string Region - -s, --storage string storage provider - -v, --verbose int for verbose output - --version string Kubernetes Version - -y, --yes approval to avoid showMsg (default true) -``` - -### SEE ALSO - -* [ksctl create-cluster](ksctl_create-cluster.md) - Use to create a cluster - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_create-cluster_civo.md b/content/en/docs/stable/Reference/ksctl_create-cluster_civo.md deleted file mode 100644 index d189d6b..0000000 --- a/content/en/docs/stable/Reference/ksctl_create-cluster_civo.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ksctl_create-cluster_civo -description: Command documentation for ksctl_create-cluster_civo ---- - -## ksctl create-cluster civo - -Use to create a Civo managed k3s cluster - -### Synopsis - -Ksctl ascii [logo] - -``` -ksctl create-cluster civo [flags] -``` - -### Examples - -``` - -ksctl create-cluster civo --name demo --region LON1 --storage store-local --nodeSizeMP g4s.kube.small --noMP 3 - -``` - -### Options - -``` - --bootstrap string Kubernetes Bootstrap - --cni string CNI - --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] - -h, --help help for civo - -n, --name string Cluster Name (default "demo") - --noMP int Number of Managed Nodes (default -1) - --nodeSizeMP string Node size of managed cluster nodes - -r, --region string Region - -s, --storage string storage provider - -v, --verbose int for verbose output - --version string Kubernetes Version - -y, --yes approval to avoid showMsg (default true) -``` - -### SEE ALSO - -* [ksctl create-cluster](ksctl_create-cluster.md) - Use to create a cluster - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_create-cluster_ha-aws.md b/content/en/docs/stable/Reference/ksctl_create-cluster_ha-aws.md deleted file mode 100644 index 4c18155..0000000 --- a/content/en/docs/stable/Reference/ksctl_create-cluster_ha-aws.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: ksctl_create-cluster_ha-aws -description: Command documentation for ksctl_create-cluster_ha-aws ---- - -## ksctl create-cluster ha-aws - -Use to create a self-managed Highly Available cluster on AWS - -### Synopsis - -Ksctl ascii [logo] - -``` -ksctl create-cluster ha-aws [flags] -``` - -### Examples - -``` - -ksctl create-cluster ha-aws -n demo -r us-east-1 --bootstrap k3s -s store-local --nodeSizeCP t2.medium --nodeSizeWP t2.medium --nodeSizeLB t2.micro --nodeSizeDS t2.small --noWP 1 --noCP 3 --noDS 3 --cni cilium@v1.16.1 - -``` - -### Options - -``` - --bootstrap string Kubernetes Bootstrap - --cni string CNI - --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] - -h, --help help for ha-aws - -n, --name string Cluster Name (default "demo") - --noCP int Number of ControlPlane Nodes (default -1) - --noDS int Number of DataStore Nodes (default -1) - --noWP int Number of WorkerPlane Nodes (default -1) - --nodeSizeCP string Node size of self-managed controlplane nodes - --nodeSizeDS string Node size of self-managed datastore nodes - --nodeSizeLB string Node size of self-managed loadbalancer node - --nodeSizeWP string Node size of self-managed workerplane nodes - -r, --region string Region - -s, --storage string storage provider - -v, --verbose int for verbose output - --version string Kubernetes Version - -y, --yes approval to avoid showMsg (default true) -``` - -### SEE ALSO - -* [ksctl create-cluster](ksctl_create-cluster.md) - Use to create a cluster -* [ksctl create-cluster ha-aws add-nodes](ksctl_create-cluster_ha-aws_add-nodes.md) - Use to add more worker nodes in self-managed Highly-Available cluster on Aws - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_create-cluster_ha-aws_add-nodes.md b/content/en/docs/stable/Reference/ksctl_create-cluster_ha-aws_add-nodes.md deleted file mode 100644 index 79a1d41..0000000 --- a/content/en/docs/stable/Reference/ksctl_create-cluster_ha-aws_add-nodes.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ksctl_create-cluster_ha-aws_add-nodes -description: Command documentation for ksctl_create-cluster_ha-aws_add-nodes ---- - -## ksctl create-cluster ha-aws add-nodes - -Use to add more worker nodes in self-managed Highly-Available cluster on Aws - -### Synopsis - -It is used to add nodes to worker nodes in cluster with the given name from user. - -``` -ksctl create-cluster ha-aws add-nodes [flags] -``` - -### Examples - -``` - -ksctl create ha-aws add-nodes -n demo -r ap-south-1 -s store-local --noWP 3 --nodeSizeWP t2.medium # Here the noWP is the desired count of workernodes - -``` - -### Options - -``` - -h, --help help for add-nodes - -n, --name string Cluster Name (default "demo") - --noWP int Number of WorkerPlane Nodes (default -1) - --nodeSizeWP string Node size of self-managed workerplane nodes - -r, --region string Region - -s, --storage string storage provider - -v, --verbose int for verbose output - -y, --yes approval to avoid showMsg (default true) -``` - -### SEE ALSO - -* [ksctl create-cluster ha-aws](ksctl_create-cluster_ha-aws.md) - Use to create a self-managed Highly Available cluster on AWS - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_create-cluster_ha-azure.md b/content/en/docs/stable/Reference/ksctl_create-cluster_ha-azure.md deleted file mode 100644 index 335bc50..0000000 --- a/content/en/docs/stable/Reference/ksctl_create-cluster_ha-azure.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: ksctl_create-cluster_ha-azure -description: Command documentation for ksctl_create-cluster_ha-azure ---- - -## ksctl create-cluster ha-azure - -Use to create a self-managed Highly-Available cluster on Azure - -### Synopsis - -Ksctl ascii [logo] - -``` -ksctl create-cluster ha-azure [flags] -``` - -### Examples - -``` - -ksctl create-cluster ha-azure --name demo --region eastus --bootstrap k3s --storage store-local --nodeSizeCP Standard_F2s --nodeSizeWP Standard_F2s --nodeSizeLB Standard_F2s --nodeSizeDS Standard_F2s --noWP 1 --noCP 3 --noDS 3 -ksctl create-cluster ha-azure --name demo --region eastus --bootstrap kubeadm --storage store-local --nodeSizeCP Standard_F2s --nodeSizeWP Standard_F4s --nodeSizeLB Standard_F2s --nodeSizeDS Standard_F2s --noWP 1 --noCP 3 --noDS 3 --cni cilium@v1.16.1 - -``` - -### Options - -``` - --bootstrap string Kubernetes Bootstrap - --cni string CNI - --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] - -h, --help help for ha-azure - -n, --name string Cluster Name (default "demo") - --noCP int Number of ControlPlane Nodes (default -1) - --noDS int Number of DataStore Nodes (default -1) - --noWP int Number of WorkerPlane Nodes (default -1) - --nodeSizeCP string Node size of self-managed controlplane nodes - --nodeSizeDS string Node size of self-managed datastore nodes - --nodeSizeLB string Node size of self-managed loadbalancer node - --nodeSizeWP string Node size of self-managed workerplane nodes - -r, --region string Region - -s, --storage string storage provider - -v, --verbose int for verbose output - --version string Kubernetes Version - -y, --yes approval to avoid showMsg (default true) -``` - -### SEE ALSO - -* [ksctl create-cluster](ksctl_create-cluster.md) - Use to create a cluster -* [ksctl create-cluster ha-azure add-nodes](ksctl_create-cluster_ha-azure_add-nodes.md) - Use to add more worker nodes in self-managed Highly-Available cluster on Azure - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_create-cluster_ha-azure_add-nodes.md b/content/en/docs/stable/Reference/ksctl_create-cluster_ha-azure_add-nodes.md deleted file mode 100644 index ab3f539..0000000 --- a/content/en/docs/stable/Reference/ksctl_create-cluster_ha-azure_add-nodes.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ksctl_create-cluster_ha-azure_add-nodes -description: Command documentation for ksctl_create-cluster_ha-azure_add-nodes ---- - -## ksctl create-cluster ha-azure add-nodes - -Use to add more worker nodes in self-managed Highly-Available cluster on Azure - -### Synopsis - -It is used to add nodes to worker nodes in cluster with the given name from user - -``` -ksctl create-cluster ha-azure add-nodes [flags] -``` - -### Examples - -``` - -ksctl create ha-azure add-nodes -n demo -r eastus -s store-local --noWP 3 --nodeSizeWP Standard_F2s # Here the noWP is the desired count of workernodes - -``` - -### Options - -``` - --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] - -h, --help help for add-nodes - -n, --name string Cluster Name (default "demo") - --noWP int Number of WorkerPlane Nodes (default -1) - --nodeSizeWP string Node size of self-managed workerplane nodes - -r, --region string Region - -s, --storage string storage provider - -v, --verbose int for verbose output - -y, --yes approval to avoid showMsg (default true) -``` - -### SEE ALSO - -* [ksctl create-cluster ha-azure](ksctl_create-cluster_ha-azure.md) - Use to create a self-managed Highly-Available cluster on Azure - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_create-cluster_ha-civo.md b/content/en/docs/stable/Reference/ksctl_create-cluster_ha-civo.md deleted file mode 100644 index 1b77b55..0000000 --- a/content/en/docs/stable/Reference/ksctl_create-cluster_ha-civo.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: ksctl_create-cluster_ha-civo -description: Command documentation for ksctl_create-cluster_ha-civo ---- - -## ksctl create-cluster ha-civo - -Use to create a self-managed Highly Available cluster on Civo - -### Synopsis - -Ksctl ascii [logo] - -``` -ksctl create-cluster ha-civo [flags] -``` - -### Examples - -``` - -ksctl create-cluster ha-civo --name demo --region LON1 --bootstrap k3s --storage store-local --nodeSizeCP g3.small --nodeSizeWP g3.medium --nodeSizeLB g3.small --nodeSizeDS g3.small --noWP 1 --noCP 3 --noDS 3 -ksctl create-cluster ha-civo --name demo --region LON1 --bootstrap kubeadm --storage store-local --nodeSizeCP g3.medium --nodeSizeWP g3.large --nodeSizeLB g3.small --nodeSizeDS g3.small --noWP 1 --noCP 3 --noDS 3 --cni cilium@v1.16.1 - -``` - -### Options - -``` - --bootstrap string Kubernetes Bootstrap - --cni string CNI - --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] - -h, --help help for ha-civo - -n, --name string Cluster Name (default "demo") - --noCP int Number of ControlPlane Nodes (default -1) - --noDS int Number of DataStore Nodes (default -1) - --noWP int Number of WorkerPlane Nodes (default -1) - --nodeSizeCP string Node size of self-managed controlplane nodes - --nodeSizeDS string Node size of self-managed datastore nodes - --nodeSizeLB string Node size of self-managed loadbalancer node - --nodeSizeWP string Node size of self-managed workerplane nodes - -r, --region string Region - -s, --storage string storage provider - -v, --verbose int for verbose output - --version string Kubernetes Version - -y, --yes approval to avoid showMsg (default true) -``` - -### SEE ALSO - -* [ksctl create-cluster](ksctl_create-cluster.md) - Use to create a cluster -* [ksctl create-cluster ha-civo add-nodes](ksctl_create-cluster_ha-civo_add-nodes.md) - Use to add more worker nodes in self-managed Highly-Available cluster on Civo - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_create-cluster_ha-civo_add-nodes.md b/content/en/docs/stable/Reference/ksctl_create-cluster_ha-civo_add-nodes.md deleted file mode 100644 index be44989..0000000 --- a/content/en/docs/stable/Reference/ksctl_create-cluster_ha-civo_add-nodes.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ksctl_create-cluster_ha-civo_add-nodes -description: Command documentation for ksctl_create-cluster_ha-civo_add-nodes ---- - -## ksctl create-cluster ha-civo add-nodes - -Use to add more worker nodes in self-managed Highly-Available cluster on Civo - -### Synopsis - -It is used to add nodes to worker nodes in cluster with the given name from user. - -``` -ksctl create-cluster ha-civo add-nodes [flags] -``` - -### Examples - -``` - -ksctl create ha-civo add-nodes -n demo -r LON1 -s store-local --noWP 3 --nodeSizeWP g3.medium # Here the noWP is the desired count of workernodes - -``` - -### Options - -``` - --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] - -h, --help help for add-nodes - -n, --name string Cluster Name (default "demo") - --noWP int Number of WorkerPlane Nodes (default -1) - --nodeSizeWP string Node size of self-managed workerplane nodes - -r, --region string Region - -s, --storage string storage provider - -v, --verbose int for verbose output - -y, --yes approval to avoid showMsg (default true) -``` - -### SEE ALSO - -* [ksctl create-cluster ha-civo](ksctl_create-cluster_ha-civo.md) - Use to create a self-managed Highly Available cluster on Civo - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_create-cluster_local.md b/content/en/docs/stable/Reference/ksctl_create-cluster_local.md deleted file mode 100644 index 8a544cf..0000000 --- a/content/en/docs/stable/Reference/ksctl_create-cluster_local.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ksctl_create-cluster_local -description: Command documentation for ksctl_create-cluster_local ---- - -## ksctl create-cluster local - -Use to create a kind cluster - -### Synopsis - -Ksctl ascii [logo] - -``` -ksctl create-cluster local [flags] -``` - -### Examples - -``` - -ksctl create-cluster local --name demo --storage store-local --noMP 3 - -``` - -### Options - -``` - --bootstrap string Kubernetes Bootstrap - --cni string CNI - --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] - -h, --help help for local - -n, --name string Cluster Name (default "demo") - --noMP int Number of Managed Nodes (default -1) - -s, --storage string storage provider - -v, --verbose int for verbose output - --version string Kubernetes Version - -y, --yes approval to avoid showMsg (default true) -``` - -### SEE ALSO - -* [ksctl create-cluster](ksctl_create-cluster.md) - Use to create a cluster - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_cred.md b/content/en/docs/stable/Reference/ksctl_cred.md deleted file mode 100644 index 461a52c..0000000 --- a/content/en/docs/stable/Reference/ksctl_cred.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: ksctl_cred -description: Command documentation for ksctl_cred ---- - -## ksctl cred - -Login to your Cloud-provider Credentials - -### Synopsis - -Ksctl ascii [logo] - -``` -ksctl cred [flags] -``` - -### Options - -``` - -h, --help help for cred - -s, --storage string storage provider - -v, --verbose for verbose output (default true) -``` - -### SEE ALSO - -* [ksctl](ksctl.md) - CLI tool for managing multiple K8s clusters - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_delete-cluster.md b/content/en/docs/stable/Reference/ksctl_delete-cluster.md deleted file mode 100644 index bf2ec15..0000000 --- a/content/en/docs/stable/Reference/ksctl_delete-cluster.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ksctl_delete-cluster -description: Command documentation for ksctl_delete-cluster ---- - -## ksctl delete-cluster - -Use to delete a cluster - -### Synopsis - -Ksctl ascii [logo] - -### Examples - -``` - -ksctl delete --help - -``` - -### Options - -``` - -h, --help help for delete-cluster -``` - -### SEE ALSO - -* [ksctl](ksctl.md) - CLI tool for managing multiple K8s clusters -* [ksctl delete-cluster aws](ksctl_delete-cluster_aws.md) - Use to deletes a EKS cluster -* [ksctl delete-cluster azure](ksctl_delete-cluster_azure.md) - Use to deletes a AKS cluster -* [ksctl delete-cluster civo](ksctl_delete-cluster_civo.md) - Use to delete a Civo managed k3s cluster -* [ksctl delete-cluster ha-aws](ksctl_delete-cluster_ha-aws.md) - Use to delete a self-managed Highly Available cluster on AWS -* [ksctl delete-cluster ha-azure](ksctl_delete-cluster_ha-azure.md) - Use to delete a self-managed Highly Available cluster on Azure -* [ksctl delete-cluster ha-civo](ksctl_delete-cluster_ha-civo.md) - Use to delete a self-managed Highly Available cluster on Civo -* [ksctl delete-cluster local](ksctl_delete-cluster_local.md) - Use to delete a kind cluster - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_delete-cluster_aws.md b/content/en/docs/stable/Reference/ksctl_delete-cluster_aws.md deleted file mode 100644 index d369478..0000000 --- a/content/en/docs/stable/Reference/ksctl_delete-cluster_aws.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ksctl_delete-cluster_aws -description: Command documentation for ksctl_delete-cluster_aws ---- - -## ksctl delete-cluster aws - -Use to deletes a EKS cluster - -### Synopsis - -Ksctl ascii [logo] - -``` -ksctl delete-cluster aws [flags] -``` - -### Examples - -``` - -ksctl delete aws --name demo --region ap-south-1 --storage store-local - -``` - -### Options - -``` - -h, --help help for aws - -n, --name string Cluster Name (default "demo") - -r, --region string Region - -s, --storage string storage provider - -v, --verbose int for verbose output - -y, --yes approval to avoid showMsg (default true) -``` - -### SEE ALSO - -* [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_delete-cluster_azure.md b/content/en/docs/stable/Reference/ksctl_delete-cluster_azure.md deleted file mode 100644 index e2fda62..0000000 --- a/content/en/docs/stable/Reference/ksctl_delete-cluster_azure.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ksctl_delete-cluster_azure -description: Command documentation for ksctl_delete-cluster_azure ---- - -## ksctl delete-cluster azure - -Use to deletes a AKS cluster - -### Synopsis - -Ksctl ascii [logo] - -``` -ksctl delete-cluster azure [flags] -``` - -### Examples - -``` - -ksctl delete azure --name demo --region eastus --storage store-local - -``` - -### Options - -``` - --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] - -h, --help help for azure - -n, --name string Cluster Name (default "demo") - -r, --region string Region - -s, --storage string storage provider - -v, --verbose int for verbose output - -y, --yes approval to avoid showMsg (default true) -``` - -### SEE ALSO - -* [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_delete-cluster_civo.md b/content/en/docs/stable/Reference/ksctl_delete-cluster_civo.md deleted file mode 100644 index bddfbc7..0000000 --- a/content/en/docs/stable/Reference/ksctl_delete-cluster_civo.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ksctl_delete-cluster_civo -description: Command documentation for ksctl_delete-cluster_civo ---- - -## ksctl delete-cluster civo - -Use to delete a Civo managed k3s cluster - -### Synopsis - -Ksctl ascii [logo] - -``` -ksctl delete-cluster civo [flags] -``` - -### Examples - -``` - -ksctl delete civo --name demo --region LON1 --storage store-local - -``` - -### Options - -``` - --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] - -h, --help help for civo - -n, --name string Cluster Name (default "demo") - -r, --region string Region - -s, --storage string storage provider - -v, --verbose int for verbose output - -y, --yes approval to avoid showMsg (default true) -``` - -### SEE ALSO - -* [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-aws.md b/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-aws.md deleted file mode 100644 index db9b63f..0000000 --- a/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-aws.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ksctl_delete-cluster_ha-aws -description: Command documentation for ksctl_delete-cluster_ha-aws ---- - -## ksctl delete-cluster ha-aws - -Use to delete a self-managed Highly Available cluster on AWS - -### Synopsis - -Ksctl ascii [logo] - -``` -ksctl delete-cluster ha-aws [flags] -``` - -### Examples - -``` - -ksctl delete ha-aws --name demo --region us-east-1 --storage store-local - -``` - -### Options - -``` - --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] - -h, --help help for ha-aws - -n, --name string Cluster Name (default "demo") - -r, --region string Region - -s, --storage string storage provider - -v, --verbose int for verbose output - -y, --yes approval to avoid showMsg (default true) -``` - -### SEE ALSO - -* [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster -* [ksctl delete-cluster ha-aws del-nodes](ksctl_delete-cluster_ha-aws_del-nodes.md) - Use to remove worker nodes in self-managed Highly-Available cluster on Aws - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-aws_del-nodes.md b/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-aws_del-nodes.md deleted file mode 100644 index 63c1d0b..0000000 --- a/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-aws_del-nodes.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ksctl_delete-cluster_ha-aws_del-nodes -description: Command documentation for ksctl_delete-cluster_ha-aws_del-nodes ---- - -## ksctl delete-cluster ha-aws del-nodes - -Use to remove worker nodes in self-managed Highly-Available cluster on Aws - -### Synopsis - -It is used to delete cluster with the given name from user - -``` -ksctl delete-cluster ha-aws del-nodes [flags] -``` - -### Examples - -``` - -ksctl delete ha-aws del-nodes -n demo -r us-east-1 -s store-local --noWP 1 # Here the noWP is the desired count of workernodes - -``` - -### Options - -``` - -h, --help help for del-nodes - -n, --name string Cluster Name (default "demo") - --noWP int Number of WorkerPlane Nodes (default -1) - -r, --region string Region - -s, --storage string storage provider - -v, --verbose int for verbose output - -y, --yes approval to avoid showMsg (default true) -``` - -### SEE ALSO - -* [ksctl delete-cluster ha-aws](ksctl_delete-cluster_ha-aws.md) - Use to delete a self-managed Highly Available cluster on AWS - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-azure.md b/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-azure.md deleted file mode 100644 index 8e355cb..0000000 --- a/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-azure.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ksctl_delete-cluster_ha-azure -description: Command documentation for ksctl_delete-cluster_ha-azure ---- - -## ksctl delete-cluster ha-azure - -Use to delete a self-managed Highly Available cluster on Azure - -### Synopsis - -Ksctl ascii [logo] - -``` -ksctl delete-cluster ha-azure [flags] -``` - -### Examples - -``` - -ksctl delete ha-azure --name demo --region eastus --storage store-local - -``` - -### Options - -``` - --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] - -h, --help help for ha-azure - -n, --name string Cluster Name (default "demo") - -r, --region string Region - -s, --storage string storage provider - -v, --verbose int for verbose output - -y, --yes approval to avoid showMsg (default true) -``` - -### SEE ALSO - -* [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster -* [ksctl delete-cluster ha-azure del-nodes](ksctl_delete-cluster_ha-azure_del-nodes.md) - Use to remove worker nodes in self-managed Highly-Available cluster on Azure - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-azure_del-nodes.md b/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-azure_del-nodes.md deleted file mode 100644 index 50becab..0000000 --- a/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-azure_del-nodes.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ksctl_delete-cluster_ha-azure_del-nodes -description: Command documentation for ksctl_delete-cluster_ha-azure_del-nodes ---- - -## ksctl delete-cluster ha-azure del-nodes - -Use to remove worker nodes in self-managed Highly-Available cluster on Azure - -### Synopsis - -It is used to delete cluster with the given name from user - -``` -ksctl delete-cluster ha-azure del-nodes [flags] -``` - -### Examples - -``` - -ksctl delete ha-azure del-nodes -n demo -r eastus -s store-local --noWP 1 # Here the noWP is the desired count of workernodes - -``` - -### Options - -``` - --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] - -h, --help help for del-nodes - -n, --name string Cluster Name (default "demo") - --noWP int Number of WorkerPlane Nodes (default -1) - -r, --region string Region - -s, --storage string storage provider - -v, --verbose int for verbose output - -y, --yes approval to avoid showMsg (default true) -``` - -### SEE ALSO - -* [ksctl delete-cluster ha-azure](ksctl_delete-cluster_ha-azure.md) - Use to delete a self-managed Highly Available cluster on Azure - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-civo.md b/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-civo.md deleted file mode 100644 index 94ec127..0000000 --- a/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-civo.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ksctl_delete-cluster_ha-civo -description: Command documentation for ksctl_delete-cluster_ha-civo ---- - -## ksctl delete-cluster ha-civo - -Use to delete a self-managed Highly Available cluster on Civo - -### Synopsis - -Ksctl ascii [logo] - -``` -ksctl delete-cluster ha-civo [flags] -``` - -### Examples - -``` - -ksctl delete ha-civo --name demo --region LON1 --storage store-local - -``` - -### Options - -``` - --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] - -h, --help help for ha-civo - -n, --name string Cluster Name (default "demo") - -r, --region string Region - -s, --storage string storage provider - -v, --verbose int for verbose output - -y, --yes approval to avoid showMsg (default true) -``` - -### SEE ALSO - -* [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster -* [ksctl delete-cluster ha-civo del-nodes](ksctl_delete-cluster_ha-civo_del-nodes.md) - Use to remove worker nodes in self-managed Highly-Available cluster on Civo - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-civo_del-nodes.md b/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-civo_del-nodes.md deleted file mode 100644 index db0a5ed..0000000 --- a/content/en/docs/stable/Reference/ksctl_delete-cluster_ha-civo_del-nodes.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ksctl_delete-cluster_ha-civo_del-nodes -description: Command documentation for ksctl_delete-cluster_ha-civo_del-nodes ---- - -## ksctl delete-cluster ha-civo del-nodes - -Use to remove worker nodes in self-managed Highly-Available cluster on Civo - -### Synopsis - -It is used to delete cluster with the given name from user - -``` -ksctl delete-cluster ha-civo del-nodes [flags] -``` - -### Examples - -``` - -ksctl delete ha-civo del-nodes -n demo -r LON1 -s store-local --noWP 1 # Here the noWP is the desired count of workernodes - -``` - -### Options - -``` - --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] - -h, --help help for del-nodes - -n, --name string Cluster Name (default "demo") - --noWP int Number of WorkerPlane Nodes (default -1) - -r, --region string Region - -s, --storage string storage provider - -v, --verbose int for verbose output - -y, --yes approval to avoid showMsg (default true) -``` - -### SEE ALSO - -* [ksctl delete-cluster ha-civo](ksctl_delete-cluster_ha-civo.md) - Use to delete a self-managed Highly Available cluster on Civo - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_delete-cluster_local.md b/content/en/docs/stable/Reference/ksctl_delete-cluster_local.md deleted file mode 100644 index 657ea3e..0000000 --- a/content/en/docs/stable/Reference/ksctl_delete-cluster_local.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ksctl_delete-cluster_local -description: Command documentation for ksctl_delete-cluster_local ---- - -## ksctl delete-cluster local - -Use to delete a kind cluster - -### Synopsis - -Ksctl ascii [logo] - -``` -ksctl delete-cluster local [flags] -``` - -### Examples - -``` - -ksctl delete local --name demo --storage store-local - -``` - -### Options - -``` - --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] - -h, --help help for local - -n, --name string Cluster Name (default "demo") - -s, --storage string storage provider - -v, --verbose int for verbose output - -y, --yes approval to avoid showMsg (default true) -``` - -### SEE ALSO - -* [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_get-clusters.md b/content/en/docs/stable/Reference/ksctl_get-clusters.md deleted file mode 100644 index aef3641..0000000 --- a/content/en/docs/stable/Reference/ksctl_get-clusters.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ksctl_get-clusters -description: Command documentation for ksctl_get-clusters ---- - -## ksctl get-clusters - -Use to get clusters - -### Synopsis - -Ksctl ascii [logo] - -``` -ksctl get-clusters [flags] -``` - -### Examples - -``` - -ksctl get --provider all --storage store-local - -``` - -### Options - -``` - --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] - -h, --help help for get-clusters - -p, --provider string Provider - -s, --storage string storage provider - -v, --verbose int for verbose output -``` - -### SEE ALSO - -* [ksctl](ksctl.md) - CLI tool for managing multiple K8s clusters - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_info-cluster.md b/content/en/docs/stable/Reference/ksctl_info-cluster.md deleted file mode 100644 index 9c57de7..0000000 --- a/content/en/docs/stable/Reference/ksctl_info-cluster.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ksctl_info-cluster -description: Command documentation for ksctl_info-cluster ---- - -## ksctl info-cluster - -Use to info cluster - -### Synopsis - -Ksctl ascii [logo] - -``` -ksctl info-cluster [flags] -``` - -### Examples - -``` - -ksctl info --provider azure --name demo --region eastus --storage store-local -ksctl info -p ha-azure -n ha-demo-kubeadm -r eastus -s store-local --verbose -1 - -``` - -### Options - -``` - --feature-flags string Experimental Features: Supported values with comma seperated: [autoscale] - -h, --help help for info-cluster - -n, --name string Cluster Name (default "demo") - -p, --provider string Provider - -r, --region string Region - -s, --storage string storage provider - -v, --verbose int for verbose output -``` - -### SEE ALSO - -* [ksctl](ksctl.md) - CLI tool for managing multiple K8s clusters - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_self-update.md b/content/en/docs/stable/Reference/ksctl_self-update.md deleted file mode 100644 index 34b4cf4..0000000 --- a/content/en/docs/stable/Reference/ksctl_self-update.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: ksctl_self-update -description: Command documentation for ksctl_self-update ---- - -## ksctl self-update - -update the ksctl cli - -### Synopsis - -Ksctl ascii [logo] - -``` -ksctl self-update [flags] -``` - -### Options - -``` - -h, --help help for self-update - -s, --storage string storage provider - -v, --verbose for verbose output (default true) -``` - -### SEE ALSO - -* [ksctl](ksctl.md) - CLI tool for managing multiple K8s clusters - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Reference/ksctl_version.md b/content/en/docs/stable/Reference/ksctl_version.md deleted file mode 100644 index 965dee4..0000000 --- a/content/en/docs/stable/Reference/ksctl_version.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: ksctl_version -description: Command documentation for ksctl_version ---- - -## ksctl version - -Print the version number of ksctl - -``` -ksctl version [flags] -``` - -### Options - -``` - -h, --help help for version -``` - -### SEE ALSO - -* [ksctl](ksctl.md) - CLI tool for managing multiple K8s clusters - -###### Auto generated by spf13/cobra on 1-Dec-2024 diff --git a/content/en/docs/stable/Storage/_index.md b/content/en/docs/stable/Storage/_index.md deleted file mode 100644 index f97b240..0000000 --- a/content/en/docs/stable/Storage/_index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Storage -description: What does your user need to know to try your project? -categories: [Storage Provider] -tags: [storage, core] ---- - - -{{% pageinfo %}} -storage providers -{{% /pageinfo %}} diff --git a/content/en/docs/stable/Storage/external.md b/content/en/docs/stable/Storage/external.md deleted file mode 100644 index e98c4d6..0000000 --- a/content/en/docs/stable/Storage/external.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: External Storage -categories: [Storage Provider] -description: What does your user need to know to try your project? -tags: [storage, core] ---- - -{{% pageinfo %}} -External MongoDB as a Storage provider -{{% /pageinfo %}} - -Refer : `internal/storage/external/mongodb` - -## Data to store and filtering it performs -1. first it gets the cluster data / credentials data based on this filters - - `cluster_name` (for cluster) - - `region` (for cluster) - - `cloud_provider` (for cluster & credentials) - - `cluster_type` (for cluster) - - also when the state of the cluster has recieved the stable desired state mark the IsCompleted flag in the specific cloud_provider struct to indicate its done -2. make sure the above things are specified before writing in the storage - -## How to use it -1. you need to call the Init function to get the storage make sure you have the interface type variable as the caller -2. before performing any operations you must call the **Connect()**. -3. for using methods: **Read()**, **Write()**, **Delete()** make sure you have called the **Setup()** -4. for calling **ReadCredentials()**, **WriteCredentials()** you can use it directly just need to specify the cloud provider you want to write -5. for calling **GetOneOrMoreClusters()** you need simply specify the filter -6. for calling **AlreadyCreated()** you just have to specify the func args -7. Don't forget to call the **storage.Kill()** when you want to stop the complte execution. it guarantees that it will wait till all the pending operations on the storage are completed -8. Custom Storage Directory you would need to specify the env var `KSCTL_CUSTOM_DIR_ENABLED` the value must be directory names wit space separated -9. specify the **Required ENV vars** - - `export MONGODB_URI=""` - > Hint: mongodb://${username}:${password}@${domain}:${port} or mongo+atlas mongodb+srv://${username}:${password}@${domain} - -## Things to look for -1. make sure when you recieve return data from **Read()**. copy the address value to the storage pointer variable and not the address! -2. When any credentials are written, it will be stored in - - Database: `ksctl-{userid}-db` - - Collection: `{cloud_provider}` - - Document/Record: `raw bson data` with above specified data and filter fields -3. When any clusterState is written, it gets stored in - - Database: `ksctl-{userid}-db` - - Collection: `credentials` - - Document/Record: `raw bson data` with above specified data and filter fields - -4. When you do Switch aka getKubeconfig it fetches the kubeconfig from the point 3 and stores it to `<some_dir>/.ksctl/kubeconfig` - diff --git a/content/en/docs/stable/Storage/local.md b/content/en/docs/stable/Storage/local.md deleted file mode 100644 index e305c73..0000000 --- a/content/en/docs/stable/Storage/local.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Local Storage -description: What does your user need to know to try your project? -categories: [Storage Provider] -tags: [storage, core] ---- - -{{% pageinfo %}} -Local as a Storage Provider -{{% /pageinfo %}} - -Refer: `internal/storage/local` - -## Data to store and filtering it performs -1. first it gets the cluster data / credentials data based on this filters - - `cluster_name` (for cluster) - - `region` (for cluster) - - `cloud_provider` (for cluster & credentials) - - `cluster_type` (for cluster) - - also when the state of the cluster has recieved the stable desired state mark the IsCompleted flag in the specific cloud_provider struct to indicate its done -2. make sure the above things are specified before writing in the storage - -it is stored something like this -``` - it will use almost the same construct. - * ClusterInfos => $USER_HOME/.ksctl/state/ - |-- {cloud_provider} - |-- {cluster_type} aka (ha, managed) - |-- "{cluster_name} {region}" - |-- state.json - * CredentialInfo => $USER_HOME/.ksctl/credentials/{cloud_provider}.json -``` - -## How to use it -1. you need to call the Init function to get the storage make sure you have the interface type variable as the caller -2. before performing any operations you must call the **Connect()**. -3. for using methods: **Read()**, **Write()**, **Delete()** make sure you have called the **Setup()** -4. for calling **ReadCredentials()**, **WriteCredentials()** you can use it directly just need to specify the cloud provider you want to write -5. for calling **GetOneOrMoreClusters()** you need simply specify the filter -6. for calling **AlreadyCreated()** you just have to specify the func args -7. Don't forget to call the **storage.Kill()** when you want to stop the complte execution. it guarantees that it will wait till all the pending operations on the storage are completed -8. Custom Storage Directory you would need to specify the env var `KSCTL_CUSTOM_DIR_ENABLED` the value must be directory names wit space separated -9. it creates the configuration directories on your behalf - -## Things to look for -1. make sure when you receive return data from **Read()**. copy the address value to the storage pointer variable and not the address! -2. When any credentials are written, it will be stored in `<some_dir>/.ksctl/credentials/{cloud_provider}.json` -3. When any clusterState is written, it gets stored in `<some_dir>/.ksctl/state/{cloud_provider}/{cluster_type}/{cluster_name} {region}/state.json` -4. When you do Switch aka getKubeconfig it fetches the kubeconfig from the point 3 and stores it to `<some_dir>/.ksctl/kubeconfig` diff --git a/content/en/docs/stable/_index.md b/content/en/docs/stable/_index.md deleted file mode 100644 index eca87f1..0000000 --- a/content/en/docs/stable/_index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Stable Documentation -linkTitle: Stable -description: stable branch documentation -weight: 20 ---- - -{{% pageinfo %}} -This is the `latest` branch documentation -{{% /pageinfo %}} diff --git a/content/en/docs/stable/architecture/_index.md b/content/en/docs/stable/architecture/_index.md deleted file mode 100644 index 4626c57..0000000 --- a/content/en/docs/stable/architecture/_index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Architecture -description: Overall architecture of Ksctl -categories: [Examples, Placeholders] -tags: [test, docs] -weight: 2 ---- - -{{% pageinfo %}} -Architecture diagrams -{{% /pageinfo %}} diff --git a/content/en/docs/stable/architecture/api-components.md b/content/en/docs/stable/architecture/api-components.md deleted file mode 100644 index f6c50fa..0000000 --- a/content/en/docs/stable/architecture/api-components.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Api Components -description: Learn how different components communicate with each other via API's and automation scripts to serve you in best way possible. -categories: [Examples, Placeholders] -tags: [test, docs] -weight: 2 ---- - - -{{% pageinfo %}} -Core Design Components -{{% /pageinfo %}} - -## Design - -### Overview architecture of ksctl -![light mode](/img/ksctl-arch.svg) - -### Managed Cluster creation & deletion -![light mode](/img/ksctl-managed-sequence.svg) - -### High Available Cluster creation & deletion -![light mode](/img/ksctl-ha-sequence.svg) diff --git a/netlify.toml b/netlify.toml index 47454e3..715f94a 100644 --- a/netlify.toml +++ b/netlify.toml @@ -11,7 +11,7 @@ [context.production.environment] HUGO_ENVIRONMENT = "production" GO_VERSION = "1.23" - HUGO_BASEURL = "https://docs.ksctl.com/" + HUGO_BASEURL = "https://docs.dev.ksctl.com/" HUGO_ENV = "production" HUGO_ENABLEGITINFO = "true" From 44bdd63cac5144bda292e02bb2f0b57698086d39 Mon Sep 17 00:00:00 2001 From: Dipankar Das <65275144+dipankardas011@users.noreply.github.com> Date: Mon, 2 Dec 2024 12:32:56 +0530 Subject: [PATCH 3/5] updated the hugo config Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com> --- content/en/_index.md | 2 +- hugo.toml | 8 ++++---- netlify.toml | 3 +-- 3 files changed, 6 insertions(+), 7 deletions(-) diff --git a/content/en/_index.md b/content/en/_index.md index 4e36d7c..9083971 100644 --- a/content/en/_index.md +++ b/content/en/_index.md @@ -2,7 +2,7 @@ title: Ksctl Docs --- -{{< blocks/cover title="Welcome to Ksctl Documentation(dev)!" image_anchor="top" height="full" >}} +{{< blocks/cover title="Welcome to Ksctl Documentation!" image_anchor="top" height="full" >}} ![Propsal design](/img/ksctl-logo.svg) diff --git a/hugo.toml b/hugo.toml index d1d60a0..5db4ebf 100644 --- a/hugo.toml +++ b/hugo.toml @@ -85,12 +85,12 @@ description = "A Ksctl Docs page" section = ["HTML", "print", "RSS"] [[params.versions]] - version = "master" - url = "/docs/develop" + version = "dev" + url = "https://docs.dev.ksctl.com" [[params.versions]] version = "stable" - url = "/docs/stable" + url = "https://docs.ksctl.com" [params] @@ -127,7 +127,7 @@ github_repo = "https://github.com/ksctl/docs" # Uncomment this if your GitHub repo does not have "main" as the default branch, # or specify a new value if you want to reference another branch in your GitHub links -github_branch= "main" +github_branch= "dev" # Enable Algolia DocSearch # algolia_docsearch = false diff --git a/netlify.toml b/netlify.toml index 715f94a..3b2728a 100644 --- a/netlify.toml +++ b/netlify.toml @@ -9,10 +9,9 @@ # Set environment variables [context.production.environment] - HUGO_ENVIRONMENT = "production" + HUGO_ENVIRONMENT = "development" GO_VERSION = "1.23" HUGO_BASEURL = "https://docs.dev.ksctl.com/" - HUGO_ENV = "production" HUGO_ENABLEGITINFO = "true" [[headers]] From 74eb78488392d7f02de16b5954598812b29b0fa2 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <github-actions@github.com> Date: Mon, 2 Dec 2024 07:10:57 +0000 Subject: [PATCH 4/5] chore(cicd): Update CLI documentation --- content/en/docs/Reference/ksctl.md | 2 +- content/en/docs/Reference/ksctl_connect-cluster.md | 2 +- content/en/docs/Reference/ksctl_create-cluster.md | 2 +- content/en/docs/Reference/ksctl_create-cluster_aws.md | 2 +- content/en/docs/Reference/ksctl_create-cluster_azure.md | 2 +- content/en/docs/Reference/ksctl_create-cluster_civo.md | 2 +- content/en/docs/Reference/ksctl_create-cluster_ha-aws.md | 2 +- .../en/docs/Reference/ksctl_create-cluster_ha-aws_add-nodes.md | 2 +- content/en/docs/Reference/ksctl_create-cluster_ha-azure.md | 2 +- .../docs/Reference/ksctl_create-cluster_ha-azure_add-nodes.md | 2 +- content/en/docs/Reference/ksctl_create-cluster_ha-civo.md | 2 +- .../en/docs/Reference/ksctl_create-cluster_ha-civo_add-nodes.md | 2 +- content/en/docs/Reference/ksctl_create-cluster_local.md | 2 +- content/en/docs/Reference/ksctl_cred.md | 2 +- content/en/docs/Reference/ksctl_delete-cluster.md | 2 +- content/en/docs/Reference/ksctl_delete-cluster_aws.md | 2 +- content/en/docs/Reference/ksctl_delete-cluster_azure.md | 2 +- content/en/docs/Reference/ksctl_delete-cluster_civo.md | 2 +- content/en/docs/Reference/ksctl_delete-cluster_ha-aws.md | 2 +- .../en/docs/Reference/ksctl_delete-cluster_ha-aws_del-nodes.md | 2 +- content/en/docs/Reference/ksctl_delete-cluster_ha-azure.md | 2 +- .../docs/Reference/ksctl_delete-cluster_ha-azure_del-nodes.md | 2 +- content/en/docs/Reference/ksctl_delete-cluster_ha-civo.md | 2 +- .../en/docs/Reference/ksctl_delete-cluster_ha-civo_del-nodes.md | 2 +- content/en/docs/Reference/ksctl_delete-cluster_local.md | 2 +- content/en/docs/Reference/ksctl_get-clusters.md | 2 +- content/en/docs/Reference/ksctl_info-cluster.md | 2 +- content/en/docs/Reference/ksctl_self-update.md | 2 +- content/en/docs/Reference/ksctl_version.md | 2 +- 29 files changed, 29 insertions(+), 29 deletions(-) diff --git a/content/en/docs/Reference/ksctl.md b/content/en/docs/Reference/ksctl.md index 2791497..f940d0f 100644 --- a/content/en/docs/Reference/ksctl.md +++ b/content/en/docs/Reference/ksctl.md @@ -29,4 +29,4 @@ Ksctl ascii [logo] * [ksctl self-update](ksctl_self-update.md) - update the ksctl cli * [ksctl version](ksctl_version.md) - Print the version number of ksctl -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_connect-cluster.md b/content/en/docs/Reference/ksctl_connect-cluster.md index a4efb92..7d40622 100644 --- a/content/en/docs/Reference/ksctl_connect-cluster.md +++ b/content/en/docs/Reference/ksctl_connect-cluster.md @@ -54,4 +54,4 @@ ksctl connect-context -s external-store-mongodb -p civo -n <clustername> -r <reg * [ksctl](ksctl.md) - CLI tool for managing multiple K8s clusters -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_create-cluster.md b/content/en/docs/Reference/ksctl_create-cluster.md index d27c405..dda6035 100644 --- a/content/en/docs/Reference/ksctl_create-cluster.md +++ b/content/en/docs/Reference/ksctl_create-cluster.md @@ -36,4 +36,4 @@ ksctl create --help * [ksctl create-cluster ha-civo](ksctl_create-cluster_ha-civo.md) - Use to create a self-managed Highly Available cluster on Civo * [ksctl create-cluster local](ksctl_create-cluster_local.md) - Use to create a kind cluster -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_create-cluster_aws.md b/content/en/docs/Reference/ksctl_create-cluster_aws.md index 6ece79f..f48ce7b 100644 --- a/content/en/docs/Reference/ksctl_create-cluster_aws.md +++ b/content/en/docs/Reference/ksctl_create-cluster_aws.md @@ -44,4 +44,4 @@ ksctl create-cluster aws -n demo -r ap-south-1 -s store-local --nodeSizeMP t2.mi * [ksctl create-cluster](ksctl_create-cluster.md) - Use to create a cluster -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_create-cluster_azure.md b/content/en/docs/Reference/ksctl_create-cluster_azure.md index 364fc44..54722ef 100644 --- a/content/en/docs/Reference/ksctl_create-cluster_azure.md +++ b/content/en/docs/Reference/ksctl_create-cluster_azure.md @@ -44,4 +44,4 @@ ksctl create-cluster azure -n demo -r eastus -s store-local --nodeSizeMP Standar * [ksctl create-cluster](ksctl_create-cluster.md) - Use to create a cluster -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_create-cluster_civo.md b/content/en/docs/Reference/ksctl_create-cluster_civo.md index d189d6b..12e3ffa 100644 --- a/content/en/docs/Reference/ksctl_create-cluster_civo.md +++ b/content/en/docs/Reference/ksctl_create-cluster_civo.md @@ -44,4 +44,4 @@ ksctl create-cluster civo --name demo --region LON1 --storage store-local --node * [ksctl create-cluster](ksctl_create-cluster.md) - Use to create a cluster -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_create-cluster_ha-aws.md b/content/en/docs/Reference/ksctl_create-cluster_ha-aws.md index 4c18155..10a3acd 100644 --- a/content/en/docs/Reference/ksctl_create-cluster_ha-aws.md +++ b/content/en/docs/Reference/ksctl_create-cluster_ha-aws.md @@ -50,4 +50,4 @@ ksctl create-cluster ha-aws -n demo -r us-east-1 --bootstrap k3s -s store-local * [ksctl create-cluster](ksctl_create-cluster.md) - Use to create a cluster * [ksctl create-cluster ha-aws add-nodes](ksctl_create-cluster_ha-aws_add-nodes.md) - Use to add more worker nodes in self-managed Highly-Available cluster on Aws -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_create-cluster_ha-aws_add-nodes.md b/content/en/docs/Reference/ksctl_create-cluster_ha-aws_add-nodes.md index 79a1d41..fe8c623 100644 --- a/content/en/docs/Reference/ksctl_create-cluster_ha-aws_add-nodes.md +++ b/content/en/docs/Reference/ksctl_create-cluster_ha-aws_add-nodes.md @@ -40,4 +40,4 @@ ksctl create ha-aws add-nodes -n demo -r ap-south-1 -s store-local --noWP 3 --no * [ksctl create-cluster ha-aws](ksctl_create-cluster_ha-aws.md) - Use to create a self-managed Highly Available cluster on AWS -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_create-cluster_ha-azure.md b/content/en/docs/Reference/ksctl_create-cluster_ha-azure.md index 335bc50..45acdea 100644 --- a/content/en/docs/Reference/ksctl_create-cluster_ha-azure.md +++ b/content/en/docs/Reference/ksctl_create-cluster_ha-azure.md @@ -51,4 +51,4 @@ ksctl create-cluster ha-azure --name demo --region eastus --bootstrap kubeadm -- * [ksctl create-cluster](ksctl_create-cluster.md) - Use to create a cluster * [ksctl create-cluster ha-azure add-nodes](ksctl_create-cluster_ha-azure_add-nodes.md) - Use to add more worker nodes in self-managed Highly-Available cluster on Azure -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_create-cluster_ha-azure_add-nodes.md b/content/en/docs/Reference/ksctl_create-cluster_ha-azure_add-nodes.md index ab3f539..b3e7c47 100644 --- a/content/en/docs/Reference/ksctl_create-cluster_ha-azure_add-nodes.md +++ b/content/en/docs/Reference/ksctl_create-cluster_ha-azure_add-nodes.md @@ -41,4 +41,4 @@ ksctl create ha-azure add-nodes -n demo -r eastus -s store-local --noWP 3 --node * [ksctl create-cluster ha-azure](ksctl_create-cluster_ha-azure.md) - Use to create a self-managed Highly-Available cluster on Azure -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_create-cluster_ha-civo.md b/content/en/docs/Reference/ksctl_create-cluster_ha-civo.md index 1b77b55..4fc7efc 100644 --- a/content/en/docs/Reference/ksctl_create-cluster_ha-civo.md +++ b/content/en/docs/Reference/ksctl_create-cluster_ha-civo.md @@ -51,4 +51,4 @@ ksctl create-cluster ha-civo --name demo --region LON1 --bootstrap kubeadm --sto * [ksctl create-cluster](ksctl_create-cluster.md) - Use to create a cluster * [ksctl create-cluster ha-civo add-nodes](ksctl_create-cluster_ha-civo_add-nodes.md) - Use to add more worker nodes in self-managed Highly-Available cluster on Civo -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_create-cluster_ha-civo_add-nodes.md b/content/en/docs/Reference/ksctl_create-cluster_ha-civo_add-nodes.md index be44989..a2ac395 100644 --- a/content/en/docs/Reference/ksctl_create-cluster_ha-civo_add-nodes.md +++ b/content/en/docs/Reference/ksctl_create-cluster_ha-civo_add-nodes.md @@ -41,4 +41,4 @@ ksctl create ha-civo add-nodes -n demo -r LON1 -s store-local --noWP 3 --nodeSiz * [ksctl create-cluster ha-civo](ksctl_create-cluster_ha-civo.md) - Use to create a self-managed Highly Available cluster on Civo -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_create-cluster_local.md b/content/en/docs/Reference/ksctl_create-cluster_local.md index 8a544cf..63494e0 100644 --- a/content/en/docs/Reference/ksctl_create-cluster_local.md +++ b/content/en/docs/Reference/ksctl_create-cluster_local.md @@ -42,4 +42,4 @@ ksctl create-cluster local --name demo --storage store-local --noMP 3 * [ksctl create-cluster](ksctl_create-cluster.md) - Use to create a cluster -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_cred.md b/content/en/docs/Reference/ksctl_cred.md index 461a52c..7a6cdbc 100644 --- a/content/en/docs/Reference/ksctl_cred.md +++ b/content/en/docs/Reference/ksctl_cred.md @@ -27,4 +27,4 @@ ksctl cred [flags] * [ksctl](ksctl.md) - CLI tool for managing multiple K8s clusters -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_delete-cluster.md b/content/en/docs/Reference/ksctl_delete-cluster.md index bf2ec15..7a78c81 100644 --- a/content/en/docs/Reference/ksctl_delete-cluster.md +++ b/content/en/docs/Reference/ksctl_delete-cluster.md @@ -36,4 +36,4 @@ ksctl delete --help * [ksctl delete-cluster ha-civo](ksctl_delete-cluster_ha-civo.md) - Use to delete a self-managed Highly Available cluster on Civo * [ksctl delete-cluster local](ksctl_delete-cluster_local.md) - Use to delete a kind cluster -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_delete-cluster_aws.md b/content/en/docs/Reference/ksctl_delete-cluster_aws.md index d369478..831d9f7 100644 --- a/content/en/docs/Reference/ksctl_delete-cluster_aws.md +++ b/content/en/docs/Reference/ksctl_delete-cluster_aws.md @@ -38,4 +38,4 @@ ksctl delete aws --name demo --region ap-south-1 --storage store-local * [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_delete-cluster_azure.md b/content/en/docs/Reference/ksctl_delete-cluster_azure.md index e2fda62..32b7511 100644 --- a/content/en/docs/Reference/ksctl_delete-cluster_azure.md +++ b/content/en/docs/Reference/ksctl_delete-cluster_azure.md @@ -39,4 +39,4 @@ ksctl delete azure --name demo --region eastus --storage store-local * [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_delete-cluster_civo.md b/content/en/docs/Reference/ksctl_delete-cluster_civo.md index bddfbc7..d8e887d 100644 --- a/content/en/docs/Reference/ksctl_delete-cluster_civo.md +++ b/content/en/docs/Reference/ksctl_delete-cluster_civo.md @@ -39,4 +39,4 @@ ksctl delete civo --name demo --region LON1 --storage store-local * [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_delete-cluster_ha-aws.md b/content/en/docs/Reference/ksctl_delete-cluster_ha-aws.md index db9b63f..be4937f 100644 --- a/content/en/docs/Reference/ksctl_delete-cluster_ha-aws.md +++ b/content/en/docs/Reference/ksctl_delete-cluster_ha-aws.md @@ -40,4 +40,4 @@ ksctl delete ha-aws --name demo --region us-east-1 --storage store-local * [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster * [ksctl delete-cluster ha-aws del-nodes](ksctl_delete-cluster_ha-aws_del-nodes.md) - Use to remove worker nodes in self-managed Highly-Available cluster on Aws -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_delete-cluster_ha-aws_del-nodes.md b/content/en/docs/Reference/ksctl_delete-cluster_ha-aws_del-nodes.md index 63c1d0b..8eda42f 100644 --- a/content/en/docs/Reference/ksctl_delete-cluster_ha-aws_del-nodes.md +++ b/content/en/docs/Reference/ksctl_delete-cluster_ha-aws_del-nodes.md @@ -39,4 +39,4 @@ ksctl delete ha-aws del-nodes -n demo -r us-east-1 -s store-local --noWP 1 * [ksctl delete-cluster ha-aws](ksctl_delete-cluster_ha-aws.md) - Use to delete a self-managed Highly Available cluster on AWS -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_delete-cluster_ha-azure.md b/content/en/docs/Reference/ksctl_delete-cluster_ha-azure.md index 8e355cb..7f5b0ec 100644 --- a/content/en/docs/Reference/ksctl_delete-cluster_ha-azure.md +++ b/content/en/docs/Reference/ksctl_delete-cluster_ha-azure.md @@ -40,4 +40,4 @@ ksctl delete ha-azure --name demo --region eastus --storage store-local * [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster * [ksctl delete-cluster ha-azure del-nodes](ksctl_delete-cluster_ha-azure_del-nodes.md) - Use to remove worker nodes in self-managed Highly-Available cluster on Azure -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_delete-cluster_ha-azure_del-nodes.md b/content/en/docs/Reference/ksctl_delete-cluster_ha-azure_del-nodes.md index 50becab..c022b08 100644 --- a/content/en/docs/Reference/ksctl_delete-cluster_ha-azure_del-nodes.md +++ b/content/en/docs/Reference/ksctl_delete-cluster_ha-azure_del-nodes.md @@ -40,4 +40,4 @@ ksctl delete ha-azure del-nodes -n demo -r eastus -s store-local --noWP 1 # * [ksctl delete-cluster ha-azure](ksctl_delete-cluster_ha-azure.md) - Use to delete a self-managed Highly Available cluster on Azure -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_delete-cluster_ha-civo.md b/content/en/docs/Reference/ksctl_delete-cluster_ha-civo.md index 94ec127..56bfc72 100644 --- a/content/en/docs/Reference/ksctl_delete-cluster_ha-civo.md +++ b/content/en/docs/Reference/ksctl_delete-cluster_ha-civo.md @@ -40,4 +40,4 @@ ksctl delete ha-civo --name demo --region LON1 --storage store-local * [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster * [ksctl delete-cluster ha-civo del-nodes](ksctl_delete-cluster_ha-civo_del-nodes.md) - Use to remove worker nodes in self-managed Highly-Available cluster on Civo -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_delete-cluster_ha-civo_del-nodes.md b/content/en/docs/Reference/ksctl_delete-cluster_ha-civo_del-nodes.md index db0a5ed..c61ffd1 100644 --- a/content/en/docs/Reference/ksctl_delete-cluster_ha-civo_del-nodes.md +++ b/content/en/docs/Reference/ksctl_delete-cluster_ha-civo_del-nodes.md @@ -40,4 +40,4 @@ ksctl delete ha-civo del-nodes -n demo -r LON1 -s store-local --noWP 1 # He * [ksctl delete-cluster ha-civo](ksctl_delete-cluster_ha-civo.md) - Use to delete a self-managed Highly Available cluster on Civo -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_delete-cluster_local.md b/content/en/docs/Reference/ksctl_delete-cluster_local.md index 657ea3e..6f6d013 100644 --- a/content/en/docs/Reference/ksctl_delete-cluster_local.md +++ b/content/en/docs/Reference/ksctl_delete-cluster_local.md @@ -38,4 +38,4 @@ ksctl delete local --name demo --storage store-local * [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_get-clusters.md b/content/en/docs/Reference/ksctl_get-clusters.md index aef3641..385b44e 100644 --- a/content/en/docs/Reference/ksctl_get-clusters.md +++ b/content/en/docs/Reference/ksctl_get-clusters.md @@ -37,4 +37,4 @@ ksctl get --provider all --storage store-local * [ksctl](ksctl.md) - CLI tool for managing multiple K8s clusters -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_info-cluster.md b/content/en/docs/Reference/ksctl_info-cluster.md index 9c57de7..6b7a76e 100644 --- a/content/en/docs/Reference/ksctl_info-cluster.md +++ b/content/en/docs/Reference/ksctl_info-cluster.md @@ -40,4 +40,4 @@ ksctl info -p ha-azure -n ha-demo-kubeadm -r eastus -s store-local --verbose -1 * [ksctl](ksctl.md) - CLI tool for managing multiple K8s clusters -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_self-update.md b/content/en/docs/Reference/ksctl_self-update.md index 34b4cf4..99c8354 100644 --- a/content/en/docs/Reference/ksctl_self-update.md +++ b/content/en/docs/Reference/ksctl_self-update.md @@ -27,4 +27,4 @@ ksctl self-update [flags] * [ksctl](ksctl.md) - CLI tool for managing multiple K8s clusters -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 diff --git a/content/en/docs/Reference/ksctl_version.md b/content/en/docs/Reference/ksctl_version.md index 965dee4..64d17e8 100644 --- a/content/en/docs/Reference/ksctl_version.md +++ b/content/en/docs/Reference/ksctl_version.md @@ -21,4 +21,4 @@ ksctl version [flags] * [ksctl](ksctl.md) - CLI tool for managing multiple K8s clusters -###### Auto generated by spf13/cobra on 1-Dec-2024 +###### Auto generated by spf13/cobra on 2-Dec-2024 From d236499da3d5c25ef9f8f0140357681fde67dbed Mon Sep 17 00:00:00 2001 From: Dipankar Das <65275144+dipankardas011@users.noreply.github.com> Date: Mon, 2 Dec 2024 12:57:33 +0530 Subject: [PATCH 5/5] updated the docs Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com> --- content/en/docs/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/_index.md b/content/en/docs/_index.md index 2ee96a1..5f4a56d 100644 --- a/content/en/docs/_index.md +++ b/content/en/docs/_index.md @@ -1,9 +1,9 @@ --- title: Documentation -description: develop branch documentation +description: documentation page weight: 20 --- {{% pageinfo %}} -This is the `main` branch documentation +Ksctl documentation {{% /pageinfo %}}