fix: vault credentials and chproxy config

[chronark]

What does this PR do?

This PR updates the ClickHouse proxy configuration and adds Vault S3 configuration in the deployment environment. Key changes include:

1. Removed UNKEY_CHPROXY_ENABLED flag and simplified the logic to enable ClickHouse proxy endpoints based on the presence of an auth token
2. Added Vault S3 configuration variables to the docker-compose file
3. Renamed the S3 secret access key environment variable from VAULT_S3_SECRET_ACCESS_KEY to VAULT_S3_ACCESS_KEY_SECRET for consistency
4. Fixed pagination configuration in the OpenAPI spec for the listIdentities endpoint
5. Added API tags to improve documentation organization
6. Fixed case sensitivity in the Role schema reference

Type of change

• Bug fix (non-breaking change which fixes an issue)
• Chore (refactoring code, technical debt, workflow improvements)
• Enhancement (small improvements)

How should this be tested?

• Verify that ClickHouse proxy endpoints work correctly when a token is provided
• Test Vault S3 integration with the new environment variables
• Confirm that the listIdentities pagination works correctly
• Check that API documentation shows proper tag organization

Checklist

Required

• Filled out the "How to test" section in this PR
• Read Contributing Guide
• Self-reviewed my own code
• Commented on my code in hard-to-understand areas
• Ran pnpm build
• Ran pnpm fmt
• Checked for warnings, there are none
• Removed all console.logs
• Merged the latest changes from main onto my branch with git pull origin main
• My changes don't cause any responsiveness issues

Summary by CodeRabbit

• New Features

  • Added support for configuring S3-compatible storage via new environment variables.
  • OpenAPI documentation now includes descriptive tags for API groups.

• Improvements

  • API role schema references standardized to lowercase for consistency.
  • Pagination cursor for listing identities is now provided in the request body instead of parameters.
  • Updated naming for S3 access key secret in CLI/environment configuration.
  • Registration of ClickHouse proxy routes now depends on presence of auth token instead of a boolean flag.

• Removals

  • Removed the option to enable or disable ClickHouse proxy endpoints via configuration and CLI flag.
  • Eliminated related internal configuration fields for ClickHouse proxy.

• Style

  • Improved formatting and alignment in code comments and struct definitions.

[vercel]

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

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
dashboard	⬜️ Ignored (Inspect)	Visit Preview		Jul 30, 2025 8:10am
engineering	⬜️ Ignored (Inspect)	Visit Preview		Jul 30, 2025 8:10am

[changeset-bot]

⚠️ No Changeset found

Latest commit: 22e1e8d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

📝 Walkthrough

Walkthrough

This change removes the chproxy feature and its related configuration from the API server, including environment variables, CLI flags, struct fields, and conditional logic. It also updates OpenAPI specifications to rename the "Role" schema to "role," adjusts pagination input for an endpoint, and adds descriptive tags to the API documentation.

Changes

Cohort / File(s)	Change Summary
Docker Compose Environment Variables deployment/docker-compose.yaml	Removed UNKEY_CHPROXY_ENABLED; added Vault S3-related environment variables for the apiv2 service.
API Configuration and CLI Flags go/apps/api/config.go, go/cmd/api/main.go	Removed ChproxyEnabled field and CLI flag; updated S3 secret key flag and environment variable names.
Service Struct and Initialization go/apps/api/routes/services.go, go/apps/api/run.go	Removed ChproxyEnabled from Services struct and its initialization.
Route Registration Logic go/apps/api/routes/register.go	Changed chproxy endpoint registration to depend on ChproxyToken being non-empty instead of a boolean flag.
OpenAPI Specification: Role Schema Renaming go/apps/api/openapi/openapi-generated.yaml, go/apps/api/openapi/gen.go, go/apps/api/openapi/spec/paths/v2/permissions/getRole/V2PermissionsGetRoleResponseData.yaml, go/apps/api/openapi/spec/paths/v2/permissions/listRoles/V2PermissionsListRolesResponseData.yaml	Renamed schema from "Role" to "role" and updated all references; moved Role struct definition in generated code.
OpenAPI Specification: Pagination and Tags go/apps/api/openapi/openapi-split.yaml, go/apps/api/openapi/spec/paths/v2/identities/listIdentities/index.yaml	Changed pagination cursor input from parameters to request body; added top-level tags for API groups.
Formatting Only go/pkg/codes/constants_gen.go	Adjusted indentation of comments for error code constants.
Linting Comments Added go/benchmarks/keyverify.js, go/benchmarks/ratelimit.js	Added comments to disable lint rule for default exports required by k6 tool.

Sequence Diagram(s)

sequenceDiagram
    participant CLI
    participant Config
    participant Services
    participant RegisterRoutes

    CLI->>Config: Parse CLI flags (no chproxy-enabled)
    Config->>Services: Initialize (no ChproxyEnabled)
    Services->>RegisterRoutes: Register endpoints
    RegisterRoutes->>RegisterRoutes: If ChproxyToken != "", register chproxy endpoints

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15–20 minutes

Possibly related PRs

• chore: replace chproxy with our own api #3647: The main PR removes the chproxy feature and related configuration, while the retrieved PR adds and integrates chproxy internal API endpoints and configuration; thus, they make opposite changes to the same chproxy-related code and configuration elements.

Suggested labels

Core Team

Suggested reviewers

• perkinsjr
• mcstepp
• MichaelUnkey
• ogzhanolguncu

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch 07-30-fix_vault_credentials_and_chproxy_config

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[chronark]

• fix: vault credentials and chproxy config #3681 👈 (View in Graphite)
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[github-actions]

Thank you for following the naming conventions for pull request titles! 🙏

[coderabbitai]

Actionable comments posted: 2

🔭 Outside diff range comments (1)

go/benchmarks/ratelimit.js (1)

36-38: Stage comment mismatches the configured duration

The stage is configured for 10m, but the inline comment still says “for 1 minute”. Keeping these in sync avoids misunderstandings during test runs.

-    { duration: "10m", target: 10 }, // 10 req/s for 1 minute
+    { duration: "10m", target: 10 }, // 10 req/s for 10 minutes

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ff33d81 and 22e1e8d.

📒 Files selected for processing (3)

• go/benchmarks/keyverify.js (1 hunks)
• go/benchmarks/ratelimit.js (1 hunks)
• go/cmd/api/main.go (3 hunks)

🧰 Additional context used

🧠 Learnings (4)

📓 Common learnings

Learnt from: ogzhanolguncu
PR: unkeyed/unkey#3324
File: apps/dashboard/app/(app)/authorization/roles/components/table/components/actions/keys-table-action.popover.constants.tsx:17-18
Timestamp: 2025-06-19T11:48:05.070Z
Learning: In the authorization roles refactor, the RoleBasic type uses `roleId` as the property name for the role identifier, not `id`. This is consistent throughout the codebase in apps/dashboard/lib/trpc/routers/authorization/roles/query.ts.

go/benchmarks/ratelimit.js (2)

Learnt from: chronark
PR: #2544
File: apps/api/src/pkg/env.ts:4-6
Timestamp: 2024-10-23T12:05:31.121Z
Learning: The cloudflareRatelimiter type definition in apps/api/src/pkg/env.ts should not have its interface changed; it should keep the limit method returning Promise<{ success: boolean }> without additional error properties.

Learnt from: CR
PR: unkeyed/unkey#0
File: go/deploy/CLAUDE.md:0-0
Timestamp: 2025-07-21T18:05:58.236Z
Learning: Applies to go/deploy/**/*.{go,js,ts,tsx,py,sh,md,txt,json,yaml,yml,ini,env,conf,html,css,scss,xml,c,h,cpp,java,rb,rs,php,pl,sql} : Make sure to add relevant anchor comments whenever a file or piece of code is too complex, very important, confusing, or could have a bug.

go/benchmarks/keyverify.js (3)

Learnt from: CR
PR: unkeyed/unkey#0
File: go/deploy/CLAUDE.md:0-0
Timestamp: 2025-07-21T18:05:58.236Z
Learning: Applies to go/deploy/**/*.{go,js,ts,tsx,py,sh,md,txt,json,yaml,yml,ini,env,conf,html,css,scss,xml,c,h,cpp,java,rb,rs,php,pl,sql} : Make sure to add relevant anchor comments whenever a file or piece of code is too complex, very important, confusing, or could have a bug.

Learnt from: ogzhanolguncu
PR: #3292
File: apps/dashboard/lib/trpc/routers/key/create.ts:11-14
Timestamp: 2025-06-02T11:09:58.791Z
Learning: In the unkey codebase, TypeScript and the env() function implementation already provide sufficient validation for environment variables, so additional runtime error handling for missing env vars is not needed.

Learnt from: ogzhanolguncu
PR: #3242
File: apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/[keyId]/components/table/hooks/use-logs-query.ts:228-231
Timestamp: 2025-05-15T16:21:50.911Z
Learning: The codebase for Unkey allows the use of modern JavaScript features like Array.prototype.toSorted() even though they may not be supported in all browsers.

go/cmd/api/main.go (2)

Learnt from: CR
PR: unkeyed/unkey#0
File: go/deploy/CLAUDE.md:0-0
Timestamp: 2025-07-21T18:05:58.236Z
Learning: Applies to go/deploy/**/*.{env,sh,yaml,yml,json,conf,ini} : All environment variables MUST follow the format UNKEY_<SERVICE_NAME>_VARNAME.

Learnt from: ogzhanolguncu
PR: #3564
File: go/cmd/cli/commands/deploy/flags.go:17-20
Timestamp: 2025-07-15T14:45:18.920Z
Learning: In the go/cmd/cli/commands/deploy/ directory, ogzhanolguncu prefers to keep potentially temporary features (like UNKEY_DOCKER_REGISTRY environment variable) undocumented in help text if they might be deleted in the future, to avoid documentation churn.

🧬 Code Graph Analysis (1)

go/cmd/api/main.go (1)

go/pkg/cli/flag.go (2)

• String (331-363)
• EnvVar (252-267)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)

• GitHub Check: Build / Build
• GitHub Check: Test API / API Test Local
• GitHub Check: Test Agent Local / test_agent_local
• GitHub Check: Test Go API Local / Test
• GitHub Check: Test Packages / Test

🔇 Additional comments (3)

go/cmd/api/main.go (3)

71-72: LGTM! Improved naming consistency for S3 configuration.

The rename from vault-s3-secret-access-key to vault-s3-access-key-secret improves clarity by grouping S3 access key related configurations together. The environment variable follows the correct UNKEY_<SERVICE>_<VARNAME> pattern.

---

109-109: LGTM! Correctly updated field assignment to match renamed CLI flag.

The field assignment properly uses the renamed CLI flag vault-s3-access-key-secret, maintaining consistency with the flag definition changes.

---

148-148: LGTM! Simplified chproxy configuration approach.

The assignment of ChproxyToken from the CLI flag is consistent with the refactoring to remove the separate chproxy-enabled flag. This simplifies the configuration by using the presence of a non-empty token to determine if chproxy features should be enabled.

[graphite-app]

Graphite Automations

"Notify author when CI fails" took an action on this PR • (07/30/25)

1 teammate was notified to this PR based on Andreas Thomas's automation.

"Post a GIF when PR approved" took an action on this PR • (07/30/25)

1 gif was posted to this PR based on Andreas Thomas's automation.

[graphite-app]