ksctl / docs

Simplified Kubernetes Clusters Lifecycle Management (Docs)

Ksctl: Simplified Kubernetes Clusters Lifecycle Management

Status: Technical Preview

It aims to simplify a collection of kubernetes clusters running on different cloud providers. It provides a simple and intuitive interface for managing Kubernetes clusters. It is designed to be efficient and can perform tasks quickly and without the need for additional tools. It is a powerful tool that can be used to perform a wide range of tasks.

It is already a valuable tool for developers who want to manage Kubernetes clusters using our CLI.

So far what have we achieved?

Cluster creation, deletion, getting cluster info, accessing it. It uses cloud providers managed offerrings For Example: AKS, EKS, etc. not just that we also have self-managed kubernetes cluster support where you can pick and choose between different bootstrap tools like k3s or kubeadm. And now we are moving towards the next phase of the project where we will be adding more features like cluster scaling, cluster upgrade, production grade apps, and many more.

See the FAQ for more details about how ksctl is different from alternatives.

All Repositories under (Ksctl Org)

Repo	Description
Ksctl	It provides the core components aka the internals of ksctl features
Ksctl CLI	It uses the ksctl repo to make a CLI tool
Ksctl Docs	It's for documentation purpose and to host the ksctl website

Getting Started guide

Getting Started guide

Usage

Please refer to the CLI Reference guide

Contribution Guidelines

Please refer to our contribution guide if you wish to contribute to the project 😄

Thanks to all the contributors ❤️

Link to Contributors

docs's Issues

Writing about various features ksctl provides

### Tasks
- [x] Adding the purpose
- [x] what all challenges it resolves
- [x] how it achieves
- [x] what are its functionalities
- [ ] demo on what all things ksctl provides

[DOCS] Add a readme

I think it might be a good idea to add a README file which tells that this is the documentation repository of ksctl and it can link to the main repo

Refactor(Maintainer)!: Addition of maintainer info in docs website

@Horiodino can you update your info?
https://github.com/ksctl/docs/blob/main/content/en/docs/maintainers.md

[Bug Report]: Misleading sub-heading of different cloud providers

Bug Title

Misleading sub-heading of different cloud providers

Steps to Reproduce

1. Go to the Cloud provider page
2. Check the sub-headings below of each cloud provider

Expected Behavior

Sub-headings should be as per the name of the cloud provider used in that heading.

Actual Behavior

In many sub-headings "Azure" is written

Environment

Not applicable

Additional Context

No response

Confirmation

• I have searched the existing issues and this is a new and unique bug report.
• I agree to provide follow-up information if needed.

Scope of changes

• Cli
• UI
• Docs

Agreement

• I agree to engage in constructive discussion and follow the Contribution Guidelines.

enhancement(modules)!: Need to update the go.mod files and also any references

Task

ksctl/ksctl#295

bug: missing environment variable for using the experiemental application feature

What

missing setting environment variable from the docs for trying out the installing applications and custom CNI plugin.

Refer
https://github.com/kubesimplify/ksctl-docs/blob/36bf123038089860cd3fe7948ac3e208fac807b5/content/en/blog/new-features/2023-10-09-install-applications.md

Solution

• add this to resolve

export KSCTL_FEATURE_FLAG_APPLICATIONS="true"

[Enhancement Proposal]: Create docs for kubeadm support

Enhancement Title

added kubeadm support

Summary of the Enhancement

update the info on how to use the beta feature kubeadm

Motivation and Goals

docs to be updated

Detailed Design

NA

Alternatives

No response

Scope of changes

• Cli
• UI
• Docs

Agreement

• I agree to engage in constructive discussion and follow the Contribution Guidelines.

enhancement: document on the various aspects of ksctl

Why do we need it?

Add the note to docs

• if the controlplane is dead what are the ways to recover it
• what are the different settings used(default)
• what all things ksctl doesn't manage

What it will bring?

enhancement: add commit convention to the contribution guide

Here is the Reference for the conventional commits, signoff

[Enhancement Proposal]: Update docs wrt to etcd support

Enhancement Title

etcd support and deprecation of mysql

Summary of the Enhancement

This Docs is related to

• ksctl/ksctl#306

Motivation and Goals

To update the documentation for the datastore

Detailed Design

NA

Alternatives

No response

Scope of changes

• Cli
• UI
• Docs

Agreement

• I agree to engage in constructive discussion and follow the Contribution Guidelines.

[Enhancement Proposal]: Addition of an option to join the discord community of ksctl

Enhancement Title

Addition of an option to join the discord community of ksctl

Summary of the Enhancement

Just like below we have a section for (Contributors welcome of github), (Follow us of twitter), similarly there should be an option to join the discord community of ksctl just beside these 2 sections.

Motivation and Goals

• It will help fellow visitors to join the ksctl community.
• It will also help to fill the blank part which is not looking good.

Detailed Design

• Already explained in description part

Alternatives

No response

Scope of changes

• Cli
• UI
• Docs

Agreement

• I agree to engage in constructive discussion and follow the Contribution Guidelines.