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

docs: add persisted query configuration options info #3652

Merged
merged 8 commits into from
Aug 30, 2023

Conversation

Meschreiber
Copy link
Contributor

This PR adds information about persisted queries router configuration options. The "security levels" or "modes" were already documented, but this adds reference information about the individual options. I've purposefully put them after the modes, since those are likely to be more useful to readers.

I'm targeting main since this is only a docs change. LMK if that's not right.

@router-perf
Copy link

router-perf bot commented Aug 22, 2023

CI performance tests

  • step - Basic stress test that steps up the number of users over time
  • events_without_dedup - Stress test for events with a lot of users and deduplication DISABLED
  • xlarge-request - Stress test with 10 MB request payload
  • xxlarge-request - Stress test with 100 MB request payload
  • events_big_cap_high_rate - Stress test for events with a lot of users, deduplication enabled and high rate event with a big queue capacity
  • const - Basic stress test that runs with a constant number of users
  • reload - Reload test over a long period of time at a constant rate of users
  • large-request - Stress test with a 1 MB request payload
  • events - Stress test for events with a lot of users and deduplication ENABLED
  • step-jemalloc-tuning - Clone of the basic stress test for jemalloc tuning
  • no-graphos - Basic stress test, no GraphOS.

@Geal Geal requested review from a team, garypen, bnjjj and o0Ignition0o August 23, 2023 08:08
@Meschreiber Meschreiber marked this pull request as ready for review August 23, 2023 15:13
@Meschreiber Meschreiber requested a review from a team as a code owner August 23, 2023 15:13
@Meschreiber
Copy link
Contributor Author

Thanks for reviewing @Geal and @bnjjj . It looks like this and one other docs PR (cc @smyrick ) are failing CI checks and therefore can't be merged. Not sure why .mdx only changes would cause that. Would you be able to take a look whenever you get a chance? TIA!

@Geal Geal changed the base branch from main to dev August 29, 2023 10:24
@Geal
Copy link
Contributor

Geal commented Aug 29, 2023

@Meschreiber all PRs have to target dev, because we have a release process that's a bit complex and breaks if a commit goes directly to main without going in dev first.
The docs change fail CI because we have a test that goes through the configuration examples in the docs and validates them with the router's code. For #3613, it was failing because the configuration requires an environment variable that the test process does not know about.
For this PR it fails with could not deserialize configuration: apqs must be disabled to enable safelisting: either set preview_persisted_queries.safelist.enabled: false or apq.enabled: false in your router yaml configuration

So I think it requires this configuration for the safelist examples:

preview_persisted_queries:
  enabled: true
  safelist:
    enabled: true
apq:
  enabled: false

@Geal
Copy link
Contributor

Geal commented Aug 29, 2023

@Meschreiber sorry, I reconfirmed out of band: it's fine to push a documentation update directly to main, we'll handle it during the release process

@Geal Geal changed the base branch from dev to main August 29, 2023 11:43
@Meschreiber Meschreiber changed the title Add configuration options info docs: add configuration options info Aug 29, 2023
@Meschreiber Meschreiber changed the title docs: add configuration options info docs: add persisted query configuration options info Aug 29, 2023
@Meschreiber
Copy link
Contributor Author

The docs change fail CI because we have a test that goes through the configuration examples in the docs and validates them with the router's code. For #3613, it was failing because the configuration requires an environment variable that the test process does not know about.

Ah neat, thanks for fixing that and suggesting the fix for this one!

@abernix abernix merged commit 81de605 into main Aug 30, 2023
@abernix abernix deleted the ms/pq-router-configuration-docs branch August 30, 2023 05:00
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