| +| Azure | Azure Open Source Program Office🎉 Exciting news!
— kubesimplify (@kubesimplify) November 15, 2023
🚀 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
| | 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 |🎉 Exciting news!
— kubesimplify (@kubesimplify) November 15, 2023
🚀 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
| +| Kubernetes Architect |ksctl is a simple multi-environment Kubernetes management CLI tool
— Kubernetes Architect (@K8sArchitect) May 11, 2023
➤ https://t.co/QU9gR9BzYj
| | 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.  -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 f458149e3c8f53335f28fbc162ae67f55575c881..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 5142 zcma)=cTf{R(}xj7f`AaDml%oxrAm_`5IRVc-jPtHML-0kDIiip57LWD@4bW~(nB|) z34|^sbOZqj<;8ct`Tl-)=Jw`pZtiw=e$UR_Mn2b8rM$y@hlq%XQe90+?|Mf68-Ux_ zzTBiDn~3P%oVt>{f$z+YC7A)8ak`PktoIXDkpXod+*gQW4fxTWh!EyR9`L|fi4YlH z{IyM;2-~t3s~J-KF~r-Z)FWquQCfG*TQy6w*9#k2zUWV-+tCNvjrtl9(o}V>-)N!) ziZgEgV>EG+b(j@ex!dx5@@nGZim*UfFe<+e;(xL|j-Pxg(PCsTL~f^br)4{n5?OU@ z*pjt{4tG{qBcDSa3;yKlopENd6Yth=+h9)*lkjQ0NwgOOP+5Xf?SEh$x6@l@ZoHoYGc5~d2>pO43s3R|*yZw9yX^kEyUV2Zw1%J4o`X!BX>CwJ zI8rh1-NLH^x1LnaPGkikli is a simple multi-environment Kubernetes management CLI tool
— Kubernetes Architect (@K8sArchitect) May 11, 2023
➤ https://t.co/QU9gR9BzYj
&L{&Gf6-TKsE35Pv%1
z;bJcxPO+A9rPGsUs=rX(9^vydg2q`rU~otOJ37zb{Z{|)bAS!v3PQ5?l$+LkpGNJq
zzXDLcS$vMy|9sIidXq$NE6A-^v@)Gs_x_3wYxF%y*_e{B6FvN-enGst&nq0z8Hl0<
z*p6ZXC*su`M{y|Fv(Vih_F|83=)A6ay-v_&ph1Fqqcro{oeu99Y0*FVvRFmbFa@gs
zJ*g%Gik{Sb+_zNNf?Qy7PTf@S*dTGt#O%a9WN1KVNj`q$1Qoiwd|y&_v?}bR#>fdP
zSlMy2#KzRq4%?