Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for SEM #5647

Merged
merged 2 commits into from
May 26, 2021
Merged

Add documentation for SEM #5647

merged 2 commits into from
May 26, 2021

Conversation

morgo
Copy link
Contributor

@morgo morgo commented May 19, 2021

What is changed, added or deleted? (Required)

This adds the docs for https://github.com/pingcap/tidb/blob/master/docs/design/2021-03-09-security-enhanced-mode.md

Which was merged in a series of PRs to master. The exact restrictions may evolve over time, so the wording is kept to use simple language to say "restrictions include". It is intended for use in cloud environments where the "root" privilege is considered too powerful.

Which TiDB version(s) do your changes apply to? (Required)

This only affects master.

  • master (the latest development version)
  • v5.0 (TiDB 5.0 versions)
  • v4.0 (TiDB 4.0 versions)
  • v3.1 (TiDB 3.1 versions)
  • v3.0 (TiDB 3.0 versions)
  • v2.1 (TiDB 2.1 versions)

What is the related PR or file link(s)?

pingcap/tidb#24416
pingcap/tidb#24412
pingcap/tidb#24279
pingcap/tidb#23978

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@ti-chi-bot ti-chi-bot requested a review from TomShawn May 19, 2021 01:17
@ti-chi-bot ti-chi-bot added missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 19, 2021
@TomShawn TomShawn added for-future-release This PR only applies to master for now and might cherry-pick to a future release. sig/docs Indicates that the Issue or PR belongs to the docs SIG. area/sql-infra Indicates that the Issue or PR belongs to the area of sql-infra and sql-metadata. translation/doing This PR's assignee is translating this PR. labels May 19, 2021
@ti-chi-bot ti-chi-bot removed the missing-translation-status This PR does not have translation status info. label May 19, 2021
@bb7133
Copy link
Member

bb7133 commented May 21, 2021

/lgtm

@ti-chi-bot ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label May 21, 2021
@bb7133
Copy link
Member

bb7133 commented May 21, 2021

PTAL @SunRunAway

@@ -427,6 +427,17 @@ Constraint checking is always performed in place for pessimistic transactions (d
- Default value: ON
- This variable controls whether to record the execution information of each operator in the slow query log.

### tidb_enable_enhanced_security
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this variable readonly?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@morgo PTAL

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes it is. Or more specifically it is Scope: None, which is the same as read-only.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TiDB system variables behave similar to MySQL with some differences, in that settings might apply on a SESSION, INSTANCE, or GLOBAL scope, or on a scope that combines SESSION, INSTANCE, or GLOBAL.

  • Changes to GLOBAL scoped variables only apply to new connection sessions with TiDB. Currently active connection sessions are not affected. These changes are persisted and valid after restarts.
  • Changes to INSTANCE scoped variables apply to all active or new connection sessions with the current TiDB instance immediately after the changes are made. Other TiDB instances are not affected. These changes are not persisted and become invalid after TiDB restarts.

The document does not mention any about what Scope: None means. Cloud you add some explanations?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with you. I will change it tomorrow to say Read Only instead.

(There are some minor differences, but they don't matter to users.)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is improved in c8758d7 , PTAL again thx :-)

@ti-chi-bot
Copy link
Member

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • SunRunAway
  • bb7133

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

The full list of commands accepted by this bot can be found here.

Reviewer can indicate their review by writing /lgtm in a comment.
Reviewer can cancel approval by writing /lgtm cancel in a comment.

@ti-chi-bot ti-chi-bot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels May 26, 2021
@SunRunAway
Copy link
Contributor

/merge

@ti-chi-bot
Copy link
Member

This pull request has been accepted and is ready to merge.

Commit hash: c8758d7

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label May 26, 2021
@ti-chi-bot ti-chi-bot merged commit 0d696a3 into pingcap:master May 26, 2021
@TomShawn TomShawn added the requires-followup This PR requires a follow-up task after being merged. label May 26, 2021
@TomShawn
Copy link
Contributor

Follow-up: Minor wording issue

@Joyinqin
Copy link
Contributor

Joyinqin commented Jun 1, 2021

/translation done
/remove-translation doing

@ti-chi-bot ti-chi-bot added the translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. label Jun 1, 2021
@ti-chi-bot ti-chi-bot removed the translation/doing This PR's assignee is translating this PR. label Jun 1, 2021
@TomShawn TomShawn added the v5.1 This PR/issue applies to TiDB v5.1. label Jun 1, 2021
@TomShawn TomShawn mentioned this pull request Jun 2, 2021
11 tasks
@TomShawn TomShawn removed requires-followup This PR requires a follow-up task after being merged. for-future-release This PR only applies to master for now and might cherry-pick to a future release. labels Jun 2, 2021
@morgo morgo deleted the add-sem-docs branch June 2, 2021 15:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/sql-infra Indicates that the Issue or PR belongs to the area of sql-infra and sql-metadata. sig/docs Indicates that the Issue or PR belongs to the docs SIG. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT2 Indicates that a PR has LGTM 2. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. v5.1 This PR/issue applies to TiDB v5.1.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants