Improve cli help messages
@@ -1284,10 +1284,10 @@ fn add_event_stream_options(app: App<'static, 'static>) -> App<'static, 'static>
.validator(non_empty))
.arg(Arg::with_name(ConnectMethod::ARG_NAME).help("How long in seconds to wait for an \
event stream connection before exiting \
- the supervisor. Set to '0' to \
- immediately start the supervisor and \
+ the Supervisor. Set to '0' to \
+ immediately start the Supervisor and \
continue running regardless of the \
- event stream status.")
+ initial connection status.")
.long("event-stream-connect-timeout")
.required(false)
.takes_value(true)
@@ -1296,7 +1296,11 @@ fn add_event_stream_options(app: App<'static, 'static>) -> App<'static, 'static>
.validator(valid_numeric::<u64>))
.arg(Arg::with_name("EVENT_STREAM_URL").help("The event stream connection string \
(host:port) used by this Supervisor to send \
- events to a messaging server.")
+ events to Chef Automate. This enables \
+ the event stream and requires \
+ --event-stream-application, \
+ --event-stream-environment, and \
+ --event-stream-token also be set.")
.long("event-stream-url")
.required(false)
.requires_all(&[
@@ -1307,15 +1311,14 @@ fn add_event_stream_options(app: App<'static, 'static>) -> App<'static, 'static>
.takes_value(true)
.validator(nats_address))
.arg(Arg::with_name("EVENT_STREAM_SITE").help("The name of the site where this Supervisor \
- is running. It is used for event stream \
- purposes.")
+ is running for event stream purposes.")
.long("event-stream-site")
.required(false)
.takes_value(true)
.validator(non_empty))
- .arg(Arg::with_name(AutomateAuthToken::ARG_NAME).help("An authentication token for \
- streaming events to an messaging \
- server.")
+ .arg(Arg::with_name(AutomateAuthToken::ARG_NAME).help("The authentication token for \
+ connecting the event stream to \
+ Chef Automate.")
.long("event-stream-token")
.required(false)
.takes_value(true)
@@ -1323,15 +1326,15 @@ fn add_event_stream_options(app: App<'static, 'static>) -> App<'static, 'static>
.env(AutomateAuthToken::ENVVAR))
.arg(Arg::with_name(EventStreamMetadata::ARG_NAME).help("An arbitrary key-value pair to \
add to each event generated by \
- this Supervisor")
+ this Supervisor.")
.long("event-meta")
.takes_value(true)
.multiple(true)
.validator(EventStreamMetadata::validate))
- .arg(Arg::with_name("EVENT_STREAM_SERVER_CERTIFICATE").help("The path to the event stream \
- server's certificate in PEM \
- format used to establish a \
- TLS connection")
+ .arg(Arg::with_name("EVENT_STREAM_SERVER_CERTIFICATE").help("The path to Chef Automate's \
+ event stream certificate in \
+ PEM format used to establish \
+ a TLS connection.")
.long("event-stream-server-certificate")
.required(false)
.takes_value(true)
