docs: update architecture docs for production hardening changes#649
Closed
persimmon16 wants to merge 1 commit intoNVIDIA:mainfrom
Closed
docs: update architecture docs for production hardening changes#649persimmon16 wants to merge 1 commit intoNVIDIA:mainfrom
persimmon16 wants to merge 1 commit intoNVIDIA:mainfrom
Conversation
Update gateway, gateway-security, and sandbox architecture docs to reflect production hardening work: graceful shutdown with connection draining, database pool timeouts, configurable Postgres pool size, PKI certificate validity periods (10y CA, 1y leaf), TLS handshake timeout, CancellationToken-based background task shutdown, sandbox watcher backpressure and label selector filtering, configurable broadcast buffer capacity, and grpc.rs module split.
|
Thank you for your interest in contributing to OpenShell, @persimmon16. This project uses a vouch system for first-time contributors. Before submitting a pull request, you need to be vouched by a maintainer. To get vouched:
See CONTRIBUTING.md for details. |
|
Thank you for your submission! We ask that you sign our Developer Certificate of Origin before we can accept your contribution. You can sign the DCO by adding a comment below using this text: I have read the DCO document and I hereby sign the DCO. You can retrigger this bot by commenting recheck in this Pull Request. Posted by the DCO Assistant Lite bot. |
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
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.
Summary
architecture/gateway.mdwith graceful shutdown, database pool timeouts, TLS hardening, configurable pool size, sandbox watcher improvements, and grpc module splitarchitecture/gateway-security.mdwith certificate validity periods and TLS handshake timeoutarchitecture/sandbox.mdwith background task lifecycle and watcher hardening detailsRelated Issue
Production readiness audit: documentation must reflect all architecture changes from the hardening PRs.
Changes
architecture/gateway.md: 6 new subsections covering shutdown, pools, TLS, watcher, broadcast buffer, grpc splitarchitecture/gateway-security.md: Updated PKI validity, added TLS timeout, updated residual risksarchitecture/sandbox.md: Added background task lifecycle and watcher hardening sectionsTesting
Checklist