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

feat(server): add internal --path-prefix flag for client/server mode #7321

Merged
merged 5 commits into from
Aug 21, 2024

Conversation

knqyf263
Copy link
Collaborator

@knqyf263 knqyf263 commented Aug 8, 2024

Overview

This PR introduces a new internal flag --path-prefix for client/server mode, allowing customization of the API endpoint prefix. This feature is currently intended for internal use only and will not be exposed in the CLI help output.

$ trivy server --path-prefix myprefix
$ trivy image --server http://localhost:4954 --path-prefix myprefix debian:11

Changes

  • Add a new --path-prefix flag to customize the API endpoint prefix in server mode
  • Implement logic to
    • apply the custom prefix to all server endpoints
    • apply the custom prefix to all client requests
  • Ensure the flag is hidden from CLI help output
  • Hide deprecated/removed flags in the configuration document
  • Add integration tests

Rationale

This change is necessary for internal purposes, but we want to maintain flexibility for future modifications. By keeping it hidden, we avoid potential issues with backward compatibility if external users start relying on this feature.

Example

Current endpoint structure:

<baseURL>[<prefix>]/<package>.<Service>/<Method>

<prefix> can be customized via --path-prefix.

Notes

  • This feature will not be documented in public-facing materials
  • We may consider exporting this flag in the future if there's significant community demand

Checklist

  • I've read the guidelines for contributing to this repository.
  • I've followed the conventions in the PR title.
  • I've added tests that prove my fix is effective or that my feature works.
  • I've updated the documentation with the relevant information (if needed).
  • I've added usage information (if the PR introduces new options)
  • I've included a "before" and "after" example to the description (if the PR is a user interface change).

Signed-off-by: knqyf263 <knqyf263@gmail.com>
Signed-off-by: knqyf263 <knqyf263@gmail.com>
Signed-off-by: knqyf263 <knqyf263@gmail.com>
Signed-off-by: knqyf263 <knqyf263@gmail.com>
@knqyf263 knqyf263 self-assigned this Aug 8, 2024
Signed-off-by: knqyf263 <knqyf263@gmail.com>
@knqyf263 knqyf263 marked this pull request as ready for review August 9, 2024 06:57
@knqyf263 knqyf263 requested a review from afdesk August 12, 2024 05:22
Copy link
Contributor

@afdesk afdesk left a comment

Choose a reason for hiding this comment

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

LGTM!

@knqyf263
Copy link
Collaborator Author

@DmitriyLewen It needs approval from someone who has write permission. Would you take a quick look?

Copy link
Contributor

@DmitriyLewen DmitriyLewen left a comment

Choose a reason for hiding this comment

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

LGTM

@knqyf263 knqyf263 added this pull request to the merge queue Aug 21, 2024
Merged via the queue into aquasecurity:main with commit 24a4563 Aug 21, 2024
17 checks passed
@knqyf263 knqyf263 deleted the custom_prefix branch August 21, 2024 05:44
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.

4 participants