From 1674c78e1df38fca9deddc85919a8a7b9179f34a Mon Sep 17 00:00:00 2001 From: Kevin Schoonover Date: Wed, 18 Sep 2024 16:44:48 -0700 Subject: [PATCH] fix docs Signed-off-by: Kevin Schoonover --- docs/reference/flagd-cli/flagd_start.md | 32 ++++++++++++++----------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/docs/reference/flagd-cli/flagd_start.md b/docs/reference/flagd-cli/flagd_start.md index f9da1a6f2..93a7bf564 100644 --- a/docs/reference/flagd-cli/flagd_start.md +++ b/docs/reference/flagd-cli/flagd_start.md @@ -11,20 +11,24 @@ flagd start [flags] ### Options ``` - -C, --cors-origin strings CORS allowed origins, * will allow all origins - -h, --help help for start - -z, --log-format string Set the logging format, e.g. console or json (default "console") - -m, --management-port int32 Port for management operations (default 8014) - -t, --metrics-exporter string Set the metrics exporter. Default(if unset) is Prometheus. Can be override to otel - OpenTelemetry metric exporter. Overriding to otel require otelCollectorURI to be present - -r, --ofrep-port int32 ofrep service port (default 8016) - -o, --otel-collector-uri string Set the grpc URI of the OpenTelemetry collector for flagd runtime. If unset, the collector setup will be ignored and traces will not be exported. - -p, --port int32 Port to listen on (default 8013) - -c, --server-cert-path string Server side tls certificate path - -k, --server-key-path string Server side tls key path - -d, --socket-path string Flagd socket path. With grpc the service will become available on this address. With http(s) the grpc-gateway proxy will use this address internally. - -s, --sources string JSON representation of an array of SourceConfig objects. This object contains 2 required fields, uri (string) and provider (string). Documentation for this object: https://flagd.dev/reference/sync-configuration/#source-configuration - -g, --sync-port int32 gRPC Sync port (default 8015) - -f, --uri .yaml/.yml/.json Set a sync provider uri to read data from, this can be a filepath, URL (HTTP and gRPC) or FeatureFlag custom resource. When flag keys are duplicated across multiple providers the merge priority follows the index of the flag arguments, as such flags from the uri at index 0 take the lowest precedence, with duplicated keys being overwritten by those from the uri at index 1. Please note that if you are using filepath, flagd only supports files with .yaml/.yml/.json extension. + -C, --cors-origin strings CORS allowed origins, * will allow all origins + -h, --help help for start + -z, --log-format string Set the logging format, e.g. console or json (default "console") + -m, --management-port int32 Port for management operations (default 8014) + -t, --metrics-exporter string Set the metrics exporter. Default(if unset) is Prometheus. Can be override to otel - OpenTelemetry metric exporter. Overriding to otel require otelCollectorURI to be present + -r, --ofrep-port int32 ofrep service port (default 8016) + -A, --otel-ca-path string tls certificate authority path to use with OpenTelemetry collector + -D, --otel-cert-path string tls certificate path to use with OpenTelemetry collector + -o, --otel-collector-uri string Set the grpc URI of the OpenTelemetry collector for flagd runtime. If unset, the collector setup will be ignored and traces will not be exported. + -K, --otel-key-path string tls key path to use with OpenTelemetry collector + -I, --otel-reload-interval duration how long between reloading the otel tls certificate from disk (default 1h0m0s) + -p, --port int32 Port to listen on (default 8013) + -c, --server-cert-path string Server side tls certificate path + -k, --server-key-path string Server side tls key path + -d, --socket-path string Flagd socket path. With grpc the service will become available on this address. With http(s) the grpc-gateway proxy will use this address internally. + -s, --sources string JSON representation of an array of SourceConfig objects. This object contains 2 required fields, uri (string) and provider (string). Documentation for this object: https://flagd.dev/reference/sync-configuration/#source-configuration + -g, --sync-port int32 gRPC Sync port (default 8015) + -f, --uri .yaml/.yml/.json Set a sync provider uri to read data from, this can be a filepath, URL (HTTP and gRPC) or FeatureFlag custom resource. When flag keys are duplicated across multiple providers the merge priority follows the index of the flag arguments, as such flags from the uri at index 0 take the lowest precedence, with duplicated keys being overwritten by those from the uri at index 1. Please note that if you are using filepath, flagd only supports files with .yaml/.yml/.json extension. ``` ### Options inherited from parent commands