{"id":18408337,"url":"https://github.com/pingcap/tiunimanager","last_synced_at":"2025-08-21T07:32:24.494Z","repository":{"id":39256911,"uuid":"362529558","full_name":"pingcap/tiunimanager","owner":"pingcap","description":"TiUniManager","archived":false,"fork":false,"pushed_at":"2024-12-09T07:10:29.000Z","size":142710,"stargazers_count":34,"open_issues_count":29,"forks_count":19,"subscribers_count":10,"default_branch":"main","last_synced_at":"2024-12-18T16:35:19.568Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pingcap.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-04-28T16:02:31.000Z","updated_at":"2024-06-12T07:12:09.000Z","dependencies_parsed_at":"2023-02-17T13:31:17.098Z","dependency_job_id":"a1076509-952a-45cf-985a-c887abf385e0","html_url":"https://github.com/pingcap/tiunimanager","commit_stats":null,"previous_names":["pingcap-inc/tiem"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pingcap%2Ftiunimanager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pingcap%2Ftiunimanager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pingcap%2Ftiunimanager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pingcap%2Ftiunimanager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pingcap","download_url":"https://codeload.github.com/pingcap/tiunimanager/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230501172,"owners_count":18236061,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T03:18:32.417Z","updated_at":"2024-12-19T21:08:50.086Z","avatar_url":"https://github.com/pingcap.png","language":"Go","readme":"\u003cp align=\"center\"\u003e\n  \u003cbr\u003e\n  \u003cimg src=\"./docs/img/tiunimanager.svg\" alt=\"logo\" height=\"80px\"\u003e\n  \u003cbr\u003e\n  \u003cbr\u003e\n\u003c/p\u003e\n\n# TiUniManager\n\n[![License](https://img.shields.io/badge/license-Apache--2.0-green?style=flat-square)](./LICENSE)\n\n`TiUniManager` is a database management platform built for operating and managing TiDB, a distributed database.\n\nIt allows users to manage TiDB clusters through OpenAPI or [TiUniManager UI](https://github.com/pingcap/tiunimanager-ui), the web-based UI.\n\n## Contents\n\n- library - Common components and resources.\n- micro-api - OpenAPI http handler.\n- micro-cluster - Core service.\n- docs - Documentation.\n\n## Deploy TiUniManager\n\n### Prerequisites\n\nThe followings are required for developing `TiUniManager`:\n\n- [Git](https://git-scm.com/downloads)\n- [Go 1.17+](https://go.dev/doc/install)\n\n### Preparation\n\nBefore you can actually run the service, you need to prepare TiUP and certs.\n\n#### Prepare TiUP\n\n1. Install TiUP by following instructions in [Deploy TiUP on the control machine](https://docs.pingcap.com/tidb/stable/production-deployment-using-tiup#step-2-deploy-tiup-on-the-control-machine).\n\n2. Prepare `TIUP_HOME` which will be used by `TiUniManger`.\n\n   ```shell\n   $ mkdir -p /home/tidb/.tiup/bin\n   $ TIUP_HOME=/home/tidb/.tiup tiup mirror set https://tiup-mirrors.pingcap.com\n   ```\n\n#### Prepare certs\n\nYou need to prepare the following certs in the directory `./bin/cert`, where `aes.key` contains a 32 character string.\n\n- aes.key\n- etcd-ca.pem\n- etcd-server-key.pem\n- etcd-server.pem\n- server.crt\n- server.csr\n- server.key\n\nYou can follow [GENERATE CERTS](./build_helper/GENERATE_CERTS.md) to generate these certs.\n\n### Build and Run TiUniManager\n\n1. `TiUniManager` can be compiled and used on Linux, OSX, CentOS, It is as simple as:\n\t```\n\tmake\n\t```\n\n2. start cluster-server\n\n\t```shell\n\t./bin/cluster-server --host=127.0.0.1 --port=4101 --metrics-port=4104 --registry-address=127.0.0.1:4106 --elasticsearch-address=127.0.0.1:4108 --skip-host-init=true --em-version=InTesting --deploy-user=tidb --deploy-group=tidb\n\t```\n\n\t\u003e **NOTICE：**\n\t\u003e \n\t\u003e - `--skip-host-init=true` is necessary as deploying `TiUniManager` using built binary will not help configure SSH login without password, and you need to refer step `Configure SSH login without password` in [DEPLOY TiDB](./build_helper/DEPLOY_TIDB.md) to do so.\n\t\u003e - `--skip-host-init` is set false while deploying `TiUniManager` using `TiUP`, please refer [TiUniManager install and maintain](https://docs.pingcap.com/zh/tidb/dev/tiunimanager-install-and-maintain)\n\n3. open a new terminal, then start openapi-server\n\n\t```shell\n\t./bin/openapi-server --host=127.0.0.1 --port=4100 --metrics-port=4103 --registry-address=127.0.0.1:4106\n\t```\n\n### Try it out\n\nNow you can check API using Swagger: http://127.0.0.1:4100/swagger/index.html, and you can use `TiUniManager` to [DEPLOY TiDB](./build_helper/DEPLOY_TIDB.md).\n\n## Interested in contributing?\n\nRead through our [contributing guidelines](./CONTRIBUTING.md) to learn about our submission process and more.\n\n## License\n\nCopyright 2022 PingCAP. All rights reserved.\n\nLicensed under the [Apache 2.0 License](./LICENSE).","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpingcap%2Ftiunimanager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpingcap%2Ftiunimanager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpingcap%2Ftiunimanager/lists"}