README
¶
KWOK (Kubernetes WithOut Kubelet)
KWOK is pronounced as /kwɔk/.
KWOK is a toolkit that enables setting up a cluster of thousands of Nodes in seconds. Under the scene, all Nodes are simulated to behave like real ones, so the overall approach employs a pretty low resource footprint that you can easily play around on your laptop.
What is KWOK?
KWOK stands for Kubernetes WithOut Kubelet. So far, it provides two tools:
kwokis the cornerstone of this project, responsible for simulating the lifecycle of fake nodes, pods, and other Kubernetes API resources.kwokctlis a CLI tool designed to streamline the creation and management of clusters, with nodes simulated bykwok.
Please see our website for more in-depth information.
Why KWOK?
- Lightweight: You can simulate thousands of nodes on your laptop without significant consumption of CPU or memory resources. Currently, KWOK can reliably maintain 1k nodes and 100k pods easily.
- Fast: You can create and delete clusters and nodes almost instantly, without waiting for boot or provisioning. Currently, KWOK can create 20 nodes or pods per second.
- Compatibility: KWOK works with any tools or clients that are compliant with Kubernetes APIs, such as kubectl, helm, kui, etc.
- Portability: KWOK has no specific hardware or software requirements. You can run it using pre-built images, once Docker or Nerdctl is installed. Alternatively, binaries are also available for all platforms and can be easily installed.
- Flexibility: You can configure different node types, labels, taints, capacities, conditions, etc., and you can configure different pod behaviors, status, etc. to test different scenarios and edge cases.
Community
See our own contributor guide and the Kubernetes community page.
Getting Involved
If you're interested in participating in future discussions or development related to KWOK, there are several ways to get involved:
- Slack: #kwok for general usage discussion, #kwok-dev for development discussion. (visit slack.k8s.io for a workspace invitation)
- Open Issues/PRs/Discussions in sigs.k8s.io/kwok
Code of conduct
Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
kwok
Package main is the entry point for the kwok binary.
|
Package main is the entry point for the kwok binary. |
|
kwokctl
Package main is the entry point for the kwokctl binary.
|
Package main is the entry point for the kwokctl binary. |
|
hack
|
|
|
gen_cmd_docs
Package main is a tool to generate the documentation for the kwok and kwokctl commands.
|
Package main is a tool to generate the documentation for the kwok and kwokctl commands. |
|
verify_boilerplate
Package main implements a simple boilerplate checker.
|
Package main implements a simple boilerplate checker. |
|
pkg
|
|
|
apis
Package apis contains API Schema definitions
|
Package apis contains API Schema definitions |
|
apis/config/v1alpha1
Package v1alpha1 implements the v1alpha1 apiVersion of kwok's configuration
|
Package v1alpha1 implements the v1alpha1 apiVersion of kwok's configuration |
|
apis/internalversion
Package internalversion implements the internal apiVersion of kwok's configuration
|
Package internalversion implements the internal apiVersion of kwok's configuration |
|
apis/v1alpha1
Package v1alpha1 implements the v1alpha1 apiVersion of kwok's configuration
|
Package v1alpha1 implements the v1alpha1 apiVersion of kwok's configuration |
|
config
Package config provides utilities to get configuration.
|
Package config provides utilities to get configuration. |
|
config/compatibility
Package compatibility provides compatible for old version of kwokctl.
|
Package compatibility provides compatible for old version of kwokctl. |
|
consts
Package consts defines the constants for building the project.
|
Package consts defines the constants for building the project. |
|
kwok/cmd
Package cmd defines a root command for the kwok.
|
Package cmd defines a root command for the kwok. |
|
kwok/cni
Package cni provides the core logic to call CNI.
|
Package cni provides the core logic to call CNI. |
|
kwok/controllers
Package controllers is the package that contains the core logic on pods and nodes simulation.
|
Package controllers is the package that contains the core logic on pods and nodes simulation. |
|
kwok/metrics
Package metrics implements the metrics server.
|
Package metrics implements the metrics server. |
|
kwok/metrics/cel
Package cel implements a metrics evaluator using the Common Expression Language (CEL).
|
Package cel implements a metrics evaluator using the Common Expression Language (CEL). |
|
kwok/server
Package server contains the kwok server.
|
Package server contains the kwok server. |
|
kwok/server/portforward
Package portforward contains server-side logic for handling port forwarding requests.
|
Package portforward contains server-side logic for handling port forwarding requests. |
|
kwok/server/remotecommand
Package remotecommand contains functions related to executing commands in and attaching to pods.
|
Package remotecommand contains functions related to executing commands in and attaching to pods. |
|
kwokctl/cmd
Package cmd defines a root command for the kwokctl.
|
Package cmd defines a root command for the kwokctl. |
|
kwokctl/cmd/create
Package create defines a parent command for cluster creation.
|
Package create defines a parent command for cluster creation. |
|
kwokctl/cmd/create/cluster
Package cluster contains a command to create a cluster.
|
Package cluster contains a command to create a cluster. |
|
kwokctl/cmd/delete
Package delete defines a parent command for cluster deletion.
|
Package delete defines a parent command for cluster deletion. |
|
kwokctl/cmd/delete/cluster
Package cluster contains a command to delete a cluster.
|
Package cluster contains a command to delete a cluster. |
|
kwokctl/cmd/etcdctl
Package etcdctl provides a method for users to use the etcdctl binary in a cluster.
|
Package etcdctl provides a method for users to use the etcdctl binary in a cluster. |
|
kwokctl/cmd/export
Package export implements the `export` command
|
Package export implements the `export` command |
|
kwokctl/cmd/export/logs
Package logs implements the `logs` command
|
Package logs implements the `logs` command |
|
kwokctl/cmd/get
Package get defines a parent command for getting artifacts, clusters and kubeconfig.
|
Package get defines a parent command for getting artifacts, clusters and kubeconfig. |
|
kwokctl/cmd/get/artifacts
Package artifacts contains a command to list binaries or images used by a cluster.
|
Package artifacts contains a command to list binaries or images used by a cluster. |
|
kwokctl/cmd/get/clusters
Package clusters contains a command to list existing clusters.
|
Package clusters contains a command to list existing clusters. |
|
kwokctl/cmd/get/kubeconfig
Package kubeconfig contains a command to prints cluster kubeconfig
|
Package kubeconfig contains a command to prints cluster kubeconfig |
|
kwokctl/cmd/kubectl
Package kubectl contains a command to use the kubectl in a cluster.
|
Package kubectl contains a command to use the kubectl in a cluster. |
|
kwokctl/cmd/logs
Package logs contains a command to log a component of a cluster.
|
Package logs contains a command to log a component of a cluster. |
|
kwokctl/cmd/snapshot
Package snapshot contains a parent command which snapshots one of cluster.
|
Package snapshot contains a parent command which snapshots one of cluster. |
|
kwokctl/cmd/snapshot/export
Package export is the export of external cluster
|
Package export is the export of external cluster |
|
kwokctl/cmd/snapshot/restore
Package restore provides a command to restore the snapshot of a cluster.
|
Package restore provides a command to restore the snapshot of a cluster. |
|
kwokctl/cmd/snapshot/save
Package save provides a command to save the snapshot of a cluster.
|
Package save provides a command to save the snapshot of a cluster. |
|
kwokctl/cmd/start
Package start implements the start command
|
Package start implements the start command |
|
kwokctl/cmd/start/cluster
Package cluster implements the start cluster command
|
Package cluster implements the start cluster command |
|
kwokctl/cmd/stop
Package stop implements the stop command
|
Package stop implements the stop command |
|
kwokctl/cmd/stop/cluster
Package cluster implements the stop cluster command
|
Package cluster implements the stop cluster command |
|
kwokctl/components
Package components contains some helper functions related to the components.
|
Package components contains some helper functions related to the components. |
|
kwokctl/k8s
Package k8s contains some helper functions related to the Kubernetes.
|
Package k8s contains some helper functions related to the Kubernetes. |
|
kwokctl/pki
Package pki is the package that provides functions to generate certificates
|
Package pki is the package that provides functions to generate certificates |
|
kwokctl/runtime
Package runtime defines the interface of a cluster operation and providers a register method.
|
Package runtime defines the interface of a cluster operation and providers a register method. |
|
kwokctl/runtime/binary
Package binary implements the runtime.Runtime interface using the binaries.
|
Package binary implements the runtime.Runtime interface using the binaries. |
|
kwokctl/runtime/compose
Package compose implements the runtime.Runtime interface using the image.
|
Package compose implements the runtime.Runtime interface using the image. |
|
kwokctl/runtime/kind
Package kind implements the runtime.Runtime interface using the kind.
|
Package kind implements the runtime.Runtime interface using the kind. |
|
kwokctl/snapshot
Package snapshot is the snapshot of cluster
|
Package snapshot is the snapshot of cluster |
|
log
Package log wrappers slog for the kwok and kwokctl
|
Package log wrappers slog for the kwok and kwokctl |
|
utils/client
Package client is the client for kubeconfig
|
Package client is the client for kubeconfig |
|
utils/envs
Package envs provides utilities to get environment variables.
|
Package envs provides utilities to get environment variables. |
|
utils/exec
Package exec provides utilities to execute commands.
|
Package exec provides utilities to execute commands. |
|
utils/expression
Package expression provides utilities to evaluate expressions.
|
Package expression provides utilities to evaluate expressions. |
|
utils/file
Package file contains utilities for operating on files.
|
Package file contains utilities for operating on files. |
|
utils/format
Package format contains utilities for formatting data.
|
Package format contains utilities for formatting data. |
|
utils/image
Package image contains utilities for manipulating images.
|
Package image contains utilities for manipulating images. |
|
utils/kubeconfig
Package kubeconfig provides utilities to manipulate kubeconfig.
|
Package kubeconfig provides utilities to manipulate kubeconfig. |
|
utils/maps
Package maps provides utilities to manipulate maps.
|
Package maps provides utilities to manipulate maps. |
|
utils/net
Package net contains utilities for manipulating network.
|
Package net contains utilities for manipulating network. |
|
utils/patch
Package patch provides a simple wrapper around the strategic merge patch
|
Package patch provides a simple wrapper around the strategic merge patch |
|
utils/path
Package path contains utilities for manipulating file paths.
|
Package path contains utilities for manipulating file paths. |
|
utils/pools
Package pools provides a generic pool implementation.
|
Package pools provides a generic pool implementation. |
|
utils/signals
Package signals is the package that provide helper functions to receive signals from the system.
|
Package signals is the package that provide helper functions to receive signals from the system. |
|
utils/slices
Package slices provides utilities to manipulate slices.
|
Package slices provides utilities to manipulate slices. |
|
utils/tail
Package tail provides utilities to tail lines.
|
Package tail provides utilities to tail lines. |
|
utils/version
Package version provides a simple way to parse versions.
|
Package version provides a simple way to parse versions. |
|
utils/wait
Package wait provides tools for polling or listening for changes
|
Package wait provides tools for polling or listening for changes |
|
utils/yaml
Package yaml provides tools for encoding and decoding YAML.
|
Package yaml provides tools for encoding and decoding YAML. |
|
Package stages contains node and pod stages used by controllers.
|
Package stages contains node and pod stages used by controllers. |
Click to show internal directories.
Click to hide internal directories.