Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Fix typos.
  • Loading branch information
ogorbacheva authored and ma-efremoff committed Oct 17, 2024
1 parent a62cce5 commit 9badece
Showing 1 changed file with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions packages/ui-helm-chart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,31 @@

## Using with [ytop-chart](https://github.com/ytsaurus/ytsaurus-k8s-operator/pkgs/container/ytop-chart)

Follow all required steps to [Starting YTsaurus cluster](https://ytsaurus.tech/docs/en/overview/try-yt#starting-ytsaurus-cluster1)
And then install the chart:
Follow all required steps to [start the YTsaurus cluster](https://ytsaurus.tech/docs/en/overview/try-yt#starting-ytsaurus-cluster1). Then install the chart:
```bash
helm upgrade --install ytsaurus-ui github/ytsaurus-ui/packages/ui-helm-chart/
```

## Using with a custom cluster

### Prerequirements
### Pre-requirements

The instructions belows describe how to start YT UI from the helm cahrt.
It is supposed you have already:
- configured `kubectl` cli-tool (for example use [`minikube`](https://minikube.sigs.k8s.io/docs/start/))
- started your YT-cluster and knows hostname of http_proxy
- prepared a special robot-user for YT UI and ready to provide its token (see [Token management](https://ytsaurus.tech/docs/user-guide/storage/auth))
The instructions below describe how to start the YTsaurus UI from the helm chart. You are supposed to have already:
- configured the `kubectl` cli-tool (for example, use [minikube](https://minikube.sigs.k8s.io/docs/start/)),
- started your YT-cluster and know the hostname of `http_proxy`,
- prepared a special robot-user for the YTsaurus UI and ready to provide its token (see the [Token management](https://ytsaurus.tech/docs/user-guide/storage/auth) section).

### Quick start

By default the chart expects existense of `yt-ui-secret` with `yt-interface-secret.json` key. The secret might be created by the commands bellow:
By default, the chart expects existence of `yt-ui-secret` with the `yt-interface-secret.json` key. The secret can be created by the following commands:

```bash
read -sp "TOKEN: " TOKEN ; echo '{"oauthToken":"'$TOKEN'"}' > tmp.json
kubectl create secret generic yt-ui-secret --from-literal="yt-interface-secret.json=$(cat tmp.json)" && rm tmp.json
```

Also you have to provide description of your cluster:
Also, you have to provide a description of your cluster:

```bash
read -p "Cluster id: " id_; read -p "http_proxy hostname: " proxy_; read -p "Use https [true/false]: " secure_; read -p "NODE_TLS_REJECT_UNAUTHORIZED [1/0]: " tlsrej_; (
tee values.yaml << _EOF
Expand All @@ -54,14 +53,16 @@ _EOF
)
```

Then you are redy to install/upgrade the chart:
Then you are ready to install or upgrade the chart:

```bash
helm upgrade --install yt-ui github/ytsaurus-ui/packages/ui-helm-chart/ -f values.yaml
# or run specific version of UI (all versions: https://github.com/ytsaurus/ytsaurus-ui/pkgs/container/ui)
helm upgrade --install yt-ui github/ytsaurus-ui/packages/ui-helm-chart/ -f values.yaml --set ui.image.tag=1.60.1
```

You may want to add port-forwarding to open it in your browser:
You may want to add port-forwarding to open the YTsaurus UI in your browser:

```bash
kubectl port-forward deployment/yt-ui-ytsaurus-ui-chart 8080:80
```
```

0 comments on commit 9badece

Please sign in to comment.