Note

Ahoy, matey! Gather 'round and lend an ear, for a grand overhaul be on the horizon! All them embedded binaries be set to sail into their own .NET project, makin' it smoother fer me to keep 'em shipshape. But beware, this mighty endeavor means KSail won't be seein' any bug fixes or new features 'til the end of the year, as this here voyage will take a few moons to chart right.

Keep yer spyglass fixed on the progress at:

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

🛥️🐳 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), ye need to "Allow the default Docker socket to be used (requires password)" in Docker Desktop settings.

Show me how, ye scallywag!

KSail supports MacOS and Linux on the followin' platforms:

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

If ye be usin' Windows, ye 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 yer $PATH: mv ksail /usr/local/bin/ksail.

Usage

Gettin' started with KSail be as easy as plunderin' treasure. Here be a few commands to get ye goin':

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

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

From there, ye can make some changes to yer manifest files, and when ye be ready to apply 'em, ye can run:

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

At some point, ye might encounter an issue and wonder what be goin' on. In that case, ye can run:

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

And for more advanced debuggin', ye can run:

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

Finally, when ye be done workin' with yer cluster, ye can run:

ksail stop <name-of-cluster> - To stop yer cluster, so ye can continue workin' on it later.

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

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

Documentation

Note

The documentation be a work in progress. When it be more mature, it will be made available on <ksail.devantler.com>. 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

Sub-projects

• devantler/dotnet-kubernetes-generator - Generators to conjure Kubernetes resources with ksail init and ksail gen.
• devantler/dotnet-kubernetes-provisioner - Provisioners to provision K3d, Flux, secrets, and more.
• devantler/dotnet-key-manager - A key manager to guard yer local Age keys.
• devantler/dotnet-template-engine - A template engine to support code generation of non-serializable content.
• devantler/dotnet-keys - A library with key models, like the Age key model.
• devantler/dotnet-cli-runner - An implementation atop CLI Wrap to support runnin' different binaries from C# code.
• devantler/dotnet-age-cli - A library that embeds and provides an API for the Age CLI.
• devantler/dotnet-flux-cli - A library that embeds and provides an API for the Flux CLI.
• devantler/dotnet-k3d-cli - A library that embeds and provides an API for the K3d CLI.
• devantler/dotnet-k9s-cli - A library that embeds and provides an API for the K9s CLI.
• devantler/dotnet-kind-cli - A library that embeds and provides an API for the Kind CLI.
• devantler/dotnet-kubeconform-cli - A library that embeds and provides an API for the Kubeconform CLI.
• devantler/dotnet-kustomize-cli - A library that embeds and provides an API for the Kustomize CLI.
• devantler/dotnet-sops-cli - A library that embeds and provides an API for the SOPS CLI.

Related Projects

• devantler/homelab - My personal homelab setup, including an example of how I use KSail to manage my Homelab cluster.

Star History