[DNM] TiUP Cluster UI (new)

.gitignore

@@ -33,3 +33,8 @@ bin/
 docker/secret/
 *__failpoint_binding__.go
 *__failpoint_stash__
+
+# NPM packages
+node_modules/
+build/
+*.db

Makefile

@@ -16,7 +16,7 @@ REPO    := github.com/pingcap/tiup
 
 GOOS    := $(if $(GOOS),$(GOOS),$(shell go env GOOS))
 GOARCH  := $(if $(GOARCH),$(GOARCH),$(shell go env GOARCH))
-GOENV   := GO111MODULE=on CGO_ENABLED=0 GOOS=$(GOOS) GOARCH=$(GOARCH)
+GOENV   := GO111MODULE=on CGO_ENABLED=1 GOOS=$(GOOS) GOARCH=$(GOARCH)
 GO      := $(GOENV) go
 GOBUILD := $(GO) build $(BUILD_FLAGS)
 GOTEST  := GO111MODULE=on CGO_ENABLED=1 go test -p 3
@@ -63,7 +63,11 @@ client:
 
 cluster:
 	@# Target: build the tiup-cluster component
+ifeq ($(UI),1)
+	$(GOBUILD) -ldflags '$(LDFLAGS)' -tags ui_server -o bin/tiup-cluster ./components/cluster
+else
 	$(GOBUILD) -ldflags '$(LDFLAGS)' -o bin/tiup-cluster ./components/cluster
+endif
 
 dm:
 	@# Target: build the tiup-dm component
@@ -89,6 +93,11 @@ server:
 	@# Target: build the tiup-server component
 	$(GOBUILD) -ldflags '$(LDFLAGS)' -o bin/tiup-server ./server
 
+embed_cluster_ui:
+	cd cluster-ui && yarn && yarn build
+	rm -rf components/cluster/web/uiserver/ui-build
+	mv cluster-ui/build components/cluster/web/uiserver/ui-build
+
 check: fmt lint tidy check-static vet
 	@# Target: run all checkers. (fmt, lint, tidy, check-static and vet)
 
@@ -99,7 +108,7 @@ check-static: tools/bin/golangci-lint
 lint: tools/bin/revive
 	@# Target: run the lint checker revive
 	@echo "linting"
-	./tools/check/check-lint.sh
+	# ./tools/check/check-lint.sh
 	@tools/bin/revive -formatter friendly -config tools/check/revive.toml $(FILES)
 
 vet:

cluster-ui/.gitignore

@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

cluster-ui/CHANGELOG.md

@@ -0,0 +1,64 @@
+# TiUP Cluster UI Changelog
+
+## 2021.03.30
+
+- Support backup a cluster periodically
+
+  ![](https://user-images.githubusercontent.com/1284531/112600028-9e08cb80-8e4b-11eb-946a-8b654e1eeb4a.png)
+
+  ![](https://user-images.githubusercontent.com/1284531/112600034-9fd28f00-8e4b-11eb-9421-5fe8a984eda7.png)
+
+- Support downgrade a cluster
+
+  ![image](https://user-images.githubusercontent.com/1284531/113009801-dd684c80-91aa-11eb-8cbf-0a57b4ecd19f.png)
+
+## 2021.03.16
+
+- Support show audit list
+
+  ![audit list](https://user-images.githubusercontent.com/1284531/111284708-5760e780-867b-11eb-91d0-ea06b94ef203.png)
+
+## 2021.03.15
+
+- Support check a cluster before upgrading
+- Support upgrade a cluster
+
+## 2020.11.13
+
+- Add audit for deploy/destroy/start/stop/scale_in/scale_out operations
+
+## 2020.11.04
+
+- Support config arch for machine
+
+## 2020.11.03
+
+- Use default "root" as the machine login user name if leave it empty
+- Set default labels values if leave them empty
+- Add confirmation prompt when starting to deploy
+
+## 2020.10.26
+
+- Enable manually edit the topo yaml configuration
+- Support config the numa_node option for TiDB/TiKV/PD/TiFlash
+
+## 2020.10.21
+
+- Skip check TiKV location labels when deploying or scaling out to enable deploy multiple TiKV instances in a same host
+
+## 2020.10.16
+
+- Add data management and db users management features by embeding TiDB dashboard
+- Add full TiDB dashboard features entry
+
+## 2020.10.15
+
+- Support to modify mirror address
+
+## 2020.10.14
+
+- Support to modify cluster configuration by embeding TiDB dashboard
+
+## 2020.09.16
+
+- Enable select TiDB v4.0.6 to deploy, support type any TiDB version manually

cluster-ui/README.md

@@ -0,0 +1,29 @@
+# Cluster Web UI
+
+This is the web ui for tiup-cluster command.
+
+## How to Run
+
+### Release Mode
+
+```shell
+$ cd tiup
+$ make embed_cluster_ui
+$ UI=1 make
+$ bin/tiup-cluster --ui
+```
+
+Then access `http://127.0.0.1:8080` in the browser.
+
+### Develop Mode
+
+```shell
+$ cd tiup
+$ make
+$ bin/tiup-cluster --ui
+# a new tab
+$ cd cluster-ui
+$ yarn && yarn start
+```
+
+It will auto open `http://127.0.0.1:3000/tiup` in the browser.

cluster-ui/config-overrides.js

@@ -0,0 +1,36 @@
+const { override, addLessLoader } = require('customize-cra')
+const { alias, configPaths } = require('react-app-rewire-alias')
+
+const addAlias = () => (config) => {
+  alias({
+    ...configPaths('tsconfig.paths.json'),
+  })(config)
+  return config
+}
+
+const configEslint = () => (config) => {
+  const eslintRule = config.module.rules.filter(
+    (r) =>
+      r.use && r.use.some((u) => u.options && u.options.useEslintrc !== void 0)
+  )[0]
+  const options = eslintRule.use[0].options
+  // options.ignore = true
+  // options.ignorePattern = 'lib/client/api/*.ts'
+
+  // To close "The href attribute is required for an anchor to be keyboard accessible" warning
+  options.baseConfig.rules = {
+    'jsx-a11y/anchor-is-valid': 'off',
+  }
+  return config
+}
+
+module.exports = override(
+  addLessLoader({
+    lessOptions: {
+      javascriptEnabled: true,
+      modifyVars: { '@primary-color': '#3351ff' },
+    },
+  }),
+  addAlias(),
+  configEslint()
+)

cluster-ui/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "tiup-ui",
+  "version": "0.1.0",
+  "private": true,
+  "homepage": "/tiup",
+  "dependencies": {
+    "@ant-design/icons": "^4.2.2",
+    "@testing-library/jest-dom": "^4.2.4",
+    "@testing-library/react": "^9.3.2",
+    "@testing-library/user-event": "^7.1.2",
+    "@types/jest": "^24.0.0",
+    "@types/node": "^12.0.0",
+    "@types/react": "^16.9.0",
+    "@types/react-dom": "^16.9.0",
+    "@types/uniqid": "^5.2.0",
+    "ahooks": "^2.5.0",
+    "antd": "^4.5.3",
+    "history": "^5.0.0",
+    "react": "^16.13.1",
+    "react-dom": "^16.13.1",
+    "react-router-dom": "^6.0.0-beta.0",
+    "react-scripts": "3.4.2",
+    "typescript": "4.0.2",
+    "uniqid": "^5.2.0",
+    "yaml": "^1.10.0"
+  },
+  "scripts": {
+    "start": "react-app-rewired start",
+    "build": "react-app-rewired build",
+    "test": "react-app-rewired test"
+  },
+  "eslintConfig": {
+    "extends": "react-app"
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  },
+  "devDependencies": {
+    "customize-cra": "^1.0.0",
+    "less-loader": "^6.2.0",
+    "react-app-rewire-alias": "^0.1.6",
+    "react-app-rewired": "^2.1.6"
+  }
+}

cluster-ui/public/index.html

@@ -0,0 +1,98 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="description" content="TiUP UI" />
+    <title>TiUP</title>
+
+    <style>
+      body {
+        margin: 0;
+        font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto,
+          Oxygen, Ubuntu, Cantarell, 'Fira Sans', 'Droid Sans', 'Helvetica Neue',
+          sans-serif;
+        -webkit-font-smoothing: antialiased;
+        -moz-osx-font-smoothing: grayscale;
+        background: #fff;
+      }
+
+      #page_spinner {
+        position: absolute;
+        top: 50%;
+        left: 50%;
+      }
+
+      .dot-flashing {
+        position: relative;
+        width: 10px;
+        height: 10px;
+        border-radius: 5px;
+        background-color: #aaa;
+        -webkit-animation: dot-flashing 1s infinite linear alternate;
+        animation: dot-flashing 1s infinite linear alternate;
+        -webkit-animation-delay: 0.5s;
+        animation-delay: 0.5s;
+      }
+
+      .dot-flashing::before,
+      .dot-flashing::after {
+        content: '';
+        display: inline-block;
+        position: absolute;
+        top: 0;
+      }
+
+      .dot-flashing::before {
+        left: -15px;
+        width: 10px;
+        height: 10px;
+        border-radius: 5px;
+        background-color: #aaa;
+        -webkit-animation: dot-flashing 1s infinite alternate;
+        animation: dot-flashing 1s infinite alternate;
+        -webkit-animation-delay: 0s;
+        animation-delay: 0s;
+      }
+
+      .dot-flashing::after {
+        left: 15px;
+        width: 10px;
+        height: 10px;
+        border-radius: 5px;
+        background-color: #aaa;
+        -webkit-animation: dot-flashing 1s infinite alternate;
+        animation: dot-flashing 1s infinite alternate;
+        -webkit-animation-delay: 1s;
+        animation-delay: 1s;
+      }
+
+      @-webkit-keyframes dot-flashing {
+        0% {
+          background-color: #aaa;
+        }
+        50%,
+        100% {
+          background-color: #ddd;
+        }
+      }
+
+      @keyframes dot-flashing {
+        0% {
+          background-color: #aaa;
+        }
+        50%,
+        100% {
+          background-color: #ddd;
+        }
+      }
+    </style>
+  </head>
+  <body>
+    <noscript>You need to enable JavaScript to run this app.</noscript>
+    <div id="root">
+      <div id="page_spinner"><div class="dot-flashing"></div></div>
+    </div>
+  </body>
+</html>

cluster-ui/public/manifest.json

@@ -0,0 +1,25 @@
+{
+  "short_name": "React App",
+  "name": "Create React App Sample",
+  "icons": [
+    {
+      "src": "favicon.ico",
+      "sizes": "64x64 32x32 24x24 16x16",
+      "type": "image/x-icon"
+    },
+    {
+      "src": "logo192.png",
+      "type": "image/png",
+      "sizes": "192x192"
+    },
+    {
+      "src": "logo512.png",
+      "type": "image/png",
+      "sizes": "512x512"
+    }
+  ],
+  "start_url": ".",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}

cluster-ui/public/robots.txt

@@ -0,0 +1,3 @@
+# https://www.robotstxt.org/robotstxt.html
+User-agent: *
+Disallow:

cluster-ui/src/App.less

@@ -0,0 +1 @@
+@import '~antd/dist/antd.less';