README
¶
KWOK (Kubernetes WithOut Kubelet)
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.
So far we provide two tools:
- Kwok: Core of this repo. It simulates thousands of fake Nodes.
- Kwokctl: A CLI to facilitate creating and managing clusters simulated by Kwok.
Please see https://kwok-demo.netlify.app for more in-depth information. But it will be replaced in the future when https://kwok.sigs.k8s.io is available.
Community, discussion, contribution, and support
Learn how to engage with the Kubernetes community on the community page.
You can reach the maintainers of this project at:
Code of conduct
Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
pkg
|
|
|
apis/internalversion
Package internal implements the internal apiVersion of kwok's configuration
|
Package internal 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 |
|
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/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/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/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/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/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 with compose file.
|
Package compose implements the runtime.Runtime interface using the image with compose file. |
|
log
Package log wrappers slog for the kwok and kwokctl
|
Package log wrappers slog for the kwok and kwokctl |
|
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. |
|
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.