Skip to content

tidb-cloud: the IAM policy example in migrate-from-op-tidb.md is not valid JSON #24574

Open

Description

@yahonda

Error Report

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

tidb-cloud/migrate-from-op-tidb.md, step 3 of "Set up access to Amazon S3" (the IAM policy example at lines 224-264 on master and release-8.5).

Step 3 tells users to create the policy on the JSON tab of the IAM console, and the following code block is labeled json. However, the example is not valid JSON, so the JSON editor rejects it if users paste it as is:

  • The block starts with four ## comment lines (the template title and the descriptions of <Your customized directory>, <Your S3 bucket ARN>, and <Your AWS KMS ARN>).
  • A // comment line appears inside the Statement array.
  • The comma after the s3:ListBucket statement is missing (it appears on its own line after the next statement instead).
  • The kms:Decrypt permission for <Your AWS KMS ARN> is listed twice, in two separate statements.
  1. How would you like to improve it?
  • Move the ## placeholder descriptions and the SSE-KMS note out of the code block, as plain text before it.
  • Make the code block valid JSON: fix the comma placement and keep only one kms:Decrypt statement.
  • Optionally, show the KMS statement as a separate snippet (or describe it in text) because it is needed only when SSE-KMS is enabled for the bucket.

The Japanese translation keeps the code block byte for byte from the English, so it will follow the English fix through the weekly sync. This was found by CodeRabbit on the Japanese PR #24566.

🤖 Generated with Claude Code

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions