Getting Started #

This document walks you through how you can get started with KWOK easily.

Getting started with an open project like KWOK can be a great way to learn more about Kubernetes. Here are some tips to help you get started.

Basic Usage #

• Install - Install kwokctl and kwok
• kwok Manages Nodes and Pods - Basic operations of kwok to manage Nodes and Pods
• kwok - maintain Nodes heartbeat and Pods status.
  • kwok in Cluster - Installing kwok in a cluster
  • kwok out of Cluster - Run kwok out of your cluster
• kwokctl - cluster creation, etcd snapshot, etc.
  • kwokctl Manages Clusters - Create/Delete a cluster where all nodes are managed by kwok
  • kwokctl Snapshots Cluster - Save/Restore the Etcd data of a cluster created by kwokctl
• All in One Image - Create a cluster with an all-in-one image easily

Configuration #

If any special concerns, you can configure KWOK with the following options:

• Configuration
• Stages
• Pod Interaction
  • PortForward
  • Exec
  • Logs
  • Attach
• Metrics
  • ResourceUsage

I hope this helps you get started with KWOK! Good luck and have fun!