Skip to content

Conversation

@d-bytebase
Copy link
Contributor

@d-bytebase d-bytebase commented Aug 13, 2025

Summary

  • Improved clarity of the Kubernetes section with better organization
  • Added comprehensive example for file-based secret mounting
  • Documented automatic secret rotation capabilities

Changes

  • Reorganized "Running with Kubernetes" section with clearer subheadings
  • Renamed subsections for better clarity: "Direct Configuration" and "Secret-Based Configuration"
  • Added detailed YAML example showing how to mount secrets as files
  • Explained that Kubernetes automatically updates mounted file content when secrets are rotated
  • Clarified that Bytebase monitors file changes and reloads connection strings without restart

Test Plan

  • Preview documentation changes in Mintlify
  • Verify YAML examples are syntactically correct
  • Confirm technical accuracy of secret rotation behavior

🤖 Generated with Claude Code

Copilot AI review requested due to automatic review settings August 13, 2025 08:52
@vercel
Copy link

vercel bot commented Aug 13, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Project Deployment Preview Comments Updated (UTC)
bytebase-com Ready Preview Comment Aug 13, 2025 8:58am

@github-actions
Copy link

github-actions bot commented Aug 13, 2025

📝 Broken Links Check Report

Note: Entries under /api-reference/ are likely false positives and can be ignored.

The following is the output from the broken links check:

found 16 broken links in 9 files

integrations/api/audit-log.mdx
 ⎿  /api-reference/auditlogservice/post-v1auditlogs:search

integrations/api/authentication.mdx
 ⎿  /api-reference/authservice/post-v1authlogin

integrations/api/data-classification.mdx
 ⎿  /api-reference/settingservice/patch-v1settings
 ⎿  /api-reference/databaseservice/patch-v1instances-databases

integrations/api/issue.mdx
 ⎿  /api-reference/issueservice/post-v1projects-issues

integrations/api/permission.mdx
 ⎿  /api-reference/workspaceservice/get-v1workspaces-:getIamPolicy
 ⎿  /api-reference/projectservice/get-v1projects-:getIamPolicy
 ⎿  /api-reference/roleservice/get-v1roles
 ⎿  /api-reference/userservice/get-v1users
 ⎿  /api-reference/groupservice/get-v1groups

integrations/api/plan.mdx
 ⎿  /api-reference/planservice/post-v1projects-plans
 ⎿  /api-reference/sheetservice/post-v1projects-sheets

integrations/api/release.mdx
 ⎿  /api-reference/releaseservice/post-v1projects-releases

integrations/api/rollout.mdx
 ⎿  /api-reference/rolloutservice/post-v1projects-rollouts

integrations/api/sql-review.mdx
 ⎿  /api-reference/releaseservice/post-v1projects-releases:check
 ⎿  /api-reference/sqlservice/post-v1sqlcheck

- Rename "Running with Kubernetes" to "Kubernetes Deployment" for clarity
- Reorganize secret configuration with clearer subheadings
- Add comprehensive example for mounting secrets as files
- Document automatic secret rotation behavior with file mounts
- Clarify that Bytebase monitors file changes for seamless updates

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
Copy link
Member

@tianzhou tianzhou left a comment

Choose a reason for hiding this comment

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

LGTM

@d-bytebase d-bytebase merged commit 25aef15 into main Aug 13, 2025
4 of 5 checks passed
@d-bytebase d-bytebase deleted the docs/improve-k8s-external-postgres branch August 13, 2025 08:58
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.

3 participants