diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c61b663 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/README.md b/README.md index c69102e..39520b8 100644 --- a/README.md +++ b/README.md @@ -1,150 +1,144 @@ -# TiKV UI +# 🚀 TiKV Admin Web UI -image +![Stream](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/HayesGordon/e7f3c4587859c17f3e593fd3ff5b13f4/raw/11d9d9385c9f34374ede25f6471dc743b977a914/badge.json) +![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/GetStream/tikv-ui) +![GitHub license](https://img.shields.io/github/license/GetStream/tikv-ui/LICENSE) +![GitHub contributors](https://img.shields.io/github/contributors/GetStream/tikv-ui) +[![GitHub Sponsors](https://img.shields.io/github/sponsors/GetStream)](https://github.com/sponsors/GetStream) -A REST API server for exploring and managing TiKV key-value data with multi-cluster support. +## 🌟 Overview -## Building +**TiKV Admin Web UI is a full-stack web application and REST API for the powerful, intuitive management of TiKV clusters.** -```bash -go build -o bin/tikv-ui ./cmd/tikv-ui -``` +Tired of juggling command-line tools? This project provides a dedicated, graphical frontend interface for exploring your data, managing cluster connections, and performing raw key-value manipulation with ease. -## Running +## ✨ Key Features -Set the `TIKV_PD_ADDRS` environment variable with comma-separated PD addresses for the default cluster: +This application is built to be the essential administrative tool for your TiKV deployment: -```bash -export TIKV_PD_ADDRS="127.0.0.1:2379,127.0.0.1:23790" -./bin/tikv-ui -``` +- **🌐 Multi-Cluster Management:** Dynamically connect to and switch between multiple TiKV clusters without restarting the server. Perfect for managing development, staging, and production environments. +- **🔎 Data Explorer:** Perform powerful **Raw KV Operations** directly through the UI: Get, Put, Delete, and Range Scans. +- **🧠 Smart Value Parsing:** Automatically detects and parses complex value formats, including **MsgPack** and **JSON**, providing you with structured, readable data alongside the raw string value. +- **💻 Dedicated Web Frontend:** A modern interface built with TypeScript, offering a smooth and efficient way to interact with your key-value store. +- **🔌 Comprehensive REST API:** An easy-to-use API backend allows for integration into custom monitoring or automation workflows. -The server will start on port 8081 and connect to the default cluster. +-- -## API Endpoints +## 🚀 Getting Started -### Health Check +The TiKV Admin Web UI is built with Go for the backend API and a modern web stack for the frontend. -``` -GET /health -``` +The easiest way to run the TiKV Admin Web UI is by using the pre-built Docker image. -### Cluster Management +### Option 1: Docker Compose (Recommended) -#### Connect to New Cluster +Use the official image in your `docker-compose.yml` file. This example assumes you have TiKV PD nodes named `pd0`, `pd1`, etc., running in the same network. -``` -POST /api/clusters/connect -Body: { - "pd_addrs": ["127.0.0.1:2379", "127.0.0.1:23790"], - "name": "production" // optional, auto-generated if not provided -} +```yaml +version: "3.7" +services: + # ... your TiKV cluster services (pd0, tikv0, etc.) ... + + tikv-ui: + image: ghcr.io/getstream/tikv-ui:latest + container_name: tikv-admin-ui + environment: + # **IMPORTANT:** Set TIKV_PD_ADDRS to the addresses of your PD nodes + TIKV_PD_ADDRS: "pd0:2379,pd1:2379" + # Use depends_on to ensure PD nodes are up before the UI starts + depends_on: + - "pd0" + - "pd1" + - "pd2" # Adjust this list to match your cluster + ports: + - "8081:8081" ``` -#### List All Clusters +### Option 2: Run Directly from Source -``` -GET /api/clusters -Response: { - "clusters": [ - { - "name": "default", - "cluster_id": 123456, - "pd_addrs": ["127.0.0.1:2379"], - "active": true - } - ] -} -``` +If you prefer to run the application directly, you will need Go installed. -#### Switch Active Cluster +### Prerequisites -``` -POST /api/clusters/switch -Body: {"name": "production"} +- Go (v1.18+) +- A running TiKV cluster with access to its PD addresses. + +### 🔨 Building the Application + +Clone the repository and build the Go executable: + +```bash +git clone https://github.com/GetStream/tikv-ui.git +cd tikv-ui +go build -o bin/tikv-ui ./cmd/tikv-ui ``` -### Raw KV Operations +## 🏃 Running the app -All operations use the currently active cluster. +Set the `TIKV_PD_ADDRS` environment variable with comma-separated PD addresses for your default cluster, then run the executable. +the format for `TIKV_PD_ADDRS` is {host}{,other hosts}{|cluster name}{;other clusters} -#### Get Value +e.g. -``` -POST /api/raw/get -Body: {"key": "mykey"} -Response: { - "key": "mykey", - "value": {...}, // parsed msgpack/JSON - "raw_value": "...", // raw string - "found": true -} +```bash +export TIKV_PD_ADDRS="127.0.0.1:2379|default;pd-us-west-1.aws.com:2379|My US WEST cluster" ``` -#### Put Value +at least one host is required, other params are optional -``` -POST /api/raw/put -Body: {"key": "mykey", "value": "myvalue"} -``` +```bash +# if you want to run on a specific port, just export the port variable, e.g. export PORT=8082 +# Set your TiKV PD addresses (required) +export TIKV_PD_ADDRS="127.0.0.1:2379" -#### Delete Key +# Run the server +./bin/tikv-ui -``` -POST /api/raw/delete -Body: {"key": "mykey"} -``` +# or run development server +make dev -#### Scan Range +# or separate backend +make backend +# or just the frontend +make frontend ``` -POST /api/raw/scan -Body: {"start_key": "a", "end_key": "z", "limit": 100} -Response: { - "items": [ - { - "key": "key1", - "value": {...}, // parsed msgpack/JSON - "raw_value": "..." // raw string - } - ] -} -``` -## Features +The server will start on port 8081. You can then access the Web UI in your browser: + +🔗 http://localhost:8081 -### Multi-Cluster Support +## ⚙️ REST API Endpoints -- Connect to multiple TiKV clusters dynamically via API -- Switch between clusters without restarting the server -- Each cluster maintains its own connection pool -- Thread-safe cluster management +The server exposes a set of endpoints for cluster management and raw data operations. All operations are performed against the currently active cluster. -### Smart Value Parsing +### Health Check -- Automatically detects and parses msgpack-encoded values -- Falls back to JSON parsing if msgpack fails -- Returns both parsed (structured) and raw (string) values -- Handles plain text values correctly +| Method | Endpoint | Description | +| ------ | -------- | ------------------------------- | +| GET | /health | Check the server health status. | -### Graceful Shutdown +### Cluster Management -- Properly closes all cluster connections on shutdown -- Handles SIGINT and SIGTERM signals +| Method | Endpoint | Description | Body Example | +| ------ | --------------------- | ------------------------------------------ | --------------------------------------------------- | +| POST | /api/clusters/connect | Connect to a new TiKV cluster. | `{"pd_addrs": ["host:port"], "name": "production"}` | +| GET | /api/clusters | List all connected clusters. | N/A | +| POST | /api/clusters/switch | Set an existing cluster as the active one. | `{"name": "production"}` | -## Architecture +### Raw KV Operations (Active Cluster) -The project follows a clean architecture pattern: +| Method | Endpoint | Description | Body Example | +| ------ | --------------- | -------------------------------------- | -------------------------------------------------- | +| POST | /api/raw/get | Retrieve the value for a specific key. | `{"key": "mykey"}` | +| POST | /api/raw/put | Insert or update a key-value pair. | `{"key": "mykey", "value": "myvalue"}` | +| POST | /api/raw/delete | Delete a key-value pair. | `{"key": "mykey"}` | +| POST | /api/raw/scan | Scan a range of keys. | `{"start_key": "a", "end_key": "z", "limit": 100}` | -- **cmd/**: Application entry points (main packages) -- **pkg/handlers/**: HTTP handlers organized by operation -- **pkg/server/**: Server configuration, middleware, and multi-cluster management -- **pkg/types/**: Shared type definitions -- **pkg/utils/**: Reusable utility functions +## 🤝 Contributing -This structure provides: +We welcome contributions from the community! If you're interested in making the TiKV Admin Web UI even better: -- Clear separation of concerns -- Easy testing (each handler can be tested independently) -- Maintainability (changes are localized to specific packages) -- Scalability (easy to add new handlers or utilities) +- Report bugs and suggest features. +- Submit pull requests. +- Join the discussion.