Skip to content

docs: installation-wide collection scope and AWS key mapping - #14

Merged
lesandie merged 2 commits into
masterfrom
docs/s3-scope-and-key-mapping
Sep 25, 2026
Merged

lesandie merged 2 commits into
masterfrom
docs/s3-scope-and-key-mapping

Conversation

@lesandie

@lesandie lesandie commented Sep 24, 2026 •

Copy link
Copy Markdown
Member

Summary

  • Document collecting the parent prefix (clickhouse/<installation>/) for an installation-wide cleanup, instead of one <installation>/<replica>/ prefix. With CLUSTERNAME set, dry-run and delete compare against every replica's system.remote_data_paths (s3gc.py:1258-1260).
  • Document that static mode ignores AWS_ACCESS_KEY_ID/AWS_SECRET_ACCESS_KEY/AWS_SESSION_TOKEN, and add a mapping table to the S3GC_* Secret keys.
  • CHANGELOG entries for both.

These are doc-only changes, so they are exempt from spec+TDD under CLAUDE.md rule 2.

Test plan

  • pytest -v -m "not dev_cluster" passes (docs only, no code change)
  • Review wording in deploy/kubernetes/README.md step 2 and the static Secret section

🤖 Generated with Claude Code

Operators collected a single replica prefix, missing the other replicas'
orphans, and expected the standard AWS credential variables to work in
static mode. Document collecting the parent prefix with the clustered
comparison, and map AWS_* names to the S3GC_* Secret keys.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 24, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-24T08:59:39.787483Z 55b80e5 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 55b80e5691

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread deploy/kubernetes/README.md Outdated
Comment on lines +56 to +58
For an installation-wide cleanup, set `S3PATH` to the parent prefix that
contains every replica's objects, such as `clickhouse/<installation>/`, not a
single `<installation>/<replica>/` prefix. Collect it once into one inventory

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Restrict parent-prefix advice to the selected disk

When an installation root contains objects for multiple S3 disks, this recommendation inventories all of them, but make_antijoin() only recognizes references whose rdp.disk_name equals the single configured S3DISKNAME. Objects belonging to another disk will therefore appear orphaned and can be irreversibly deleted after approval. Qualify this advice to require a parent prefix containing only the selected disk's objects, or document disk-isolated collection prefixes.

AGENTS.md reference: AGENTS.md:L16-L19

Useful? React with 👍 / 👎.

| --- | --- |
| `AWS_ACCESS_KEY_ID` | `S3GC_S3ACCESSKEY` |
| `AWS_SECRET_ACCESS_KEY` | `S3GC_S3SECRETKEY` |
| `AWS_SESSION_TOKEN` | `S3GC_S3SESSIONTOKEN` (optional) |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Carry the mapped session token into the Secret

For temporary AWS credentials, following this new mapping still produces an unusable Secret: the subsequent export example, kubectl create secret command, and unset command omit S3GC_S3SESSIONTOKEN. Even if the private file defines the mapped token, the literal-only command silently drops it, so static authentication fails. Add the optional token to the copy-paste workflow.

Useful? React with 👍 / 👎.

Restrict the parent-prefix collection advice to objects on a single
S3DISKNAME: the orphan check matches ClickHouse's system.remote_data_paths
by disk_name, so another disk's objects under the same prefix would be
misclassified as orphaned. Also carry the optional session token through
the Secret export/create/unset commands, which previously dropped it.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@lesandie
lesandie merged commit 9129869 into master Sep 25, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant