You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+39
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,18 @@
2
2
3
3
Local viewer for YDB clusters
4
4
5
+
[Docs for users](https://ydb.tech/en/docs/maintenance/embedded_monitoring/ydb_monitoring)
6
+
7
+
## Preview
8
+
9
+
You can preview working UI using YDB docker image. It will be UI with the latest stable ydb version.
10
+
11
+
Run on a machine with Docker installed:
12
+
```
13
+
docker pull cr.yandex/yc/yandex-docker-local-ydb
14
+
docker run -dp 8765:8765 cr.yandex/yc/yandex-docker-local-ydb
15
+
```
16
+
5
17
## Development
6
18
7
19
1. Run on a machine with Docker installed:
@@ -15,6 +27,21 @@ Local viewer for YDB clusters
15
27
16
28
For API reference, open Swagger UI on http://localhost:8765/viewer/api/.
17
29
30
+
### YDB docker images
31
+
32
+
[Docs on YDB docker images](https://ydb.tech/en/docs/getting_started/self_hosted/ydb_docker)
33
+
34
+
Image `cr.yandex/yc/yandex-docker-local-ydb` corresponds to `:latest` tag. It's the latest stable ydb version.
35
+
36
+
To test new features, you can use ydb version that is currently in testing mode with `cr.yandex/yc/yandex-docker-local-ydb:edge` image. Also you can set specific version like `cr.yandex/yc/yandex-docker-local-ydb:23.1`
37
+
38
+
### Custom backend in dev mode
39
+
40
+
YDB docker represents a single node cluster with only one version, small amount of storage groups, PDisks and VDisks. It may be not enough for development purposes. If you have your own development cluster with sufficient amount of entities, you can run the app in the dev mode with this cluster as backend. To do it, set you host to `REACT_APP_BACKEND` variable in `dev` script. For example:
3. Open [embedded YDB UI](http://localhost:8765/monitoring) to view it in the browser.
79
+
80
+
### Testing production bundle with specific cluster host
81
+
82
+
If you want to test embedded version in production mode, but YDB docker is not enough and you have your own ydb development cluster, you can manually update UI for the specific cluster host.
83
+
84
+
It also could be usefull for development purposes, because some operations, that are not 'read-only', like some update queries or tablets restart could be allowed by CORS only for the same origin and so could not be executed in dev mode.
85
+
86
+
1. Create production bundle with `npm run build:embedded`
87
+
2. Copy your build files from `build` folder to `/contentmonitoring` folder on desired cluster host
88
+
3. Open `http://your-cluster-host:8765/monitoring` to see updated UI
89
+
90
+
It's assumed, that you have all the necessary access rights to update files on the host.
0 commit comments