Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions assets/scss/_variables_project.scss
Original file line number Diff line number Diff line change
@@ -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'; */
Expand Down
11 changes: 6 additions & 5 deletions content/en/_index.md
Original file line number Diff line number Diff line change
@@ -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)
<img alt="kli Logo" class="mb-4" src="/img/kli-logo.svg" width="200" />
<br>

<a class="btn btn-lg btn-primary me-3 mb-4" href="docs/">
Learn More <i class="fas fa-arrow-alt-circle-right ms-2"></i>
Expand All @@ -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 %}}

Expand Down Expand Up @@ -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 %}}

Expand Down
2 changes: 1 addition & 1 deletion content/en/blog/announcements/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ weight: 20
---

{{% pageinfo %}}
All the Ksctl announcements
All the kli announcements
{{% /pageinfo %}}
22 changes: 11 additions & 11 deletions content/en/blog/announcements/v2_6_x.md
Original file line number Diff line number Diff line change
@@ -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**

Expand Down Expand Up @@ -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

Expand All @@ -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/)

22 changes: 11 additions & 11 deletions content/en/blog/announcements/v2_7_x.md
Original file line number Diff line number Diff line change
@@ -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**

Expand All @@ -23,7 +23,7 @@ The new cluster summary and recommendation feature provides you with a comprehen

<video src="/img/cluster-summary.mp4" width="auto" height="450" controls></video>

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`.

Expand All @@ -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/)


2 changes: 1 addition & 1 deletion content/en/blog/findings/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ weight: 20
---

{{% pageinfo %}}
Ksctl documentation
kli documentation
{{% /pageinfo %}}
2 changes: 1 addition & 1 deletion content/en/docs/Concepts/ksctl cloud controller.md
Original file line number Diff line number Diff line change
@@ -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]
---

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/Concepts/ksctl distro controller.md
Original file line number Diff line number Diff line change
@@ -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]
---

Expand Down
14 changes: 7 additions & 7 deletions content/en/docs/Concepts/ksctl manager.md
Original file line number Diff line number Diff line change
@@ -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]
---

Expand All @@ -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**
24 changes: 12 additions & 12 deletions content/en/docs/Concepts/smart-optimization.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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

Expand Down Expand Up @@ -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
Expand All @@ -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.
14 changes: 7 additions & 7 deletions content/en/docs/Getting started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}}
Expand All @@ -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 >}}
Expand Down Expand Up @@ -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" %}}
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/Ksctl Cluster Mgt/_index.md
Original file line number Diff line number Diff line change
@@ -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]
---
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/Ksctl Cluster Mgt/stacks.md
Original file line number Diff line number Diff line change
@@ -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]
---
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ menu:
---

{{% pageinfo %}}
Ksctl documentation
kli documentation
{{% /pageinfo %}}
4 changes: 2 additions & 2 deletions content/en/docs/cni/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Container Network Interface (CNI)
description: Supported CNI by Ksctl
description: Supported CNI by kli
tags: [cni, addon]
---

Expand All @@ -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**)

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/cni/cilium.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}}
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/cni/flannel.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}}
Expand Down
Loading