diff --git a/assets/scss/_variables_project.scss b/assets/scss/_variables_project.scss index 77fe90f..688c7bd 100644 --- a/assets/scss/_variables_project.scss +++ b/assets/scss/_variables_project.scss @@ -1,5 +1,5 @@ -/* $primary: #3c6464; */ -/* $secondary: #d9e1d2; */ +$primary: #3c6464; +$secondary: #d9e1d2; /* $google_font_name: 'Space Mono'; */ /* $google_font_family: 'Space+Mono:300,300i,400,400i,700,700i'; */ diff --git a/content/en/_index.md b/content/en/_index.md index 6a4569a..142bf09 100644 --- a/content/en/_index.md +++ b/content/en/_index.md @@ -1,10 +1,11 @@ --- -title: Ksctl Docs +title: Kli Docs --- -{{< blocks/cover title="Welcome to Ksctl Documentation!" image_anchor="top" height="full" >}} +{{< blocks/cover title="Welcome to kli Documentation!" image_anchor="top" height="full" >}} -![Propsal design](/img/ksctl-logo.svg) +kli Logo +
Learn More @@ -23,7 +24,7 @@ title: Ksctl Docs {{% blocks/lead color="primary" %}} -Ksctl is a unified CLI tool that simplifies the management of Kubernetes clusters across diverse cloud providers. Designed for developers, Ksctl eliminates the complexity of multi-cloud Kubernetes setups by consolidating cluster management into one intuitive interface. +Kli is a unified CLI tool that simplifies the management of Kubernetes clusters across diverse cloud providers. Designed for developers, kli eliminates the complexity of multi-cloud Kubernetes setups by consolidating cluster management into one intuitive interface. {{% /blocks/lead %}} @@ -70,7 +71,7 @@ Ksctl is a unified CLI tool that simplifies the management of Kubernetes cluster {{% blocks/section type="row" %}} {{% blocks/feature icon="fab fa-github" title="Contributions welcome!" - url="https://github.com/ksctl/ksctl" %}} + url="https://github.com/ksctl/kli" %}} We do a contributions workflow on **GitHub**. New users are always welcome! {{% /blocks/feature %}} diff --git a/content/en/blog/announcements/_index.md b/content/en/blog/announcements/_index.md index 8a4ece1..b79b5a8 100644 --- a/content/en/blog/announcements/_index.md +++ b/content/en/blog/announcements/_index.md @@ -4,5 +4,5 @@ weight: 20 --- {{% pageinfo %}} -All the Ksctl announcements +All the kli announcements {{% /pageinfo %}} diff --git a/content/en/blog/announcements/v2_6_x.md b/content/en/blog/announcements/v2_6_x.md index 267d510..40af56e 100644 --- a/content/en/blog/announcements/v2_6_x.md +++ b/content/en/blog/announcements/v2_6_x.md @@ -1,15 +1,15 @@ --- -title: Ksctl v2.6 Customization for Cilium and Flannel CNI +title: kli v2.6 Customization for Cilium and Flannel CNI date: 2025-04-27 description: > - Introducing enhanced customization options for Cilium and Flannel CNI in Ksctl v2.6 to optimize your Kubernetes networking. + Introducing enhanced customization options for Cilium and Flannel CNI in kli v2.6 to optimize your Kubernetes networking. --- -# 🚀 Ksctl v2.6: Advanced Customization for Cilium and Flannel CNI +# 🚀 kli v2.6: Advanced Customization for Cilium and Flannel CNI -We are thrilled to announce the release of **Ksctl v2.6**! This significant update introduces **Advanced Customization for Cilium and Flannel CNI**, empowering you to tailor your Kubernetes clusters' networking to match your specific requirements and operational environment. +We are thrilled to announce the release of **kli v2.6**! This significant update introduces **Advanced Customization for Cilium and Flannel CNI**, empowering you to tailor your Kubernetes clusters' networking to match your specific requirements and operational environment. -## 🌟 What's New in Ksctl v2.6? +## 🌟 What's New in kli v2.6? ### 📌 **Cilium Customization Options** @@ -57,7 +57,7 @@ Flannel, known for its simplicity and reliability, now also offers similar custo For detailed instructions on Flannel configuration, see our [Flannel Documentation](/docs/cni/flannel/). -> **Note**: These customization features work with the `ksctl cluster create` command when specifying your CNI preference. +> **Note**: These customization features work with the `kli cluster create` command when specifying your CNI preference. ## 💪 Benefits of CNI Customization @@ -69,19 +69,19 @@ For detailed instructions on Flannel configuration, see our [Flannel Documentati --- -## 🔄 How to Upgrade to Ksctl v2.6 +## 🔄 How to Upgrade to kli v2.6 -To upgrade your Ksctl CLI to the latest version, simply run: +To upgrade your kli CLI to the latest version, simply run: ```shell -ksctl self-update +kli self-update ``` This ensures you're using the latest version with all the new features and improvements. 🚀 -With Ksctl v2.6, managing Kubernetes networking has never been more flexible and powerful! Upgrade today to take advantage of these advanced CNI customization options. +With kli v2.6, managing Kubernetes networking has never been more flexible and powerful! Upgrade today to take advantage of these advanced CNI customization options. ## 📚 Additional Resources -👉 [Get started with Ksctl v2.6](/docs/getting-started/) +👉 [Get started with kli v2.6](/docs/getting-started/) diff --git a/content/en/blog/announcements/v2_7_x.md b/content/en/blog/announcements/v2_7_x.md index a9dec95..5dfeaa2 100644 --- a/content/en/blog/announcements/v2_7_x.md +++ b/content/en/blog/announcements/v2_7_x.md @@ -1,15 +1,15 @@ --- -title: Ksctl v2.7 New Cluster Summary and Recommendation +title: kli v2.7 New Cluster Summary and Recommendation date: 2025-04-27 description: > - Introducing the new cluster summary and recommendation feature in Ksctl v2.7 for enhanced debugging and security recommendations. + Introducing the new cluster summary and recommendation feature in kli v2.7 for enhanced debugging and security recommendations. --- -# 🚀 Ksctl v2.7: New Cluster Summary and Recommendation +# 🚀 kli v2.7: New Cluster Summary and Recommendation -We are thrilled to announce the release of **Ksctl v2.7**! This significant update introduces **Cluster Summary**, empowering you to gain Both Debugging Information and Security Recommendations for your Kubernetes clusters. +We are thrilled to announce the release of **kli v2.7**! This significant update introduces **Cluster Summary**, empowering you to gain Both Debugging Information and Security Recommendations for your Kubernetes clusters. -## 🌟 What's New in Ksctl v2.7? +## 🌟 What's New in kli v2.7? ### 📌 **New Logging System** @@ -23,7 +23,7 @@ The new cluster summary and recommendation feature provides you with a comprehen -In our latest release, Ksctl v2.7 introduces a powerful feature that provides a comprehensive summary of your cluster's configuration. This feature is designed to enhance both debugging and security recommendations. With a single command, `$ ksctl cluster summary`, users can access critical details about their cluster. +In our latest release, kli v2.7 introduces a powerful feature that provides a comprehensive summary of your cluster's configuration. This feature is designed to enhance both debugging and security recommendations. With a single command, `$ kli cluster summary`, users can access critical details about their cluster. This includes insights into `pod errors`, `node metrics`, `cluster events`, and `latency reports`. @@ -35,20 +35,20 @@ For detailed instructions on this, Head over to [Cluster Summary Documentation]( --- -## 🔄 How to Upgrade to Ksctl v2.7 +## 🔄 How to Upgrade to kli v2.7 -To upgrade your Ksctl CLI to the latest version, simply run: +To upgrade your kli CLI to the latest version, simply run: ```shell -ksctl self-update +kli self-update ``` This ensures you're using the latest version with all the new features and improvements. 🚀 -With Ksctl v2.7, managing Kubernetes networking has never been more flexible and powerful! Upgrade today to take advantage of these advance features. +With kli v2.7, managing Kubernetes networking has never been more flexible and powerful! Upgrade today to take advantage of these advance features. ## 📚 Additional Resources -👉 [Get started with Ksctl v2.7](/docs/getting-started/) +👉 [Get started with kli v2.7](/docs/getting-started/) diff --git a/content/en/blog/findings/_index.md b/content/en/blog/findings/_index.md index 39a41e3..6834256 100644 --- a/content/en/blog/findings/_index.md +++ b/content/en/blog/findings/_index.md @@ -4,5 +4,5 @@ weight: 20 --- {{% pageinfo %}} -Ksctl documentation +kli documentation {{% /pageinfo %}} diff --git a/content/en/docs/Concepts/ksctl cloud controller.md b/content/en/docs/Concepts/ksctl cloud controller.md index 2ac325d..f22902d 100644 --- a/content/en/docs/Concepts/ksctl cloud controller.md +++ b/content/en/docs/Concepts/ksctl cloud controller.md @@ -1,7 +1,7 @@ --- title: Cloud Controller description: > - The Component of Ksctl responsible for creating and managing clusters for different Cloud platforms. + The Component of kli responsible for creating and managing clusters for different Cloud platforms. categories: [Examples] --- diff --git a/content/en/docs/Concepts/ksctl distro controller.md b/content/en/docs/Concepts/ksctl distro controller.md index a278f5f..a66c52a 100644 --- a/content/en/docs/Concepts/ksctl distro controller.md +++ b/content/en/docs/Concepts/ksctl distro controller.md @@ -1,7 +1,7 @@ --- title: Distribution Controller description: > - The Component of Ksctl responsible for selecting the type of Bootstrap solution (Kubeadm or K3s). + The Component of kli responsible for selecting the type of Bootstrap solution (Kubeadm or K3s). categories: [Examples] --- diff --git a/content/en/docs/Concepts/ksctl manager.md b/content/en/docs/Concepts/ksctl manager.md index 45d8924..d23b99b 100644 --- a/content/en/docs/Concepts/ksctl manager.md +++ b/content/en/docs/Concepts/ksctl manager.md @@ -1,7 +1,7 @@ --- title: Core Manager description: > - The Component of Ksctl responsible for managing Cloud controller and Distribution controller. It has multiple types of managers + The Component of kli responsible for managing Cloud controller and Distribution controller. It has multiple types of managers categories: [Examples] --- @@ -11,15 +11,15 @@ It is responsible for managing client requests and calls the corresponding contr ## Types -### ManagerClusterKsctl -`Role`: Perform ksctl **getCluster**, **switchCluster** +### ManagerClusterkli +`Role`: Perform kli **getCluster**, **switchCluster** ### ManagerClusterKubernetes -`Role`: Perform ksctl **addApplicationAndCrds** -Currently to be used by machine to machine not by ksctl cli +`Role`: Perform kli **addApplicationAndCrds** +Currently to be used by machine to machine not by kli cli ### ManagerClusterManaged -`Role`: Perform ksctl **createCluster**, **deleteCluster** +`Role`: Perform kli **createCluster**, **deleteCluster** ### ManagerClusterSelfManaged -`Role`: Perform ksctl **createCluster**, **deleteCluster**, **addWorkerNodes**, **delWorkerNodes** +`Role`: Perform kli **createCluster**, **deleteCluster**, **addWorkerNodes**, **delWorkerNodes** diff --git a/content/en/docs/Concepts/smart-optimization.md b/content/en/docs/Concepts/smart-optimization.md index 0be215b..9ba80fb 100644 --- a/content/en/docs/Concepts/smart-optimization.md +++ b/content/en/docs/Concepts/smart-optimization.md @@ -1,21 +1,21 @@ --- title: Smart Cost & Emission Optimization -description: Documentation on Ksctl's intelligent region and instance selection features +description: Documentation on kli's intelligent region and instance selection features weight: 5 tags: [docs, concepts, optimization] --- # Smart Cost & Emission Optimization -Ksctl provides intelligent optimization features that help you minimize infrastructure costs and environmental impact when deploying Kubernetes clusters. These features ensure that your clusters run in both the most cost-effective and environmentally friendly configurations. +kli provides intelligent optimization features that help you minimize infrastructure costs and environmental impact when deploying Kubernetes clusters. These features ensure that your clusters run in both the most cost-effective and environmentally friendly configurations. -## Ksctl Optimizer (KO) (v2.4+) +## kli Optimizer (KO) (v2.4+) -Introduced in **Ksctl v2.4**, KO optimizes costs and emissions by intelligently selecting the most efficient region for your Kubernetes clusters without changing your instance type. +Introduced in **kli v2.4**, KO optimizes costs and emissions by intelligently selecting the most efficient region for your Kubernetes clusters without changing your instance type. ### Key Benefits -- **🚀 Automatic Region Optimization**: Ksctl intelligently identifies and switches to the most cost-effective and environmentally friendly regions. +- **🚀 Automatic Region Optimization**: kli intelligently identifies and switches to the most cost-effective and environmentally friendly regions. - **🛠️ Flexible Region Control**: You can opt to keep your cluster in your preferred region if needed. - **💰 Cost Savings**: Dynamically adapts to pricing changes across regions, reducing your infrastructure expenses. - **🌱 Eco-Friendly Operations**: Minimizes carbon footprint through smart region selection. @@ -29,12 +29,12 @@ It evaluates regions based on multiple metrics to determine the optimal location 3. **Renewable Power Percentage** (Higher is better): Highlights regions with higher renewable energy usage. 4. **Low CO₂ Power Percentage** (Higher is better): Focuses on regions with a lower share of carbon-intensive power. -![Ksctl v2.4 KO Feature](/img/blogs/ksctl-new-recommendation.png) +![kli v2.4 KO Feature](/img/blogs/ksctl-new-recommendation.png) *Visualization of dynamic region switching optimization* -## Ksctl Sustainability Metrics (KSM) (v2.5+) +## kli Sustainability Metrics (KSM) (v2.5+) -Introduced in **Ksctl v2.5**, this feature enhances the optimization capabilities through a card-based selection interface that helps you choose the best region and instance type for your Kubernetes clusters based on your specific requirements. +Introduced in **kli v2.5**, this feature enhances the optimization capabilities through a card-based selection interface that helps you choose the best region and instance type for your Kubernetes clusters based on your specific requirements. ### Smart Region Selection @@ -78,9 +78,9 @@ The Smart Instance Type Selection evaluates and ranks instance types based on: ## Using the Optimization Features -These optimization features are integrated with the `ksctl cluster create` command and work automatically when you create a new Kubernetes cluster. +These optimization features are integrated with the `kli cluster create` command and work automatically when you create a new Kubernetes cluster. -When you run the cluster creation command, Ksctl will: +When you run the cluster creation command, kli will: 1. Analyze available regions and instance types 2. Evaluate cost and emission metrics for each option @@ -91,10 +91,10 @@ This ensures you get **maximum cost efficiency** and **minimum emissions** while ## Upgrading to Access These Features -To access these optimization features, make sure you're using Ksctl v2.4 or above by running: +To access these optimization features, make sure you're using kli v2.4 or above by running: ```shell -ksctl self-update +kli self-update ``` This will ensure you have the latest version with all the optimization capabilities described in this document. diff --git a/content/en/docs/Getting started/_index.md b/content/en/docs/Getting started/_index.md index ec90328..cc1ac40 100644 --- a/content/en/docs/Getting started/_index.md +++ b/content/en/docs/Getting started/_index.md @@ -12,16 +12,16 @@ Getting Started Documentation # Installation & Uninstallation Instructions -## Ksctl CLI +## kli Lets begin with installation of the tools their are various method ### Single command method -{{% alert title="Install" %}}Steps to Install Ksctl cli tool{{% /alert %}} +{{% alert title="Install" %}}Steps to Install kli cli tool{{% /alert %}} ```shell -curl -sfL https://get.ksctl.com | python3 - +curl -sfL https://get.kli.ksctl.com | python3 - ``` {{% alert title="Uninstall" %}}Steps to Uninstall Ksctl cli tool{{% /alert %}} @@ -30,12 +30,12 @@ curl -sfL https://get.ksctl.com | python3 - {{% tab header="**Operating System**:" disabled=true /%}} {{% tab header="Linux" %}} ```shell -bash <(curl -s https://raw.githubusercontent.com/ksctl/cli/main/scripts/uninstall.sh) +bash <(curl -s https://raw.githubusercontent.com/ksctl/kli/main/scripts/uninstall.sh) ``` {{% /tab %}} {{% tab header="MacOS" %}} ```shell -zsh <(curl -s https://raw.githubusercontent.com/ksctl/cli/main/scripts/uninstall.sh) +zsh <(curl -s https://raw.githubusercontent.com/ksctl/kli/main/scripts/uninstall.sh) ``` {{% /tab %}} {{< /tabpane >}} @@ -70,8 +70,8 @@ make uninstall {{% alert title="Configure" %}}Steps to Configure Ksctl cli tool{{% /alert %}} ```shell -ksctl configure cloud # To configure cloud -ksctl configure storage # To configure storage +kli configure cloud # To configure cloud +kli configure storage # To configure storage ``` {{% alert color="info" title="How to start with cli" %}} diff --git a/content/en/docs/Ksctl Cluster Mgt/_index.md b/content/en/docs/Ksctl Cluster Mgt/_index.md index 3ef172b..2c112f0 100644 --- a/content/en/docs/Ksctl Cluster Mgt/_index.md +++ b/content/en/docs/Ksctl Cluster Mgt/_index.md @@ -1,5 +1,5 @@ --- -title: Ksctl Cluster Management +title: Kli Cluster Management description: Place of all the documentation for the Operators used specifically for k8s clusters tags: [docs] --- diff --git a/content/en/docs/Ksctl Cluster Mgt/stacks.md b/content/en/docs/Ksctl Cluster Mgt/stacks.md index 5986521..ff8a1f5 100644 --- a/content/en/docs/Ksctl Cluster Mgt/stacks.md +++ b/content/en/docs/Ksctl Cluster Mgt/stacks.md @@ -1,6 +1,6 @@ --- -title: Ksctl Stack -description: Documentation on ksctl stack controller +title: kli Stack +description: Documentation on kli stack controller categories: [Examples, Placeholders] tags: [docs] --- diff --git a/content/en/docs/_index.md b/content/en/docs/_index.md index d06ac8f..c84195d 100644 --- a/content/en/docs/_index.md +++ b/content/en/docs/_index.md @@ -7,5 +7,5 @@ menu: --- {{% pageinfo %}} -Ksctl documentation +kli documentation {{% /pageinfo %}} diff --git a/content/en/docs/cni/_index.md b/content/en/docs/cni/_index.md index a1e0719..6afca55 100644 --- a/content/en/docs/cni/_index.md +++ b/content/en/docs/cni/_index.md @@ -1,6 +1,6 @@ --- title: Container Network Interface (CNI) -description: Supported CNI by Ksctl +description: Supported CNI by kli tags: [cni, addon] --- @@ -11,7 +11,7 @@ For Cloud managed cluster it varies based on the provider. {{% /pageinfo %}} ## Pre-requisites -You get to choose Ksctl CNI when you choose `none` from the main provider : +You get to choose kli CNI when you choose `none` from the main provider : - Cloud Managed Cluster Provider (**aks**, **eks**, **kind**) _Or_ - Kubernetes Bootstrap Provider (**k3s**, **kubeadm**) diff --git a/content/en/docs/cni/cilium.md b/content/en/docs/cni/cilium.md index 08cee70..ab4f705 100644 --- a/content/en/docs/cni/cilium.md +++ b/content/en/docs/cni/cilium.md @@ -10,7 +10,7 @@ tags: [core] {{% alert color= "info" title="Note" %}} -This Docs is only Cilium provided by Ksctl +This Docs is only Cilium provided by Kli You can only choose CNI plugin during the cluster creation process. {{% /alert %}} diff --git a/content/en/docs/cni/flannel.md b/content/en/docs/cni/flannel.md index 021fe78..909b757 100644 --- a/content/en/docs/cni/flannel.md +++ b/content/en/docs/cni/flannel.md @@ -10,7 +10,7 @@ tags: [core] {{% alert color= "info" title="Note" %}} -This Docs is only Flannel provided by Ksctl +This Docs is only Flannel provided by kli You can only choose CNI plugin during the cluster creation process. {{% /alert %}} diff --git a/content/en/docs/faq.md b/content/en/docs/faq.md index 8ff5b69..8b276fc 100644 --- a/content/en/docs/faq.md +++ b/content/en/docs/faq.md @@ -1,60 +1,60 @@ --- title: Faq -description: Frequently asked questions about ksctl +description: Frequently asked questions about kli tags: [docs] --- ## General -### What is ksctl? -Ksctl is a lightweight, easy-to-use tool that simplifies the process of managing Kubernetes clusters. It provides a unified interface for common cluster operations like create, delete, scaleup and down, and is designed to be simple, efficient, and developer-friendly. +### What is kli? +kli is a lightweight, easy-to-use tool that simplifies the process of managing Kubernetes clusters. It provides a unified interface for common cluster operations like create, delete, scaleup and down, and is designed to be simple, efficient, and developer-friendly. -### What can I do with ksctl? -With ksctl, you can deploy Kubernetes clusters across any cloud provider, switch between providers seamlessly, and choose between managed and self-managed HA clusters. You can deploy clusters with a single command, without any complex configuration, and manage them with a unified interface that eliminates the need for provider-specific CLIs. +### What can I do with kli? +With kli, you can deploy Kubernetes clusters across any cloud provider, switch between providers seamlessly, and choose between managed and self-managed HA clusters. You can deploy clusters with a single command, without any complex configuration, and manage them with a unified interface that eliminates the need for provider-specific CLIs. -### How does ksctl simplify cluster management? -Ksctl simplifies cluster management by providing a streamlined interface for common cluster operations like create, delete, scaleup and down. It eliminates the need for complex configuration and provider-specific CLIs, and provides a consistent experience across environments. With ksctl, developers can focus on building great applications without getting bogged down by the complexities of cluster management. +### How does kli simplify cluster management? +kli simplifies cluster management by providing a streamlined interface for common cluster operations like create, delete, scaleup and down. It eliminates the need for complex configuration and provider-specific CLIs, and provides a consistent experience across environments. With kli, developers can focus on building great applications without getting bogged down by the complexities of cluster management. -### Who is ksctl for? -Ksctl is designed for developers, DevOps engineers, and anyone who needs to manage Kubernetes clusters. It is ideal for teams of all skill levels, from beginners to experts, and provides a simple, efficient, and developer-friendly way to deploy and manage clusters. +### Who is kli for? +kli is designed for developers, DevOps engineers, and anyone who needs to manage Kubernetes clusters. It is ideal for teams of all skill levels, from beginners to experts, and provides a simple, efficient, and developer-friendly way to deploy and manage clusters. -### How does ksctl differ from other cluster management tools? -Ksctl is a lightweight, easy-to-use tool that simplifies the process of managing Kubernetes clusters. It provides a unified interface for common cluster operations like create, delete, scaleup and down, and is designed to be simple, efficient, and developer-friendly. Ksctl is not a full-fledged platform like Rancher, but rather a simple CLI tool that provides a streamlined interface for common cluster operations. +### How does kli differ from other cluster management tools? +kli is a lightweight, easy-to-use tool that simplifies the process of managing Kubernetes clusters. It provides a unified interface for common cluster operations like create, delete, scaleup and down, and is designed to be simple, efficient, and developer-friendly. kli is not a full-fledged platform like Rancher, but rather a simple CLI tool that provides a streamlined interface for common cluster operations. ### Is it production-ready? No, the level of highly customization is missing in terms of cloud resources, ssh ports are open to public internet (self managed cluster) though authentication via ssh keypair are there. It recommended to be used by developers for development and testing purposes and get familiar with the Kubernetes Ecosystem ## Comparisons -### Ksctl vs Cluster API -- **Simplicity vs Complexity**: Cluster API uses a sophisticated set of CRDs (Custom Resource Definitions) to manage machines, machine sets, and deployments. In contrast, Ksctl adopts a minimalist approach, focusing on reducing complexity for developers and operators. -- **Target Audience**: Ksctl caters to users seeking a lightweight, user-friendly tool for quick cluster management tasks, particularly in development and testing environments. Cluster API is designed for production-grade use cases, emphasizing flexibility and integration with Kubernetes' declarative model. -- **Dependencies**: Ksctl is a standalone CLI tool that does not require a running Kubernetes cluster, making it easy to set up and run anywhere. On the other hand, Cluster API requires a pre-existing Kubernetes cluster to operate. -- **Feature Focus**: Ksctl emphasizes speed and simplicity in managing cluster lifecycle operations (create, delete, scale). Cluster API provides deeper control and automation features suitable for enterprises managing complex Kubernetes ecosystems. +### kli vs Cluster API +- **Simplicity vs Complexity**: Cluster API uses a sophisticated set of CRDs (Custom Resource Definitions) to manage machines, machine sets, and deployments. In contrast, kli adopts a minimalist approach, focusing on reducing complexity for developers and operators. +- **Target Audience**: kli caters to users seeking a lightweight, user-friendly tool for quick cluster management tasks, particularly in development and testing environments. Cluster API is designed for production-grade use cases, emphasizing flexibility and integration with Kubernetes' declarative model. +- **Dependencies**: kli is a standalone CLI tool that does not require a running Kubernetes cluster, making it easy to set up and run anywhere. On the other hand, Cluster API requires a pre-existing Kubernetes cluster to operate. +- **Feature Focus**: kli emphasizes speed and simplicity in managing cluster lifecycle operations (create, delete, scale). Cluster API provides deeper control and automation features suitable for enterprises managing complex Kubernetes ecosystems. -### What is the difference between Ksctl and k3sup? -- **Scope**: Ksctl is a comprehensive tool for managing Kubernetes clusters across multiple environments from cloud managed Kubernetes flavour to K3s and kubeadm. K3sup, on the other hand, focuses primarily on bootstrapping lightweight k3s clusters. -- **Features**: Ksctl handles infrastructure provisioning, cluster scaling, and cloud-agnostic lifecycle management, whereas k3sup is limited to installing k3s clusters without managing the underlying infrastructure. -- **Cloud Support**: Ksctl provides a unified interface for managing clusters across different providers, making it suitable for multi-cloud strategies. K3sup is more limited and designed for standalone setups. +### What is the difference between kli and k3sup? +- **Scope**: kli is a comprehensive tool for managing Kubernetes clusters across multiple environments from cloud managed Kubernetes flavour to K3s and kubeadm. K3sup, on the other hand, focuses primarily on bootstrapping lightweight k3s clusters. +- **Features**: kli handles infrastructure provisioning, cluster scaling, and cloud-agnostic lifecycle management, whereas k3sup is limited to installing k3s clusters without managing the underlying infrastructure. +- **Cloud Support**: kli provides a unified interface for managing clusters across different providers, making it suitable for multi-cloud strategies. K3sup is more limited and designed for standalone setups. -### How does Ksctl compare to Rancher? -- **Tool vs Platform**: Ksctl is a streamlined CLI tool for cluster management. Rancher, by contrast, is a feature-rich platform offering cluster governance, monitoring, access control, and application management. -- **Use Case**: Ksctl is lightweight and ideal for developers needing quick, uncomplicated cluster management. Rancher is tailored for enterprise environments where centralized management and control of multiple clusters are essential. -- **Operational Scope**: Ksctl focuses on basic lifecycle operations (create, delete, scale). Rancher includes features like Helm chart deployment, RBAC integration, and advanced workload management. +### How does kli compare to Rancher? +- **Tool vs Platform**: kli is a streamlined CLI tool for cluster management. Rancher, by contrast, is a feature-rich platform offering cluster governance, monitoring, access control, and application management. +- **Use Case**: kli is lightweight and ideal for developers needing quick, uncomplicated cluster management. Rancher is tailored for enterprise environments where centralized management and control of multiple clusters are essential. +- **Operational Scope**: kli focuses on basic lifecycle operations (create, delete, scale). Rancher includes features like Helm chart deployment, RBAC integration, and advanced workload management. -### What is the difference between Ksctl and k3d, Kind, or Minikube? -- **Environment Scope**: Ksctl is designed for both local and cloud-based Kubernetes cluster management. Tools like k3d, Kind, and Minikube are primarily for local development and testing purposes. -- **Cluster Management**: Ksctl can provision, scale, and delete clusters in cloud environments, whereas k3d, Kind, and Minikube focus on providing lightweight clusters for experimentation and local development. -- **Infrastructure Management**: Ksctl integrates with infrastructure provisioning, while the others rely on pre-existing local environments (e.g., Docker for k3d and Kind, or virtual machines for Minikube). +### What is the difference between kli and k3d, Kind, or Minikube? +- **Environment Scope**: kli is designed for both local and cloud-based Kubernetes cluster management. Tools like k3d, Kind, and Minikube are primarily for local development and testing purposes. +- **Cluster Management**: kli can provision, scale, and delete clusters in cloud environments, whereas k3d, Kind, and Minikube focus on providing lightweight clusters for experimentation and local development. +- **Infrastructure Management**: kli integrates with infrastructure provisioning, while the others rely on pre-existing local environments (e.g., Docker for k3d and Kind, or virtual machines for Minikube). -### How does Ksctl compare to eksctl? -- **Cloud Support**: Ksctl is cloud-agnostic and supports multiple providers, making it suitable for multi-cloud setups. Eksctl, on the other hand, is tightly coupled with AWS and designed exclusively for managing EKS clusters. -- **Features**: Ksctl provides an all-in-one tool for provisioning infrastructure, managing the cluster lifecycle, and scaling across different environments. Eksctl is focused on streamlining EKS setup and optimizing AWS integrations like IAM, VPCs, and Load Balancers. -- **Target Audience**: Ksctl appeals to users seeking a flexible, multi-cloud solution. Eksctl is ideal for AWS-centric teams that require deep integration with AWS services. +### How does kli compare to ekli? +- **Cloud Support**: kli is cloud-agnostic and supports multiple providers, making it suitable for multi-cloud setups. Ekli, on the other hand, is tightly coupled with AWS and designed exclusively for managing EKS clusters. +- **Features**: kli provides an all-in-one tool for provisioning infrastructure, managing the cluster lifecycle, and scaling across different environments. Ekli is focused on streamlining EKS setup and optimizing AWS integrations like IAM, VPCs, and Load Balancers. +- **Target Audience**: kli appeals to users seeking a flexible, multi-cloud solution. Eksctl is ideal for AWS-centric teams that require deep integration with AWS services. diff --git a/content/en/docs/features.md b/content/en/docs/features.md index dabc2d9..effefea 100644 --- a/content/en/docs/features.md +++ b/content/en/docs/features.md @@ -1,13 +1,13 @@ --- title: Features -description: Features of ksctl +description: Features of kli tags: [docs] --- ### Our Vision Transform your Kubernetes experience with a tool that puts simplicity and efficiency first. -Ksctl eliminates the complexity of cluster management, allowing developers to focus on what matters most – building great applications. +kli eliminates the complexity of cluster management, allowing developers to focus on what matters most – building great applications. ### Key Features diff --git a/content/en/docs/helpers.md b/content/en/docs/helpers.md index 762de97..a5b7e8f 100644 --- a/content/en/docs/helpers.md +++ b/content/en/docs/helpers.md @@ -8,7 +8,7 @@ tags: [docs] | Name | How | |------|-----| -| Azure | Azure Open Source Program Office

🎉 Exciting news!

🚀 Azure now supports KSCTL with $10K in cloud credits! 💻

Manage your Kubernetes clusters effortlessly with kubesimplify's powerful command-line tool - KSCTL. pic.twitter.com/VjSKiyoqTH

— kubesimplify (@kubesimplify) November 15, 2023
| +| Azure | Azure Open Source Program Office

🎉 Exciting news!

🚀 Azure now supports kli with $10K in cloud credits! 💻

Manage your Kubernetes clusters effortlessly with kubesimplify's powerful command-line tool - kli. pic.twitter.com/VjSKiyoqTH

— kubesimplify (@kubesimplify) November 15, 2023
| | Civo | Provided Us with credits to run and test our project and were the first cloud provider we supported. | @@ -16,6 +16,6 @@ tags: [docs] | Name | Social Mentions | |------|-----| -| Kubernetes Architect |

ksctl is a simple multi-environment Kubernetes management CLI tool

➤ https://t.co/QU9gR9BzYj

— Kubernetes Architect (@K8sArchitect) May 11, 2023
| +| Kubernetes Architect |

kli is a simple multi-environment Kubernetes management CLI tool

➤ https://t.co/QU9gR9BzYj

— Kubernetes Architect (@K8sArchitect) May 11, 2023
| | WeMakeDevs HacktoberFest | Mentioned our project in their Hacktoberfest event. [Youtube Link](https://www.youtube.com/live/hG-WRFmMLD4?si=RMhmSn57Efid4AhB) | | Kubesimplify Community | We started from here and got a lot of support. Some of the mentions [Youtube Link](https://youtu.be/kCWAwXFnYic?si=A9OrTP_cLtwxnrKD), [Tweet](https://x.com/kubesimplify/status/1717393983675179076) etc. | diff --git a/content/en/docs/ksctl_k8s_bootstrap/k3s.md b/content/en/docs/ksctl_k8s_bootstrap/k3s.md index 8c486a5..71de474 100644 --- a/content/en/docs/ksctl_k8s_bootstrap/k3s.md +++ b/content/en/docs/ksctl_k8s_bootstrap/k3s.md @@ -11,7 +11,7 @@ K3s for self-managed Cluster on supported cloud providers ## Overview -K3s is a lightweight, certified Kubernetes distribution designed for resource-constrained environments. In ksctl, K3s is used for creating self-managed Kubernetes clusters with the following components: +K3s is a lightweight, certified Kubernetes distribution designed for resource-constrained environments. In kli, K3s is used for creating self-managed Kubernetes clusters with the following components: * **Control plane** (k3s server) - Manages the Kubernetes API server, scheduler, and controller manager * **Worker plane** (k3s agent) - Runs your workloads @@ -20,7 +20,7 @@ K3s is a lightweight, certified Kubernetes distribution designed for resource-co ## Architecture -ksctl deploys K3s in a high-availability configuration with: +kli deploys K3s in a high-availability configuration with: - Multiple control plane nodes for redundancy - External etcd cluster for reliable data storage @@ -29,13 +29,13 @@ ksctl deploys K3s in a high-availability configuration with: ## CNI Options -K3s in ksctl supports the following Container Network Interface (CNI) options: +K3s in kli supports the following Container Network Interface (CNI) options: * **Flannel** (default) - Simple overlay network provided by K3s * **None** - Disables the built-in CNI, allowing for installation of external CNIs like Cilium {{% alert color="info" title="Default CNI" %}} -The default CNI for K3s in ksctl is Flannel. +The default CNI for K3s in kli is Flannel. {{% /alert %}} To use an external CNI, select "none" during cluster creation. This will: @@ -45,15 +45,15 @@ To use an external CNI, select "none" during cluster creation. This will: ## Version Selection -ksctl allows you to choose specific K3s versions for your cluster. The tool validates versions against available releases from the K3s GitHub repository. +kli allows you to choose specific K3s versions for your cluster. The tool validates versions against available releases from the K3s GitHub repository. ![](/img/k3s-ver.png) -If no version is specified, ksctl will automatically use the latest stable K3s release. +If no version is specified, kli will automatically use the latest stable K3s release. ## Control Plane Configuration -The K3s control plane in ksctl is deployed with the following optimizations: +The K3s control plane in kli is deployed with the following optimizations: - Node taints to prevent workloads from running on control plane nodes - TLS configuration with certificates for secure communication @@ -62,7 +62,7 @@ The K3s control plane in ksctl is deployed with the following optimizations: ## Advanced Features -K3s in ksctl includes several advanced features: +K3s in kli includes several advanced features: - **HA Setup**: Multiple control plane nodes with an external etcd datastore - **Kubeconfig Management**: Automatic configuration of kubeconfig with the correct cluster endpoints @@ -71,12 +71,12 @@ K3s in ksctl includes several advanced features: ## Limitations -- K3s in ksctl is designed for self-managed clusters only +- K3s in kli is designed for self-managed clusters only - Some K3s-specific features may require additional manual configuration ## Next Steps -After deploying a K3s cluster with ksctl, you can: +After deploying a K3s cluster with kli, you can: 1. Access your cluster using the generated kubeconfig 2. Install additional components using Kubernetes package managers diff --git a/content/en/docs/roadmap.md b/content/en/docs/roadmap.md index 1446048..5e95419 100644 --- a/content/en/docs/roadmap.md +++ b/content/en/docs/roadmap.md @@ -68,7 +68,7 @@ All the below features will be moved to the Project Board and will be tracked th - Production stack for monitoring, security, to application specific application integrations like vault, kafka, etc. - Health checks of various k8s cluster - Role Based Access Control for any cluster -- Ability import any existing cluster and also to respect the existing state and not overwrite it with the new state from ksctl but to be able to manage only the resources which the tool has access +- Ability import any existing cluster and also to respect the existing state and not overwrite it with the new state from kli but to be able to manage only the resources which the tool has access - add initial production ready for cert manager + ingress controller (nginx) + gateway api - add initial production ready for monitoring (prometheus + grafana) tracing (jaeger) Opentelemtery support - add initial production ready for Networking (cilium) diff --git a/go.mod b/go.mod index f23d8d5..0b6ef05 100644 --- a/go.mod +++ b/go.mod @@ -3,8 +3,8 @@ module github.com/ksctl/docs go 1.23 require ( - github.com/FortAwesome/Font-Awesome v0.0.0-20240716171331-37eff7fa00de // indirect - github.com/google/docsy v0.11.0 // indirect + github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3 // indirect + github.com/google/docsy v0.13.0 // indirect github.com/google/docsy/dependencies v0.7.2 // indirect - github.com/twbs/bootstrap v5.3.3+incompatible // indirect + github.com/twbs/bootstrap v5.3.8+incompatible // indirect ) diff --git a/go.sum b/go.sum index 5b33c6c..5653326 100644 --- a/go.sum +++ b/go.sum @@ -1,10 +1,10 @@ github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= -github.com/FortAwesome/Font-Awesome v0.0.0-20240716171331-37eff7fa00de h1:JvHOfdSqvArF+7cffH9oWU8oLhn6YFYI60Pms8M/6tI= -github.com/FortAwesome/Font-Awesome v0.0.0-20240716171331-37eff7fa00de/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= -github.com/google/docsy v0.11.0 h1:QnV40cc28QwS++kP9qINtrIv4hlASruhC/K3FqkHAmM= -github.com/google/docsy v0.11.0/go.mod h1:hGGW0OjNuG5ZbH5JRtALY3yvN8ybbEP/v2iaK4bwOUI= +github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3 h1:/iluJkJiyTAdnqrw3Yi9rH2HNHhrrtCmj8VJe7I6o3w= +github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= +github.com/google/docsy v0.13.0 h1:Y1oy5SmQ0ikJJsvkuefEVZMj0MTXLmVfpXbt7Ytc7rc= +github.com/google/docsy v0.13.0/go.mod h1:1Fj1W1O3esZh7IBQ8XAYtxtg10udBXuGI89+LUQc1AU= github.com/google/docsy/dependencies v0.7.2 h1:+t5ufoADQAj4XneFphz4A+UU0ICAxmNaRHVWtMYXPSI= github.com/google/docsy/dependencies v0.7.2/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4= github.com/twbs/bootstrap v5.2.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= -github.com/twbs/bootstrap v5.3.3+incompatible h1:goFoqinzdHfkeegpFP7pvhbd0g+A3O2hbU3XCjuNrEQ= -github.com/twbs/bootstrap v5.3.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= +github.com/twbs/bootstrap v5.3.8+incompatible h1:eK1fsXP7R/FWFt+sSNmmvUH9usPocf240nWVw7Dh02o= +github.com/twbs/bootstrap v5.3.8+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= diff --git a/hugo.toml b/hugo.toml index 5db4ebf..21b7da2 100644 --- a/hugo.toml +++ b/hugo.toml @@ -1,5 +1,5 @@ -baseURL = "https://docs.ksctl.com" -title = "Ksctl Docs" +baseURL = "https://docs.kli.ksctl.com" +title = "kli Docs" # Language settings contentDir = "content/en" @@ -63,8 +63,8 @@ languageName ="English" # Weight used for sorting. weight = 1 [languages.en.params] -title = "Ksctl Docs" -description = "A Ksctl Docs page" +title = "Kli Docs" +description = "A Kli Docs page" [markup] [markup.goldmark] @@ -90,7 +90,7 @@ section = ["HTML", "print", "RSS"] [[params.versions]] version = "stable" - url = "https://docs.ksctl.com" + url = "https://docs.kli.ksctl.com" [params] @@ -118,7 +118,7 @@ archived_version = false # url_latest_version = "https://docs.ksctl.com/docs/stable" # Repository configuration (URLs for in-page links to opening issues and suggesting changes) -github_repo = "https://github.com/ksctl/docs" +github_repo = "https://github.com/ksctl/kli-docs" # An optional link to a related project repo. For example, the sibling repository where your product code lives. #github_project_repo = "https://github.com/google/docsy" @@ -158,8 +158,8 @@ showLightDarkModeMenu = true [params.ui.feedback] enable = true # The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful). -yes = 'Glad to hear it! Please tell us how we can improve.' -no = 'Sorry to hear that. Please tell us how we can improve.' +yes = 'Glad to hear it! Please tell us how we can improve.' +no = 'Sorry to hear that. Please tell us how we can improve.' # Adds a reading time to the top of each doc. # If you want this feature, but occasionally need to remove the Reading time from a single page, @@ -183,7 +183,7 @@ enable = false [[params.links.developer]] name = "GitHub" - url = "https://github.com/ksctl/docs" + url = "https://github.com/ksctl/kli-docs" icon = "fab fa-github" desc = "Development takes place here!" [[params.links.developer]] diff --git a/static/img/docusaurus.png b/static/img/docusaurus.png deleted file mode 100644 index f458149..0000000 Binary files a/static/img/docusaurus.png and /dev/null differ diff --git a/static/img/ksctl-logo.svg b/static/img/ksctl-logo.svg index d2a0951..00d1c2b 100644 --- a/static/img/ksctl-logo.svg +++ b/static/img/ksctl-logo.svg @@ -1,6 +1,52 @@ - + - - - + + + + + + + + + + + + + + + diff --git a/static/img/logo.svg b/static/img/logo.svg index 9db6d0d..00d1c2b 100644 --- a/static/img/logo.svg +++ b/static/img/logo.svg @@ -1 +1,52 @@ - \ No newline at end of file + + + + + + + + + + + + + + + + + +