|
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 |
| -* [Project Roadmap](ROADMAP.md) |
| 5 | +- [Docs for users](https://ydb.tech/en/docs/maintenance/embedded_monitoring/ydb_monitoring) |
| 6 | +- [Project Roadmap](ROADMAP.md) |
7 | 7 |
|
8 | 8 | ## Preview
|
9 | 9 |
|
10 | 10 | You can preview working UI using YDB docker image. It will be UI with the latest stable ydb version.
|
11 | 11 |
|
12 | 12 | Run on a machine with Docker installed:
|
| 13 | + |
13 | 14 | ```
|
14 | 15 | docker pull cr.yandex/yc/yandex-docker-local-ydb
|
15 | 16 | docker run -dp 8765:8765 cr.yandex/yc/yandex-docker-local-ydb
|
@@ -40,11 +41,26 @@ To test new features, you can use ydb version that is currently in testing mode
|
40 | 41 |
|
41 | 42 | ### Custom backend in dev mode
|
42 | 43 |
|
43 |
| -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: |
| 44 | +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: |
| 45 | + |
44 | 46 | ```
|
45 | 47 | "dev": "DISABLE_ESLINT_PLUGIN=true TSC_COMPILE_ON_ERROR=true REACT_APP_BACKEND=http://your-cluster-host:8765 npm start"
|
46 | 48 | ```
|
47 | 49 |
|
| 50 | +### Meta backend in dev mode (multi cluster) |
| 51 | + |
| 52 | +If you have meta backend, you can run the app in dev mode with this backend like this: |
| 53 | + |
| 54 | +``` |
| 55 | +DISABLE_ESLINT_PLUGIN=true TSC_COMPILE_ON_ERROR=true REACT_APP_BACKEND= REACT_APP_META_BACKEND=http://your-meta-host:8765 npm start |
| 56 | +``` |
| 57 | + |
| 58 | +if you need to connect to the meta backend from a server then run the app like this: |
| 59 | + |
| 60 | +``` |
| 61 | +DISABLE_ESLINT_PLUGIN=true TSC_COMPILE_ON_ERROR=true REACT_APP_BACKEND= REACT_APP_META_BACKEND= META_YDB_BACKEND=http://your-meta-host:8765 npm start |
| 62 | +``` |
| 63 | + |
48 | 64 | ## E2E Tests
|
49 | 65 |
|
50 | 66 | For e2e tests we use `@playwright/tests`. Tests configuration is in `playwright.config.ts`. Tests are set up in `tests` dir.
|
@@ -90,4 +106,4 @@ It also could be usefull for development purposes, because some operations, that
|
90 | 106 | 2. Copy your build files from `build` folder to `/contentmonitoring` folder on desired cluster host
|
91 | 107 | 3. Open `http://your-cluster-host:8765/monitoring` to see updated UI
|
92 | 108 |
|
93 |
| -It's assumed, that you have all the necessary access rights to update files on the host. |
| 109 | +It's assumed, that you have all the necessary access rights to update files on the host. |
0 commit comments