pingcap / pingcap/docs

sync-diff-inspector-overview: Incomplete info about docker and tidb-operatator

Open
#7,366 3 comments 0 reactions 1 assignee View on GitHub

Nobody has claimed this yet.

area/sync-diff-inspector tracked
Dominant language
Python
Stars
617
Forks
724
Avg merge
2d 10h
Merged PRs (30d)
223

Description

Error Report

  1. What is the URL/path of the document related to this issue?

https://docs.pingcap.com/tidb/stable/sync-diff-inspector-overview

  1. How would you like to improve it?

The issues with this page are:

  • While it does list the name of the image, it doesn't tell the user how to run and use it
  • It doesn't list instructions for how to use this with tidb-operator or tidb-docker-compose

In addition to this the container image looks very old:

$ docker run -it pingcap/tidb-enterprise-tools:latest /sync_diff_inspector -V
version: 
sync_diff_inspector: v1.0.0~rc2+git.cccf51b
Git Commit Hash: cccf51b6f44cc6bbd96841d2fdc0c7bd9364ac69
UTC Build Time: 2020-02-27 05:46:50
Go Version: go1.13

There is a nightly versions that is much more recent:

$ docker run -it pingcap/tidb-enterprise-tools:nightly /sync_diff_inspector -V
App Name: sync_diff_inspector v2.0
Release Version: v5.4.0
Git Commit Hash: b1def7746ec382a71a70b8958b1053202092f95c
Git Branch: heads/refs/tags/v5.4.0
UTC Build Time: 2022-01-03 10:01:35
Go Version: go1.16.4

I don't see a version that is recent and stable and is production ready.

There are also tidb-tools (without 'enterprise' in the name) images, and pingcap/tidb-tools:nightly seems to have a version of sync_diff_inspector, but it doesn't work in the container:

[dvaneeden@dve-carbon ~]$ docker run -it pingcap/tidb-tools:nightly /bin/sh
/ # ls -l /tidb-tools/sync_diff_inspector 
-rwxr-xr-x    1 root     root      74327136 Oct 13 20:20 /tidb-tools/sync_diff_inspector
/ # /tidb-tools/sync_diff_inspector -V
/bin/sh: /tidb-tools/sync_diff_inspector: not found
/ # ldd /tidb-tools/sync_diff_inspector
	/lib64/ld-linux-x86-64.so.2 (0x7f3b326c7000)
	libpthread.so.0 => /lib64/ld-linux-x86-64.so.2 (0x7f3b326c7000)
	libc.so.6 => /lib64/ld-linux-x86-64.so.2 (0x7f3b326c7000)
/ # ls /lib64
ls: /lib64: No such file or directory

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.