Skip to content

Commit

Permalink
Add support to check dep tools (#124)
Browse files Browse the repository at this point in the history
  • Loading branch information
LinuxSuRen authored May 4, 2021
1 parent a8a0a0a commit 0031ef7
Show file tree
Hide file tree
Showing 10 changed files with 168 additions and 60 deletions.
7 changes: 7 additions & 0 deletions .gitpod.Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
FROM gitpod/workspace-full

# Install custom tools, runtimes, etc.
# For example "bastet", a command-line tetris clone:
# RUN brew install bastet
#
# More information: https://www.gitpod.io/docs/config-docker/
5 changes: 5 additions & 0 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
image:
file: .gitpod.Dockerfile

tasks:
- init: make
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,7 @@ image: build-linux

image-push:
docker push surenpi/ks

update:
git fetch
git reset --hard origin/$(shell git branch --show-current)
56 changes: 27 additions & 29 deletions README-zh.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/LinuxSuRen/ks)
[![](https://goreportcard.com/badge/linuxsuren/ks)](https://goreportcard.com/report/linuxsuren/ks)
[![](http://img.shields.io/badge/godoc-reference-5272B4.svg?style=flat-square)](https://godoc.org/github.com/linuxsuren/ks)
[![Contributors](https://img.shields.io/github/contributors/linuxsuren/ks.svg)](https://github.com/linuxsuren/ks/graphs/contributors)
Expand All @@ -6,39 +7,36 @@

# ks

`ks` is a tool which makes it be easy to work with [KubeSphere](https://github.com/kubesphere/kubesphere).
`ks` [KubeSphere](https://github.com/kubesphere/kubesphere) 的命令行客户端,可以简化用户、开发者的日常操作。

# Get started

Install it via: `brew install linuxsuren/linuxsuren/ks`
通过 brew 安装: `brew install linuxsuren/linuxsuren/ks`

Install it via [hd](https://github.com/linuxsuren/http-downloader):
通过 [hd](https://github.com/linuxsuren/http-downloader) 安装: `hd install linuxsuren/ks`

```
hd install linuxsuren/ks
```
# 特色功能

以下的表述默认是以 [KubeSphere](https://github.com/kubesphere/kubesphere) 为上下文的:

* 组件管理
* 启用、禁用组件
* 手动(或自动)更新指定组件
* 输出组件日志
* 编辑组件
* 查看组件的事件(也就是命令 kubectl describe 的包装)
* 流水线管理
* 通过 java, go 等模板创建流水线
* 编辑流水线
* 重置用户密码
* 支持通过设置环境变量 `kubernetes_type=k3s` 操作 [k3s](https://github.com/k3s-io/k3s)
* 安装 KubeSphere
* 通过 [ks-installer](https://github.com/kubesphere/ks-installer) 安装
* 通过 [k3d](https://github.com/rancher/k3d) 安装
* 通过 [kubekey](https://github.com/kubesphere/kubekey) 安装
* 通过 [kind](https://github.com/kubernetes-sigs/kind) 安装

# Features

All features below work with [KubeSphere](https://github.com/kubesphere/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](https://github.com/k3s-io/k3s) via setting environment `kubernetes_type=k3s`
* KubeSphere installation
* Install KubeSphere via [ks-installer](https://github.com/kubesphere/ks-installer)
* Install KubeSphere via [k3d](https://github.com/rancher/k3d)
* Install KubeSphere via [kubekey](https://github.com/kubesphere/kubekey)
* Install KubeSphere via [kind](https://github.com/kubernetes-sigs/kind)
## Component
## 组件

```
➜ ~ kubectl ks com
Expand All @@ -60,7 +58,7 @@ Available Commands:
watch Update images of ks-apiserver, ks-controller-manager, ks-console
```

## Pipeline
## 流水线

```
➜ ~ kubectl ks pip
Expand All @@ -83,7 +81,7 @@ Flags:
Use "ks pipeline [command] --help" for more information about a command.
```

## Installation
## 安装

```
Install KubeSphere with kind or kk
Expand Down
56 changes: 30 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/LinuxSuRen/ks)
[![](https://goreportcard.com/badge/linuxsuren/ks)](https://goreportcard.com/report/linuxsuren/ks)
[![](http://img.shields.io/badge/godoc-reference-5272B4.svg?style=flat-square)](https://godoc.org/github.com/linuxsuren/ks)
[![Contributors](https://img.shields.io/github/contributors/linuxsuren/ks.svg)](https://github.com/linuxsuren/ks/graphs/contributors)
Expand All @@ -6,36 +7,39 @@

# ks

`ks` [KubeSphere](https://github.com/kubesphere/kubesphere) 的命令行客户端,可以简化用户、开发者的日常操作。
`ks` is a tool which makes it be easy to work with [KubeSphere](https://github.com/kubesphere/kubesphere).

# Get started

通过 brew 安装: `brew install linuxsuren/linuxsuren/ks`
Install it via: `brew install linuxsuren/linuxsuren/ks`

通过 [hd](https://github.com/linuxsuren/http-downloader) 安装: `hd install linuxsuren/ks`
Install it via [hd](https://github.com/linuxsuren/http-downloader):

# 特色功能

以下的表述默认是以 [KubeSphere](https://github.com/kubesphere/kubesphere) 为上下文的:

* 组件管理
* 启用、禁用组件
* 手动(或自动)更新指定组件
* 输出组件日志
* 编辑组件
* 查看组件的事件(也就是命令 kubectl describe 的包装)
* 流水线管理
* 通过 java, go 等模板创建流水线
* 编辑流水线
* 重置用户密码
* 支持通过设置环境变量 `kubernetes_type=k3s` 操作 [k3s](https://github.com/k3s-io/k3s)
* 安装 KubeSphere
* 通过 [ks-installer](https://github.com/kubesphere/ks-installer) 安装
* 通过 [k3d](https://github.com/rancher/k3d) 安装
* 通过 [kubekey](https://github.com/kubesphere/kubekey) 安装
* 通过 [kind](https://github.com/kubernetes-sigs/kind) 安装
```
hd install linuxsuren/ks
```

## 组件
# Features

All features below work with [KubeSphere](https://github.com/kubesphere/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](https://github.com/k3s-io/k3s) via setting environment `kubernetes_type=k3s`
* KubeSphere installation
* Install KubeSphere via [ks-installer](https://github.com/kubesphere/ks-installer)
* Install KubeSphere via [k3d](https://github.com/rancher/k3d)
* Install KubeSphere via [kubekey](https://github.com/kubesphere/kubekey)
* Install KubeSphere via [kind](https://github.com/kubernetes-sigs/kind)
## Component

```
➜ ~ kubectl ks com
Expand All @@ -57,7 +61,7 @@ Available Commands:
watch Update images of ks-apiserver, ks-controller-manager, ks-console
```

## 流水线
## Pipeline

```
➜ ~ kubectl ks pip
Expand All @@ -80,7 +84,7 @@ Flags:
Use "ks pipeline [command] --help" for more information about a command.
```

## 安装
## Installation

```
Install KubeSphere with kind or kk
Expand Down
6 changes: 2 additions & 4 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,18 @@ module github.com/linuxsuren/ks
go 1.15

require (
github.com/AlecAivazis/survey/v2 v2.2.9
github.com/AlecAivazis/survey/v2 v2.2.12
github.com/Masterminds/goutils v1.1.1 // indirect
github.com/Masterminds/semver v1.5.0 // indirect
github.com/Masterminds/sprig v2.22.0+incompatible
github.com/huandu/xstrings v1.3.2 // indirect
github.com/imdario/mergo v0.3.9 // indirect
github.com/linuxsuren/cobra-extension v0.0.10
github.com/linuxsuren/go-cli-alias v0.0.6
github.com/linuxsuren/http-downloader v0.0.27-0.20210502025510-543b2b12e6d7 // indirect
github.com/mitchellh/copystructure v1.1.1 // indirect
github.com/spf13/cobra v1.1.3
github.com/spf13/pflag v1.0.5
github.com/stretchr/testify v1.7.0
golang.org/x/crypto v0.0.0-20201124201722-c8d3bf9c5392 // indirect
golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4 // indirect
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c
k8s.io/api v0.19.4
Expand Down
Loading

0 comments on commit 0031ef7

Please sign in to comment.