refactor: separate XDG directories for config, data, state and runtime #1368
Conversation
This file contains hidden or 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
Codecov Report✅ All modified and coverable lines are covered by tests. ❌ Your project status has failed because the head coverage (78.64%) is below the target coverage (86.00%). You can increase the head coverage or adjust the target coverage. Additional details and impacted files@@ Coverage Diff @@
## main #1368 +/- ##
=======================================
Coverage 78.64% 78.64%
=======================================
Files 140 140
Lines 13789 13789
=======================================
Hits 10845 10845
Misses 2287 2287
Partials 657 657 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
**Description**
This refactors aigw to use distinct directories following XDG Base Directory
Specification conventions:
- --config-home/$AIGW_CONFIG_HOME: Configuration files (default: ~/.config/aigw)
- --data-home/$AIGW_DATA_HOME: Envoy binaries via func-e (default: ~/.local/share/aigw)
- --state-home/$AIGW_STATE_HOME: Run logs and state (default: ~/.local/state/aigw)
- --runtime-dir/$AIGW_RUNTIME_DIR: Ephemeral files like UDS (default: /tmp/aigw-${UID})
This separation aligns with XDG principles where configuration, data, state,
and runtime files are independently configurable for different storage tiers.
This is particularly useful for Docker deployments to map volumes appropriately.
This also adds --run-id/$AIGW_RUN_ID to override the default YYYYMMDD_HHMMSS_UUU
timestamp format with a custom identifier. Setting this to '0' enables predictable
paths for Docker/Kubernetes single-run scenarios.
Signed-off-by: Adrian Cole <[email protected]>
# Conflicts: # cmd/aigw/main.go # cmd/aigw/main_test.go
Signed-off-by: Takeshi Yoneda <[email protected]>
mathetake
approved these changes
Oct 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
This refactors aigw to use distinct directories following XDG Base Directory Specification conventions:
This separation aligns with XDG principles where configuration, data, state, and runtime files are independently configurable for different storage tiers. This is particularly useful for Docker deployments to map volumes appropriately.
This also adds --run-id/$AIGW_RUN_ID to override the default YYYYMMDD_HHMMSS_UUU timestamp format with a custom identifier. Setting this to '0' enables predictable paths for Docker/Kubernetes single-run scenarios.
Related Issues/PRs (if applicable)
once envoyproxy/gateway#7225 is merged we have some maintenance to remove the /tmp/envoy-gateway/certs tech debt