ks

README

ks

ks is a tool which makes it be easy to work with KubeSphere.

Get started

Install it via: brew install linuxsuren/linuxsuren/ks

Install it via hd:

brew install linuxsuren/linuxsuren/hd
hd install kubesphere-sigs/ks

Features

All features below work with KubeSphere instead of other concept.

• Component Management
  • Enable (disable) components
  • Update a component manually or automatically
  • Output the logs of a KubeSphere component
  • Edit a KubeSphere component
  • Describe a KubeSphere component (wrapper of kubectl describe)
• Pipeline management
  • Create a Pipeline with java, go template
  • Edit a Pipeline without give the fullname (namespace/name)
• User Management
• Working with k3s via setting environment kubernetes_type=k3s
• KubeSphere installation
  • Install KubeSphere via ks-installer
  • Install KubeSphere via k3d
  • Install KubeSphere via kubekey
  • Install KubeSphere via kind

Component

➜  ~ kubectl ks com
Manage the components of KubeSphere

Usage:
  ks component [command]

Aliases:
  component, com

Available Commands:
  edit        Edit the target component
  enable      Enable or disable the specific KubeSphere component
  exec        Execute a command in a container.
  kill        Kill the pods of the components
  log         Output the log of KubeSphere component
  reset       Reset the component by name
  watch       Update images of ks-apiserver, ks-controller-manager, ks-console

Pipeline

➜  ~ kubectl ks pip
Usage:
  ks pipeline [flags]
  ks pipeline [command]

Aliases:
  pipeline, pip

Available Commands:
  create      Create a Pipeline in the KubeSphere cluster
  delete      Delete a specific Pipeline of KubeSphere DevOps
  edit        Edit the target pipeline
  view        Output the YAML format of a Pipeline

Flags:
  -h, --help   help for pipeline

Use "ks pipeline [command] --help" for more information about a command.

Installation

Install KubeSphere with kind or kk

Usage:
  ks install [command]

Available Commands:
  kind        Install KubeSphere with kind
  kk          Install KubeSphere with kubekey (aka kk)