sdk: Configure custom proxy VM via QubesDB/env; update docs #2236
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Instead of using a custom `/etc/sd-sdk.conf` for setting a custom proxy VM, use our now established pattern of using QubesDB or the environment. I am somewhat dubious of the use case of using a different proxy VM, but I can see how it could be useful for some debugging operations. Update and remove a lot of documentation around updating VCR cassettes that was outdated but referenced this configuration mechanism. Fixes #2040.
cfm
approved these changes
Oct 1, 2024
| @@ -39,11 +39,13 @@ class Config: | |||
| "gpg_domain": "QUBES_GPG_DOMAIN", | |||
| "journalist_key_fingerprint": "SD_SUBMISSION_KEY_FPR", | |||
| "download_retry_limit": "SD_DOWNLOAD_RETRY_LIMIT", | |||
| "proxy_vm_name": "SD_PROXY_VM_NAME", | |||
There was a problem hiding this comment.
Very nit: Now that we have two keys that refer to other VMs, do we want to standardize their naming? QUBES_GPG_DOMAIN isn't up to us. Is SD_*_VM_NAME the convention we want to use for the ones that are? I would probably accept the asymmetry (as we do for SD_SUBMISSION_KEY_FPR) of:
Suggested change
| "proxy_vm_name": "SD_PROXY_VM_NAME", | |
| "proxy_vm_name": "SD_PROXY_VM", # or "SD_PROXY_DOMAIN" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Status
Ready for review
Description
Instead of using a custom
/etc/sd-sdk.conffor setting a custom proxy VM, use our now established pattern of using QubesDB or the environment.I am somewhat dubious of the use case of using a different proxy VM, but I can see how it could be useful for some debugging operations.
Update and remove a lot of documentation around updating VCR cassettes that was outdated but referenced this configuration mechanism.
Fixes #2040.
Test Plan
Checklist