From 30a041037c9d22142c5a495a7f1ceeb8bd8ad79b Mon Sep 17 00:00:00 2001 From: Dipankar Das <65275144+dipankardas011@users.noreply.github.com> Date: Thu, 1 Aug 2024 21:19:16 +0530 Subject: [PATCH] updated the mock testing and also docs Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com> --- .github/workflows/test-mock.yml | 6 +-- gen/docs.md/ksctl_create-cluster.md | 1 + gen/docs.md/ksctl_create-cluster_aws.md | 41 +++++++++++++++++++ gen/docs.md/ksctl_delete-cluster.md | 1 + gen/docs.md/ksctl_delete-cluster_aws.md | 34 ++++++++++++++++ gen/docs.md/ksctl_switch-cluster.md | 1 + gen/docs.rst/ksctl_create-cluster.rst | 1 + gen/docs.rst/ksctl_create-cluster_aws.rst | 49 +++++++++++++++++++++++ gen/docs.rst/ksctl_delete-cluster.rst | 1 + gen/docs.rst/ksctl_delete-cluster_aws.rst | 42 +++++++++++++++++++ gen/docs.rst/ksctl_switch-cluster.rst | 1 + 11 files changed, 175 insertions(+), 3 deletions(-) create mode 100644 gen/docs.md/ksctl_create-cluster_aws.md create mode 100644 gen/docs.md/ksctl_delete-cluster_aws.md create mode 100644 gen/docs.rst/ksctl_create-cluster_aws.rst create mode 100644 gen/docs.rst/ksctl_delete-cluster_aws.rst diff --git a/.github/workflows/test-mock.yml b/.github/workflows/test-mock.yml index d53f7a7..bffe7ad 100644 --- a/.github/workflows/test-mock.yml +++ b/.github/workflows/test-mock.yml @@ -157,9 +157,9 @@ jobs: - name: aws create run: | - # ${{env.KSCTL_BIN}} create aws -n demo -r fake-region --nodeSizeMP "fake" --version 1.27.1 -s store-local --verbose -1 --yes + ${{env.KSCTL_BIN}} create aws -n demo -r fake-region --nodeSizeMP "fake" --version 1.30 -s store-local --verbose -1 --yes - #${{env.KSCTL_BIN}} info -p aws -n demo -r fake-region -s store-local --verbose -1 + ${{env.KSCTL_BIN}} info -p aws -n demo -r fake-region -s store-local --verbose -1 ${{env.KSCTL_BIN}} create ha-aws -n ha-demo-k3s --nodeSizeDS "fake" --version 1.27.1 --nodeSizeLB "fake" --nodeSizeCP "fake" --nodeSizeWP "fake" -r fake-region --verbose -1 -s store-local --yes --bootstrap k3s @@ -198,7 +198,7 @@ jobs: - name: aws switch run: | - # ${{env.KSCTL_BIN}} switch -p aws -n demo -s store-local -r fake-region + ${{env.KSCTL_BIN}} switch -p aws -n demo -s store-local -r fake-region ${{env.KSCTL_BIN}} switch -p ha-aws -n ha-demo-k3s -s store-local -r fake-region ${{env.KSCTL_BIN}} switch -p ha-aws -n ha-demo-kubeadm -s store-local -r fake-region diff --git a/gen/docs.md/ksctl_create-cluster.md b/gen/docs.md/ksctl_create-cluster.md index ae0de89..13b02d9 100644 --- a/gen/docs.md/ksctl_create-cluster.md +++ b/gen/docs.md/ksctl_create-cluster.md @@ -23,6 +23,7 @@ ksctl create --help ### 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 diff --git a/gen/docs.md/ksctl_create-cluster_aws.md b/gen/docs.md/ksctl_create-cluster_aws.md new file mode 100644 index 0000000..fe3e3d2 --- /dev/null +++ b/gen/docs.md/ksctl_create-cluster_aws.md @@ -0,0 +1,41 @@ +## ksctl create-cluster aws + +Use to create a EKS cluster in Aws + +### Synopsis + +It is used to create cluster with the given name from user + +``` +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 + +``` + --apps string Pre-Installed Applications + --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 + --version string Kubernetes Version +``` + +### SEE ALSO + +* [ksctl create-cluster](ksctl_create-cluster.md) - Use to create a cluster + +###### Auto generated by spf13/cobra on 1-Aug-2024 diff --git a/gen/docs.md/ksctl_delete-cluster.md b/gen/docs.md/ksctl_delete-cluster.md index 9c354d8..276fddb 100644 --- a/gen/docs.md/ksctl_delete-cluster.md +++ b/gen/docs.md/ksctl_delete-cluster.md @@ -23,6 +23,7 @@ ksctl delete --help ### 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 diff --git a/gen/docs.md/ksctl_delete-cluster_aws.md b/gen/docs.md/ksctl_delete-cluster_aws.md new file mode 100644 index 0000000..1d9f86a --- /dev/null +++ b/gen/docs.md/ksctl_delete-cluster_aws.md @@ -0,0 +1,34 @@ +## ksctl delete-cluster aws + +Use to deletes a EKS cluster + +### Synopsis + +It is used to delete cluster of given provider + +``` +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 +``` + +### SEE ALSO + +* [ksctl delete-cluster](ksctl_delete-cluster.md) - Use to delete a cluster + +###### Auto generated by spf13/cobra on 1-Aug-2024 diff --git a/gen/docs.md/ksctl_switch-cluster.md b/gen/docs.md/ksctl_switch-cluster.md index 036f8e0..a19b3ab 100644 --- a/gen/docs.md/ksctl_switch-cluster.md +++ b/gen/docs.md/ksctl_switch-cluster.md @@ -20,6 +20,7 @@ ksctl switch-context --provider azure --name --region ksctl switch-context --provider ha-civo --name --region ksctl switch-context --provider ha-azure --name --region ksctl switch-context --provider ha-aws --name --region +ksctl switch-context --provider aws --name --region For Storage specific diff --git a/gen/docs.rst/ksctl_create-cluster.rst b/gen/docs.rst/ksctl_create-cluster.rst index a3a6b22..7c8ad82 100644 --- a/gen/docs.rst/ksctl_create-cluster.rst +++ b/gen/docs.rst/ksctl_create-cluster.rst @@ -31,6 +31,7 @@ SEE ALSO ~~~~~~~~ * `ksctl `_ - CLI tool for managing multiple K8s clusters +* `ksctl create-cluster aws `_ - Use to create a EKS cluster in Aws * `ksctl create-cluster azure `_ - Use to create a AKS cluster in Azure * `ksctl create-cluster civo `_ - Use to create a Civo managed k3s cluster * `ksctl create-cluster ha-aws `_ - Use to create a self-managed Highly Available cluster on AWS diff --git a/gen/docs.rst/ksctl_create-cluster_aws.rst b/gen/docs.rst/ksctl_create-cluster_aws.rst new file mode 100644 index 0000000..8335bd2 --- /dev/null +++ b/gen/docs.rst/ksctl_create-cluster_aws.rst @@ -0,0 +1,49 @@ +.. _ksctl_create-cluster_aws: + +ksctl create-cluster aws +------------------------ + +Use to create a EKS cluster in Aws + +Synopsis +~~~~~~~~ + + +It is used to create cluster with the given name from user + +:: + + 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 +~~~~~~~ + +:: + + --apps string Pre-Installed Applications + --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 + --version string Kubernetes Version + +SEE ALSO +~~~~~~~~ + +* `ksctl create-cluster `_ - Use to create a cluster + +*Auto generated by spf13/cobra on 1-Aug-2024* diff --git a/gen/docs.rst/ksctl_delete-cluster.rst b/gen/docs.rst/ksctl_delete-cluster.rst index c807277..d9ce9e6 100644 --- a/gen/docs.rst/ksctl_delete-cluster.rst +++ b/gen/docs.rst/ksctl_delete-cluster.rst @@ -31,6 +31,7 @@ SEE ALSO ~~~~~~~~ * `ksctl `_ - CLI tool for managing multiple K8s clusters +* `ksctl delete-cluster aws `_ - Use to deletes a EKS cluster * `ksctl delete-cluster azure `_ - Use to deletes a AKS cluster * `ksctl delete-cluster civo `_ - Use to delete a Civo managed k3s cluster * `ksctl delete-cluster ha-aws `_ - Use to delete a self-managed Highly Available cluster on AWS diff --git a/gen/docs.rst/ksctl_delete-cluster_aws.rst b/gen/docs.rst/ksctl_delete-cluster_aws.rst new file mode 100644 index 0000000..08df59e --- /dev/null +++ b/gen/docs.rst/ksctl_delete-cluster_aws.rst @@ -0,0 +1,42 @@ +.. _ksctl_delete-cluster_aws: + +ksctl delete-cluster aws +------------------------ + +Use to deletes a EKS cluster + +Synopsis +~~~~~~~~ + + +It is used to delete cluster of given provider + +:: + + 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 + +SEE ALSO +~~~~~~~~ + +* `ksctl delete-cluster `_ - Use to delete a cluster + +*Auto generated by spf13/cobra on 1-Aug-2024* diff --git a/gen/docs.rst/ksctl_switch-cluster.rst b/gen/docs.rst/ksctl_switch-cluster.rst index 82b4917..139a644 100644 --- a/gen/docs.rst/ksctl_switch-cluster.rst +++ b/gen/docs.rst/ksctl_switch-cluster.rst @@ -27,6 +27,7 @@ Examples ksctl switch-context --provider ha-civo --name --region ksctl switch-context --provider ha-azure --name --region ksctl switch-context --provider ha-aws --name --region + ksctl switch-context --provider aws --name --region For Storage specific