-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1e35a5c
commit ba5a9fb
Showing
1 changed file
with
77 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,86 @@ | ||
| <html> | ||
| <h1 align="center"> | ||
| UCtl | ||
| </h1> | ||
| <p align="center"> | ||
| A cross platform CLI for unionai | ||
| </p> | ||
| <h3 align="center"> | ||
| <a href="https://docs.union.ai/getting-started/installing-development-tools">Documentation</a> | ||
| </h3> | ||
| </html> | ||
|
|
||
| [](https://uctl.rtfd.io) | ||
| # uctl | ||
|
|
||
| [](https://github.com/unionai/uctl/releases/latest) | ||
| [](http://www.apache.org/licenses/LICENSE-2.0.html) | ||
| [](https://slack.union.ai) | ||
|
|
||
| UCtl was designed as a portable and lightweight command-line interface to work with Unionai Cluster. | ||
| `uctl` is an enhanced version of `flytectl`, [the Flyte command-line tool](https://docs.flyte.org/en/latest/flytectl/docs_index.html), | ||
| that lets you manage not only Flyte entities (projects, domains, workflows, tasks, and launch plans) | ||
| but also Union-specific entities like users, roles, and Union configurations. | ||
|
|
||
| You can find full documentation [here](https://docs.union.ai/byoc/administration/uctl-cli). | ||
|
|
||
| ## Installing `uctl` | ||
|
|
||
| To install `uctl`, you can use Homebrew on macOS or `curl` on macOS, Linux, or Windows. | ||
|
|
||
| To download manually, see the [`uctl` releases](https://github.com/unionai/uctl/releases). | ||
|
|
||
| ### macOS | ||
|
|
||
| To use [Homebrew](https://brew.sh/), do this: | ||
|
|
||
| ```shell | ||
| $ brew tap unionai/homebrew-tap | ||
| $ brew install uctl | ||
| ``` | ||
|
|
||
| To use `curl`, set `BINDIR` to the install location (it defaults to `./bin`) and run the following command: | ||
|
|
||
| ```shell | ||
| $ curl -sL https://raw.githubusercontent.com/unionai/uctl/main/install.sh | bash | ||
| ``` | ||
|
|
||
| ### Linux | ||
|
|
||
| To use `curl`, set `BINDIR` to the install location (it defaults to `./bin`) and run the following command: | ||
|
|
||
| ```{code-block} shell | ||
| $ curl -sL https://raw.githubusercontent.com/unionai/uctl/main/install.sh | bash | ||
| ``` | ||
|
|
||
| ### Windows | ||
|
|
||
| To use `curl`, in a Linux shell (such as [WSL](https://learn.microsoft.com/en-us/windows/wsl/install)), set `BINDIR` to the install location (it defaults to `./bin`) and run the following command: | ||
|
|
||
| ``` shell | ||
| $ curl -sL https://raw.githubusercontent.com/unionai/uctl/main/install.sh | bash | ||
| ``` | ||
|
|
||
| ## Configuring `uctl` | ||
|
|
||
| To configure `uctl` to connect to your Union instance, run the following command: | ||
|
|
||
| ``` shell | ||
| $ uctl config init --host <union-host-url> | ||
| ``` | ||
|
|
||
| Where `<union-host-url>` is the URL of your Union instance. | ||
|
|
||
| This will create a new configuration file at `~/.union/config.yaml`: | ||
|
|
||
| ## 🚀 Quick Start | ||
| ```yaml | ||
| union: | ||
| connection: | ||
| host: dns:///<union-host-url> | ||
| insecure: false | ||
| auth: | ||
| type: Pkce | ||
| admin: | ||
| endpoint: dns:///<union-host-url> | ||
| insecure: false | ||
| authType: Pkce | ||
| ``` | ||
| 1. Install UCtl with bash or shell script | ||
| The `uctl` CLI will use this configuration file to connect to your Union instance by default unless you override it. | ||
| The search order for finding the configuration file is: | ||
|
|
||
| * Shell script | ||
| ```bash | ||
| $ curl -sL https://raw.githubusercontent.com/unionai/uctl/main/install.sh | bash | ||
| ``` | ||
| * `--config <path-to-config>` flag. | ||
| * `UNION_CONFIG` environment variable: the same variable as used by the `union CLI`. | ||
| * `UCTL_CONFIG` environment variable: for backward compatibility with earlier versions of `uctl`. | ||
| * `~/.union/config.yaml`: the default, and the one created by the command above. | ||
| * `~/.uctl/config.yaml`: for backward compatibility with earlier versions of `uctl`. | ||
|
|
||
| <html> | ||
| <h2 id="file-an-issue"> | ||
| 🐞 File an Issue | ||
| </h2> | ||
| </html> | ||
| For details on the parameters in the configuration file, see [CLI Authentication](https://docs.union.ai/byoc/administration/cli-authentication.html). | ||
|
|
||
| For details on the `union` CLI, see [union CLI](https://docs.union.ai/byoc/api/union-cli.html). |