ksail

[!NOTE] A larger restructuring is on the way, where all embedded binaries are extracted into their own .NET project. This makes it much easier for me to maintain. However this also means that KSail will not see bug fixes and feature releases before late this year, as the changes are expected to take a few months to get right. Follow the progress on:

• devantler/dotnet-kubernetes-resource-generator
• devantler/dotnet-kubernetes-resource-provisioner
• devantler/dotnet-kubernetes-cluster-provisioner
• devantler/dotnet-sops-manager
• devantler/dotnet-template-engine
• devantler/dotnet-keys
• devantler/dotnet-cli-runner
• devantler/dotnet-age-cli
• devantler/dotnet-flux-cli
• devantler/dotnet-k3d-cli
• devantler/dotnet-k9s-cli
• devantler/dotnet-kind-cli
• devantler/dotnet-kubeconform-cli
• devantler/dotnet-kustomize-cli
• devantler/dotnet-sops-cli

🛥️🐳 KSail

Show/hide folder structure

``` . ├── .github │   └── workflows ├── .vscode ├── docs │   └── images ├── scripts ├── src │   └── KSail │   ├── Arguments │   ├── CLIWrappers │   ├── Commands │   │   ├── Check │   │   │   └── Handlers │   │   ├── Debug │   │   │   └── Handlers │   │   ├── Down │   │   │   ├── Handlers │   │   │   └── Options │   │   ├── Init │   │   │   ├── Generators │   │   │   └── Handlers │   │   ├── Lint │   │   │   └── Handlers │   │   ├── List │   │   │   └── Handlers │   │   ├── Root │   │   │   └── Handlers │   │   ├── SOPS │   │   │   ├── Handlers │   │   │   └── Options │   │   ├── Start │   │   │   └── Handlers │   │   ├── Stop │   │   │   └── Handlers │   │   ├── Up │   │   │   ├── Handlers │   │   │   └── Options │   │   └── Update │   │   ├── Handlers │   │   └── Options │   ├── Enums │   ├── Extensions │   ├── Models │   │   ├── K3d │   │   ├── KSail │   │   ├── Kubernetes │   │   │   └── FluxKustomization │   │   └── SOPS │   ├── Options │   ├── Provisioners │   │   ├── ContainerEngine │   │   ├── ContainerOrchestrator │   │   ├── GitOps │   │   ├── KubernetesDistribution │   │   └── SecretManager │   └── assets │   ├── binaries │   └── templates │   ├── k3d │   ├── kubernetes │   └── sops └── tests └── KSail.Tests.Integration ├── Commands │   ├── Check │   ├── Debug │   ├── Down │   ├── Lint │   ├── List │   ├── Root │   ├── SOPS │   ├── Up │   └── Update └── TestUtils 74 directories ```

Getting Started

Prerequisites

[!NOTE] On MacOS (darwin) you need to “Allow the default Docker socket to be used (requires password)” in Docker Desktop settings.

Show me how!


KSail supports MacOS and Linux on the following platforms:

• darwin-amd64 
• darwin-arm64 
• linux-amd64 🐧
• linux-arm64 🐧

If you are using Windows, you can use WSL2 to run KSail.

Installation

With Homebrew:

brew tap devantler/formulas
brew install ksail

Manually:

1. Download the latest release from the releases page.
2. Make the binary executable: chmod +x ksail.
3. Move the binary to a directory in your $PATH: mv ksail /usr/local/bin/ksail.

Usage

Getting started with KSail is easy. Here are a few commands to get you started:

ksail init <name-of-cluster> - To initialize your cluster.

ksail up <name-of-cluster> - To provision your cluster.

From there, you can make some changes to your manifest files, and when you are ready to apply them, you can run:

ksail update <name-of-cluster> - To update your cluster.

At some point, you might encounter an issue, and wonder what is going on. In that case, you can run:

ksail check - To check the status of your cluster reconciliations.

And for more advanced debugging, you can run:

ksail debug - To debug your cluster with the K9s tool.

Finally, when you are done working with your cluster, you can run:

ksail stop <name-of-cluster> - To stop your cluster, so you can continue working on it later.

Or if you really want to get rid of it for now, you can run:

ksail down <name-of-cluster> - To dismantle your cluster and remove its resources.

Documentation

[!NOTE] The documentation is a work in progress. When it is more mature, it will be made available on . For now it includes the information that was originally available in this README with a few additions.

• Overview
• Getting Started
• Configuration
• Structure
• CI
• KSail CLI
• Supported Tooling
• FAQ
• Roadmap

Related Projects

• OCI Artifacts - Ready-to-deploy OCI artifacts for Flux GitOps-enabled clusters.
• Homelab - My personal homelab setup, including an example of how I use KSail to manage my Homelab cluster.

Star History

This site is open source. Improve this page.