From 9badecef58cb36591def84fda5385b610a3c48f7 Mon Sep 17 00:00:00 2001 From: Olesya Gorbacheva Date: Thu, 17 Oct 2024 10:38:53 +0300 Subject: [PATCH] Update README.md Fix typos. --- packages/ui-helm-chart/README.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/packages/ui-helm-chart/README.md b/packages/ui-helm-chart/README.md index 0580c2838..2d00bfb72 100644 --- a/packages/ui-helm-chart/README.md +++ b/packages/ui-helm-chart/README.md @@ -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 @@ -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 -``` \ No newline at end of file +```