diff --git a/README.md b/README.md index 2101050..f498417 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ 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 @@ -46,10 +46,10 @@ $ wget -q https://raw.githubusercontent.com/tkeel-io/cli/master/install/install. 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. @@ -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**" @@ -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 is registered. -ℹ️ Plugin is registered. -ℹ️ Plugin 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 ``` @@ -92,7 +88,7 @@ Output should look like so: To remove tKeel from your Kubernetes cluster, use the `uninstall` command. ``` -$ tkeel uninstall +tkeel uninstall ``` ### Deploy plugin @@ -100,6 +96,21 @@ $ tkeel uninstall 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 done. +✅ Install "keel-echo" success! It's named "tkeel-echo" in k8s +``` + ### Manage plugins Use the plugin command to manage plugins. diff --git a/README_zh.md b/README_zh.md index ec4e755..805a97d 100644 --- a/README_zh.md +++ b/README_zh.md @@ -9,7 +9,7 @@ 🕹️ tKeel CLI 是您用于各种 tKeel 相关任务操作的简易使用工具。 -您可以使用它来 **安装 tKeel 平台**、**管理插件** 以及 **用户模块**。 +您可以使用它来 **安装和管理 tKeel 平台**，比如说 **插件的安装和管理** 以及一些 **用户模块** 相关的功能。 ### 安装须知 @@ -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 ``` #### 通过发行的二进制程序 @@ -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` @@ -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 is registered. -ℹ️ Plugin is registered. -ℹ️ Plugin 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 ``` @@ -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 done. +✅ Install "keel-echo" success! It's named "tkeel-echo" in k8s +``` + ### 管理插件 使用插件命令去管理平台上的插件。 diff --git a/go.mod b/go.mod deleted file mode 100644 index 61b2bbf..0000000 --- a/go.mod +++ /dev/null @@ -1,49 +0,0 @@ -module github.com/tkeel-io/cli - -go 1.16 - -require ( - github.com/BurntSushi/toml v0.4.1 // indirect - github.com/Masterminds/semver/v3 v3.1.1 - github.com/briandowns/spinner v1.6.1 - github.com/dapr/cli v1.5.0 - github.com/fatih/color v1.13.0 - github.com/gocarina/gocsv v0.0.0-20210516172204-ca9e8a8ddea8 - github.com/gofrs/flock v0.8.1 - github.com/google/uuid v1.3.0 // indirect - github.com/gosuri/uitable v0.0.4 - github.com/gregjones/httpcache v0.0.0-20190611155906-901d90724c79 // indirect - github.com/lib/pq v1.10.3 // indirect - github.com/mattn/go-colorable v0.1.11 // indirect - github.com/mitchellh/reflectwalk v1.0.1 // indirect - github.com/olekukonko/tablewriter v0.0.5 - github.com/onsi/gomega v1.16.0 // indirect - github.com/pkg/errors v0.9.1 - github.com/rogpeppe/go-internal v1.6.2 // indirect - github.com/spf13/cobra v1.2.1 - github.com/spf13/viper v1.9.0 - github.com/stretchr/testify v1.7.0 - github.com/tkeel-io/kit v0.0.0-20211122161648-31b3986683f2 - github.com/tkeel-io/tkeel-interface/openapi v0.0.0-20211129070957-8546fe1eb9a4 - golang.org/x/crypto v0.0.0-20210921155107-089bfa567519 // indirect - golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d // indirect - golang.org/x/sys v0.0.0-20211013075003-97ac67df715c // indirect - golang.org/x/text v0.3.7 // indirect - gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b - helm.sh/helm/v3 v3.5.3 - k8s.io/api v0.20.2 - k8s.io/apimachinery v0.20.2 - k8s.io/cli-runtime v0.20.2 - k8s.io/client-go v0.20.2 - k8s.io/helm v2.16.10+incompatible - sigs.k8s.io/yaml v1.2.0 -) - -replace ( - github.com/Azure/go-autorest => github.com/Azure/go-autorest v14.2.0+incompatible - github.com/docker/distribution => github.com/docker/distribution v0.0.0-20191216044856-a8371794149d - github.com/docker/docker => github.com/moby/moby v17.12.0-ce-rc1.0.20200618181300-9dc6525e6118+incompatible - github.com/russross/blackfriday => github.com/russross/blackfriday v1.5.2 - - k8s.io/client => github.com/kubernetes-client/go v0.0.0-20190928040339-c757968c4c36 -) diff --git a/go.sum b/go.sum index 6bf91f6..5bd71f1 100644 --- a/go.sum +++ b/go.sum @@ -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=