[close #610] [to #590] add docs for api v2 and tls reload #611

iosmanthus · 2022-06-14T08:30:03Z

Signed-off-by: iosmanthus myosmanthustree@gmail.com

What problem does this PR solve?

Issue Number: close #610, to #590

Related changes

Need to cherry-pick the release branch

Signed-off-by: iosmanthus <myosmanthustree@gmail.com>

codecov · 2022-06-14T08:37:35Z

Codecov Report

Merging #611 (787402b) into master (75f0586) will decrease coverage by 0.02%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##             master     #611      +/-   ##
============================================
- Coverage     34.67%   34.65%   -0.03%     
+ Complexity     1419     1417       -2     
============================================
  Files           278      278              
  Lines         17352    17352              
  Branches       1971     1971              
============================================
- Hits           6017     6013       -4     
- Misses        10718    10728      +10     
+ Partials        617      611       -6

Impacted Files	Coverage Δ
...ty/handler/codec/http2/Http2ConnectionHandler.java	`49.14% <0.00%> (-2.45%)`	⬇️
src/main/java/io/grpc/internal/ClientCallImpl.java	`57.07% <0.00%> (ø)`
...rc/main/java/io/grpc/netty/NettyClientHandler.java	`57.75% <0.00%> (+0.64%)`	⬆️
...va/org/tikv/common/region/StoreHealthyChecker.java	`73.41% <0.00%> (+3.79%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 75f0586...787402b. Read the comment docs.

docs/src/administration/configuration.md

Daemonxiao · 2022-06-14T10:18:26Z

docs/src/administration/configuration.md

 - default: null

+#### tikv.tls.reload_interval
+- The interval in seconds to poll the change of SSL context, if a change detected, the SSL context will be rebuilded.


Maybe it is always watching the change of cert file rather than SSL context.

The SSL context includes certificate files and private key files.

Signed-off-by: iosmanthus <myosmanthustree@gmail.com>

pingyu · 2022-06-15T04:50:57Z

docs/src/examples/rawkv.md

+
+
+## API V2
+With TiKV version >= 6.1.0, we release a new feature that allows the coexistence of transcation data and raw data. This feature could allow the [TiCDC](https://github.com/tikv/migration/tree/main/cdc) to capture the change of the data, and these events could be consumed by the downstream infrastructure like Kafka or another TiKV cluster for backup.


CDC feature is not released in v6.1.0, and we will not implement cdc with TiCDC. Suggest just to refer to v6.1.0 release notes as:

Suggested change

With TiKV version >= 6.1.0, we release a new feature that allows the coexistence of transcation data and raw data. This feature could allow the [TiCDC](https://github.com/tikv/migration/tree/main/cdc) to capture the change of the data, and these events could be consumed by the downstream infrastructure like Kafka or another TiKV cluster for backup.

With TiKV version >= 6.1.0, we release a new feature called "TiKV API V2", which provides a new Raw Key Value storage format and access interface. Please refer to [v6.10 release notes](https://docs.pingcap.com/tidb/stable/release-6.1.0#ease-of-use) for detail.

a new Raw Key-Value storage format is a too general description of this feature, how about keeping the statement of the coexistence of transaction data and raw data.

a new Raw Key-Value storage format is a too general description of this feature, how about keeping the statement of the coexistence of transaction data and raw data.

LGTM.

I mean:

Suggested change

With TiKV version >= 6.1.0, we release a new feature that allows the coexistence of transcation data and raw data. This feature could allow the [TiCDC](https://github.com/tikv/migration/tree/main/cdc) to capture the change of the data, and these events could be consumed by the downstream infrastructure like Kafka or another TiKV cluster for backup.

With TiKV version >= 6.1.0, we release a new feature called "TiKV API V2" which provides a new raw key-value storage format allowing the coexistence of transaction data and raw data. Please refer to [v6.10 release notes](https://docs.pingcap.com/tidb/stable/release-6.1.0#ease-of-use) for detail.

docs/src/examples/rawkv.md

Signed-off-by: iosmanthus <myosmanthustree@gmail.com>

pingyu

LGTM~

ti-srebot · 2022-06-15T06:41:14Z

@zhangyangyu, Thanks for your review. The bot only counts LGTMs from Reviewers and higher roles, but you're still welcome to leave your comments. You are not a reviewer or committer or co-leader or leader.

sunxiaoguang · 2022-06-15T07:01:15Z

docs/src/administration/configuration.md

 - default: null

+#### tikv.tls.reload_interval
+- The interval in seconds to poll the change of TLS context, if a change detected, the SSL context will be rebuilded.


if a change detected -> if a change is detected

sunxiaoguang · 2022-06-15T07:02:08Z

docs/src/administration/configuration.md

+- default: `"10s"`, `"0s"` means disable TLS context reload.
+
+#### tikv.conn.recycle_time
+- After `tikv.conn.recycle_time` (in seconds) with a TLS context reloading, the old connections will be forced to shutdown preventing channel leak.


will be forced to shutdown after recycle time to prevent channel leak.

sunxiaoguang · 2022-06-15T07:04:29Z

docs/src/examples/rawkv.md

+
+
+## API V2
+With TiKV version >= 6.1.0, we release a new feature called "TiKV API V2" which provides a new raw key-value storage format allowing the coexistence of transaction data and raw data. Please refer to [v6.10 release notes](https://docs.pingcap.com/tidb/stable/release-6.1.0#ease-of-use) for detail.


transaction data and raw data -> TxnKV and RawKV

I personally think the latter is more familiar to TiKV developers.

Signed-off-by: iosmanthus <myosmanthustree@gmail.com>

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

ti-srebot · 2022-06-15T07:33:08Z

cherry pick to release-3.3 in PR #614

Co-authored-by: iosmanthus <dengliming@pingcap.com>

add docs for api v2 and tls reload

5122d6c

Signed-off-by: iosmanthus <myosmanthustree@gmail.com>

iosmanthus requested a review from sunxiaoguang June 14, 2022 08:30

iosmanthus requested a review from zhangyangyu June 14, 2022 09:35

zhangyangyu reviewed Jun 14, 2022

View reviewed changes

docs/src/administration/configuration.md Outdated Show resolved Hide resolved

Daemonxiao reviewed Jun 14, 2022

View reviewed changes

iosmanthus and others added 3 commits June 14, 2022 18:29

fix the default value tikv.tls.reload_interval

c85d0c1

Signed-off-by: iosmanthus <myosmanthustree@gmail.com>

add tikv.conn.recycle_time details

15f2a8e

Signed-off-by: iosmanthus <myosmanthustree@gmail.com>

Merge branch 'master' into add-docs-for-api-v2-and-tls-reload

07a916d

iosmanthus added the needs-cherry-pick-3.3 label Jun 15, 2022

pingyu reviewed Jun 15, 2022

View reviewed changes

apply suggestion about API V2 from pingyu

2691bca

Signed-off-by: iosmanthus <myosmanthustree@gmail.com>

iosmanthus force-pushed the add-docs-for-api-v2-and-tls-reload branch from f8258de to 2691bca Compare June 15, 2022 06:29

pingyu previously approved these changes Jun 15, 2022

View reviewed changes

ti-srebot added the status/LGT1 label Jun 15, 2022

zhangyangyu previously approved these changes Jun 15, 2022

View reviewed changes

sunxiaoguang reviewed Jun 15, 2022

View reviewed changes

apply suggestion from xiaoguang

787402b

Signed-off-by: iosmanthus <myosmanthustree@gmail.com>

iosmanthus dismissed stale reviews from zhangyangyu and pingyu via 787402b June 15, 2022 07:16

sunxiaoguang approved these changes Jun 15, 2022

View reviewed changes

ti-srebot removed the status/LGT1 label Jun 15, 2022

ti-srebot approved these changes Jun 15, 2022

View reviewed changes

ti-srebot added the status/LGT2 label Jun 15, 2022

iosmanthus merged commit 7e6af29 into tikv:master Jun 15, 2022

iosmanthus deleted the add-docs-for-api-v2-and-tls-reload branch June 15, 2022 07:31

ti-srebot pushed a commit to ti-srebot/client-java that referenced this pull request Jun 15, 2022

cherry pick tikv#611 to release-3.3

1df348b

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

ti-srebot mentioned this pull request Jun 15, 2022

[close #610] [to #590] add docs for api v2 and tls reload (#611) #614

Merged

iosmanthus added a commit that referenced this pull request Jun 15, 2022

[close #610] [to #590] add docs for api v2 and tls reload (#611) (#614)

191cea0

Co-authored-by: iosmanthus <dengliming@pingcap.com>



		## API V2
		With TiKV version >= 6.1.0, we release a new feature that allows the coexistence of transcation data and raw data. This feature could allow the [TiCDC](https://github.com/tikv/migration/tree/main/cdc) to capture the change of the data, and these events could be consumed by the downstream infrastructure like Kafka or another TiKV cluster for backup.

[close #610] [to #590] add docs for api v2 and tls reload #611

[close #610] [to #590] add docs for api v2 and tls reload #611

Uh oh!

Conversation

iosmanthus commented Jun 14, 2022

What problem does this PR solve?

Related changes

Uh oh!

codecov bot commented Jun 14, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

pingyu left a comment

Choose a reason for hiding this comment

Uh oh!

ti-srebot commented Jun 15, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ti-srebot commented Jun 15, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

codecov bot commented Jun 14, 2022 •

edited

Loading