Skip to content

docs: fix readme #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
uptutu wants to merge 4 commits into
base: master
Choose a base branch
from
Open

docs: fix readme #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a14dcc0
docs: fix readme
uptutu Dec 17, 2021
58d780a
go mod tidy with go1.17
uptutu Dec 27, 2021
64ca896
docs: README
uptutu Dec 27, 2021
98bc932
Delete go.mod
imneov Jan 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 23 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,18 +38,18 @@ written.
Install the latest linux tKeel CLI to `/usr/local/bin`

```bash
$ wget -q https://raw.githubusercontent.com/tkeel-io/cli/master/install/install.sh -O - | /bin/bash
wget -q https://raw.githubusercontent.com/tkeel-io/cli/master/install/install.sh -O - | /bin/bash
```

##### MacOS

Install the latest darwin tKeel CLI to `/usr/local/bin`

```bash
$ curl -fsSL https://raw.githubusercontent.com/tkeel-io/cli/master/install/install.sh | /bin/bash
curl -fsSL https://raw.githubusercontent.com/tkeel-io/cli/master/install/install.sh | /bin/bash
```

#### From the Binary Releases
#### Releases Binary

Each release of tKeel CLI includes various OSes and architectures. These binary versions can be manually downloaded and
installed.
Expand All @@ -66,7 +66,7 @@ installed.
Use the init command to initialize tKeel.

```bash
$ tkeel init
tkeel init --debug --wait --timeout 600
```

> For Linux users, if you run your docker cmds with sudo, you need to use "**sudo tkeel init**"
Expand All @@ -76,14 +76,10 @@ Output should look like so:
```
⌛ Making the jump to hyperspace...
ℹ️ Checking the Dapr runtime status...
↑ Deploying the tKeel Platform to your cluster...
ℹ️ Deploying the tKeel Platform to your cluster...
ℹ️ install plugins...
ℹ️ install plugins done.
✅ Deploying the tKeel Platform to your cluster...
↖ Register the plugins ...
ℹ️ Plugin<plugins> is registered.
ℹ️ Plugin<keel> is registered.
ℹ️ Plugin<auth> is registered.
ℹ️ install plugins done.
✅ Deploying the tKeel Platform to your cluster...
✅ Success! tKeel Platform has been installed to namespace keel-system. To verify, run `tkeel plugin list -k' in your terminal. To get started, go here: https://tkeel.io/keel-getting-started
```

Expand All @@ -92,14 +88,29 @@ Output should look like so:
To remove tKeel from your Kubernetes cluster, use the `uninstall` command.

```
$ tkeel uninstall
tkeel uninstall
```

### Deploy plugin

You can deploy the plugin app with the Dapr. There
is [deploy-the-plugin-app Doc](https://github.com/dapr/quickstarts/tree/v1.0.0/hello-kubernetes#step-3---deploy-the-nodejs-app-with-the-dapr-sidecar)

### Install plugin

Install the plugin which you want like following:

```bash
tkeel plugin install https://tkeel-io.github.io/helm-charts/keel-echo@v0.2.0 tkeel-echo
```

Output should look like so:

```bash
ℹ️ install tKeel plugin<keel-echo> done.
✅ Install "keel-echo" success! It's named "tkeel-echo" in k8s
```

### Manage plugins

Use the plugin command to manage plugins.
Expand Down
46 changes: 32 additions & 14 deletions README_zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

🕹️ tKeel CLI 是您用于各种 tKeel 相关任务操作的简易使用工具。

您可以使用它来 **安装 tKeel 平台**、**管理插件** 以及 **用户模块**。
您可以使用它来 **安装和管理 tKeel 平台**，比如说 **插件的安装和管理** 以及一些 **用户模块** 相关的功能。

### 安装须知

Expand All @@ -26,22 +26,22 @@ tKeel CLI 可以帮助您安装 tKeel 平台并且帮助您管理平台。

#### 使用脚本安装最新版本

通过我们编写好的脚本自动为您安装 `tKeel Cli`。
通过我们编写好的脚本自动为您安装 `tKeel CLI`。

##### Linux

通过 Bash 脚本将最新版 tKeel Cli 安装至 Linux 系统的 `/usr/local/bin`
通过 Bash 脚本将最新版 tKeel CLI 安装至 Linux 系统的 `/usr/local/bin`

```bash
$ wget -q https://raw.githubusercontent.com/tkeel-io/cli/master/install/install.sh -O - | /bin/bash
wget -q https://raw.githubusercontent.com/tkeel-io/cli/master/install/install.sh -O - | /bin/bash
```

##### MacOS

通过 Bash 脚本将最新版 tKeel Cli 安装至 MacOS(darwin) 系统的 `/usr/local/bin`
通过 Bash 脚本将最新版 tKeel CLI 安装至 MacOS(darwin) 系统的 `/usr/local/bin`

```bash
$ curl -fsSL https://raw.githubusercontent.com/tkeel-io/cli/master/install/install.sh | /bin/bash
curl -fsSL https://raw.githubusercontent.com/tkeel-io/cli/master/install/install.sh | /bin/bash
```

#### 通过发行的二进制程序
Expand All @@ -61,7 +61,7 @@ $ curl -fsSL https://raw.githubusercontent.com/tkeel-io/cli/master/install/insta
使用命令行初始 `tKeel`

```bash
$ tkeel init
tkeel init
```

> 注意：Linux 用户请注意，如果你的 docker 需要使用 sudo 权限才能使用，那么请你使用 `sudo tkeel init`
Expand All @@ -71,14 +71,10 @@ Output should look like so:
```
⌛ Making the jump to hyperspace...
ℹ️ Checking the Dapr runtime status...
↑ Deploying the tKeel Platform to your cluster...
ℹ️ Deploying the tKeel Platform to your cluster...
ℹ️ install plugins...
ℹ️ install plugins done.
✅ Deploying the tKeel Platform to your cluster...
↖ Register the plugins ...
ℹ️ Plugin<plugins> is registered.
ℹ️ Plugin<keel> is registered.
ℹ️ Plugin<auth> is registered.
ℹ️ install plugins done.
✅ Deploying the tKeel Platform to your cluster...
✅ Success! tKeel Platform has been installed to namespace keel-system. To verify, run `tkeel plugin list -k' in your terminal. To get started, go here: https://tkeel.io/keel-getting-started
```

Expand All @@ -95,6 +91,28 @@ $ tkeel uninstall
你能通过 Dapr 部署 tKeel 的插件，
详细请见 [deploy-the-plugin-app 文档](https://github.com/dapr/quickstarts/tree/v1.0.0/hello-kubernetes#step-3---deploy-the-nodejs-app-with-the-dapr-sidecar)

更多详细的使用文档请参照 [如何使用插件功能](https://tkeel-io.github.io/docs/getting_started/how-to-use-plugin)

### 安装插件

使用 tkeel CLI 工具 安装 指定源的插件。

```bash
tkeel plugin install https://tkeel-io.github.io/helm-charts/keel-echo@v0.2.0 tkeel-echo
```

> 备注：
> 示例中所安装的插件为 keel-echo 为平台官方提供的一个演示插件，源地址为 https://tkeel-io.github.io/helm-charts/ 插件 chart 版本为 v0.2.0，如果不指定版本信息将会默认安装发行的最新版本。最后一个参数 「tkeel-echo」是为该插件创建的实体名称，最后对应为部署在 Kubernetes 中的部署实例。
>
> 如果您有自己想要安装的插件，请将对应信息进行替换并执行命令。

执行后输出应该如下：

```bash
ℹ️ install tKeel plugin<keel-echo> done.
✅ Install "keel-echo" success! It's named "tkeel-echo" in k8s
```

### 管理插件

使用插件命令去管理平台上的插件。
Expand Down
49 changes: 0 additions & 49 deletions go.mod
View file
Open in desktop

This file was deleted.

2 changes: 0 additions & 2 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -572,8 +572,6 @@ github.com/godbus/dbus/v5 v5.0.3/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5x
github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
github.com/godror/godror v0.13.3/go.mod h1:2ouUT4kdhUBk7TAkHWD4SN0CdI0pgEQbo8FVHhbSKWg=
github.com/gofrs/flock v0.8.0/go.mod h1:F1TvTiK9OcQqauNUHlbJvyl9Qa1QvF/gOUDKA14jxHU=
github.com/gofrs/flock v0.8.1 h1:+gYjHKf32LDeiEEFhQaotPbLuUXjY5ZqxKgXy7n59aw=
github.com/gofrs/flock v0.8.1/go.mod h1:F1TvTiK9OcQqauNUHlbJvyl9Qa1QvF/gOUDKA14jxHU=
github.com/gofrs/uuid v3.2.0+incompatible/go.mod h1:b2aQJv3Z4Fp6yNu3cdSllBxTCLRxnplIgP/c0N/04lM=
github.com/gogap/errors v0.0.0-20200228125012-531a6449b28c/go.mod h1:tbRYYYC7g/H7QlCeX0Z2zaThWKowF4QQCFIsGgAsqRo=
github.com/gogap/stack v0.0.0-20150131034635-fef68dddd4f8/go.mod h1:6q1WEv2BiAO4FSdwLQTJbWQYAn1/qDNJHUGJNXCj9kM=
Expand Down