Evaluate the other promising contextual logger

`KWOK` (`K`ubernetes `W`ith`O`ut `K`ubelet)

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:

kwok is the cornerstone of this project, responsible for simulating the lifecycle of fake nodes, pods, and other Kubernetes API resources.
kwokctl is a CLI tool designed to streamline the creation and management of clusters, with nodes simulated by kwok.

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.

	- name: Test Snapshot
	if: ${{ matrix.kwokctl-runtime != 'nerdctl' }} # TODO: Let the test pass with nerdctl
	shell: bash
	run: \|
	./hack/e2e-test.sh kwokctl/kwokctl_${{ matrix.kwokctl-runtime }}_snapshot

	// TODO: nerdctl does not support 'compose start' in v1.1.0 or earlier
	// Support in https://github.com/containerd/nerdctl/pull/1656 merge into the main branch, but there is no release
	subcommand := []string{"start"}
	if conf.Options.Runtime == consts.RuntimeTypeNerdctl {
	subcommand = []string{"up", "-d"}
	}

	if conf.Options.Runtime == consts.RuntimeTypeNerdctl {
	backupFilename := c.GetWorkdirPath("restart.db")
	fi, err := os.Stat(backupFilename)
	if err == nil {
	if fi.IsDir() {
	return fmt.Errorf("wrong backup file %s, it cannot be a directory, please remove it", backupFilename)
	}
	if err := c.SnapshotRestore(ctx, backupFilename); err != nil {
	return fmt.Errorf("failed to restore cluster data: %w", err)
	}
	if err := os.Remove(backupFilename); err != nil {
	return fmt.Errorf("failed to remove backup file: %w", err)
	}
	} else if !os.IsNotExist(err) {
	return err
	}
	}

	// TODO: nerdctl does not support 'compose stop' in v1.0.0 or earlier
	subcommand := "stop"
	if conf.Options.Runtime == consts.RuntimeTypeNerdctl {
	subcommand = "down"
	err := c.SnapshotSave(ctx, c.GetWorkdirPath("restart.db"))
	if err != nil {
	return fmt.Errorf("failed to snapshot cluster data: %w", err)
	}
	}


	KWOK_IMAGE ?= $(STAGING_IMAGE_PREFIX)/kwok

	CLUSTER_IMAGE ?= $(STAGING_IMAGE_PREFIX)/cluster

kubernetes-sigs / kwok Goto Github PK

kwok's Introduction

KWOK (Kubernetes WithOut Kubelet)

What is KWOK?

Why KWOK?

Community

Getting Involved

Code of conduct

kwok's People

Contributors

Stargazers

Watchers

Forkers

kwok's Issues

What would you like to be added?

Provides generic functions that enable it to simulate data for any indicator.

Why is this needed?

What would you like to be added?

Why is this needed?

Which jobs are failing?

Which tests are failing?

Since when has it been failing?

Reason for failure (if possible)

Anything else we need to know?

Release Checklist

Changelog

Artifacts

Release Checklist

Changelog

How to use it?

What happened?

What did you expect to happen?

How can we reproduce it (as minimally and precisely as possible)?

Anything else we need to know?

OS version

On Darwin:

paste output here

On Windows:

paste output here

What would you like to be added?

Why is this needed?

What would you like to be added?

Why is this needed?

How to do

Install golangci-lint

Uncomment/Add on the checks you want to cleanup

Check

Clean up

Example

What would you like to be added?

Why is this needed?

What would you like to be added?

Why is this needed?

What would you like to be added?

Why is this needed?

What would you like to be added?

Why is this needed?

What would you like to be added?

Why is this needed?

What would you like to be added?

Why is this needed?

Goals

Design 1

Design 2

Which jobs are failing?

Which tests are failing?

Since when has it been failing?

Reason for failure (if possible)

Anything else we need to know?

What would you like to be added?

Why is this needed?

How to use it?

What happened?

What did you expect to happen?

How can we reproduce it (as minimally and precisely as possible)?

Anything else we need to know?

OS version

On Darwin:

paste output here

On Windows:

`KWOK` (`K`ubernetes `W`ith`O`ut `K`ubelet)