Skip to content

Commit 05cb494

Browse files
committed
docs(config): describe push delivery as applied, not shadow-only
Stage 2 lets supervisors apply streamed configuration, so the config enum, field, and --config-delivery-mode help no longer describe push as a shadow-only stream. Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com>
1 parent ddb231a commit 05cb494

2 files changed

Lines changed: 6 additions & 3 deletions

File tree

‎crates/openshell-core/src/config.rs‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,10 @@ pub const DEFAULT_DOCKER_NETWORK_NAME: &str = "openshell-docker";
4747
pub const DEFAULT_SERVICE_ROUTING_DOMAIN: &str = "openshell.localhost";
4848

4949
/// Gateway delivery path for supervisor configuration.
50-
/// `Push` is a shadow stream until supervisors support applying snapshots.
50+
///
51+
/// `Push` sends configuration over the supervisor session. Supervisors that
52+
/// apply streamed configuration stop polling; others keep polling and treat the
53+
/// stream as a shadow.
5154
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize)]
5255
#[serde(rename_all = "snake_case")]
5356
pub enum ConfigDeliveryMode {
@@ -233,7 +236,7 @@ pub struct Config {
233236
/// Security posture for rejected sandbox policy generations.
234237
pub policy_validation_failure_mode: PolicyValidationFailureMode,
235238

236-
/// Optional shadow push of complete supervisor configuration snapshots.
239+
/// Whether supervisors poll for configuration or receive it over their session.
237240
pub config_delivery_mode: ConfigDeliveryMode,
238241

239242
/// TLS configuration. When `None`, the server listens on plaintext HTTP.

‎crates/openshell-server/src/cli.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ struct RunArgs {
239239
#[arg(long, env = "OPENSHELL_GRPC_RATE_LIMIT_WINDOW_SECONDS")]
240240
grpc_rate_limit_window_seconds: Option<u64>,
241241

242-
/// Supervisor configuration delivery. Push sends shadow snapshots in this release.
242+
/// Supervisor configuration delivery: poll (default) or push over the supervisor session.
243243
#[arg(long, env = "OPENSHELL_CONFIG_DELIVERY_MODE")]
244244
config_delivery_mode: Option<ConfigDeliveryMode>,
245245

0 commit comments

Comments
 (0)