commonflags

Documentation

Index

• Variables
• func DefaultCommonOptionsFromFlags() options.CommonOptions

Variables

var (
	AdminAddress                    = flag.String("admin_address", defaults.AdminAddress, "Address that envoy should serve the admin page on. Supports both ipv4 and ipv6 addresses.")
	AdsNamedPipe                    = flag.String("ads_named_pipe", defaults.AdsNamedPipe, "Unix domain socket to use internally for xDs between config manager and envoy.")
	DisableTracing                  = flag.Bool("disable_tracing", defaults.TracingOptions.DisableTracing, `Disable stackdriver tracing`)
	AdminPort                       = flag.Int("admin_port", defaults.AdminPort, "Enables envoy's admin interface on this port if it is not 0. Not recommended for production use-cases, as the admin port is unauthenticated.")
	HttpRequestTimeoutS             = flag.Int("http_request_timeout_s", int(defaults.HttpRequestTimeout.Seconds()), `Set the timeout in second for all requests. Must be > 0 and the default is 30 seconds if not set.`)
	Node                            = flag.String("node", defaults.Node, "envoy node id")
	NonGCP                          = flag.Bool("non_gcp", defaults.NonGCP, `By default, the proxy tries to talk to GCP metadata server to get VM location in the first few requests. Setting this flag to true to skip this step`)
	GeneratedHeaderPrefix           = flag.String("generated_header_prefix", defaults.GeneratedHeaderPrefix, "Set the header prefix for the generated headers. By default, it is `X-Endpoint-`")
	TracingProjectId                = flag.String("tracing_project_id", defaults.TracingOptions.ProjectId, "The Google project id required for Stack driver tracing. If not set, will automatically use fetch it from GCP Metadata server")
	TracingStackdriverAddress       = flag.String("tracing_stackdriver_address", defaults.TracingOptions.StackdriverAddress, "By default, the Stackdriver exporter will connect to production Stackdriver. If this is non-empty, it will connect to this address. It must be in the gRPC format and implement the cloud trace v2 RPCs.")
	TracingSamplingRate             = flag.Float64("tracing_sample_rate", defaults.TracingOptions.SamplingRate, "tracing sampling rate from 0.0 to 1.0")
	TracingIncomingContext          = flag.String("tracing_incoming_context", defaults.TracingOptions.IncomingContext, "comma separated incoming trace contexts (traceparent|grpc-trace-bin|x-cloud-trace-context)")
	TracingOutgoingContext          = flag.String("tracing_outgoing_context", defaults.TracingOptions.OutgoingContext, "comma separated outgoing trace contexts (traceparent|grpc-trace-bin|x-cloud-trace-context)")
	TracingMaxNumAttributes         = flag.Int64("tracing_max_num_attributes", defaults.TracingOptions.MaxNumAttributes, "Sets the maximum number of attributes that each span can contain. Defaults to the maximum allowed by Stackdriver. In practice, the number of attributes published will be much less.")
	TracingMaxNumAnnotations        = flag.Int64("tracing_max_num_annotations", defaults.TracingOptions.MaxNumAnnotations, "Sets the maximum number of annotations that each span can contain. Defaults to the maximum allowed by Stackdriver. In practice, the number of annotations published will be much less.")
	TracingMaxNumMessageEvents      = flag.Int64("tracing_max_num_message_events", defaults.TracingOptions.MaxNumMessageEvents, "Sets the maximum number of message events that each span can contain. Defaults to the maximum allowed by Stackdriver. In practice, the number of message events published will be much less.")
	TracingMaxNumLinks              = flag.Int64("tracing_max_num_links", defaults.TracingOptions.MaxNumLinks, "Sets the maximum number of links that each span can contain. Defaults to the maximum allowed by Stackdriver. In practice, the number of links published will be much less.")
	TracingEnableVerboseAnnotations = flag.Bool("tracing_enable_verbose_annotations", defaults.TracingOptions.EnableVerboseAnnotations, "If enabled, spans are annotated with timing events on when the request/response started/ended")

	//Suspected Envoy has listener initialization bug: if a http filter needs to use
	//a cluster with DSN lookup for initialization, e.g. fetching a remote access
	//token, the cluster is not ready so the whole listener is destroyed. ADS will
	//repeatedly send the same listener again until the cluster is ready. Then the
	//listener is marked as ready but the whole Envoy server is not marked as ready
	//(worker did not start) somehow. To work around this problem, use IP for
	//metadata server to fetch access token.
	MetadataURL = flag.String("metadata_url", defaults.MetadataURL, "url of metadata server")
	IamURL      = flag.String("iam_url", defaults.IamURL, "url of iam server")

	ServiceControlIamServiceAccount = flag.String("service_control_iam_service_account", "", "The service account used to fetch access token for the Service Control from Google Cloud IAM")
	ServiceControlIamDelegates      = flag.String("service_control_iam_delegates", "", "The sequence of service accounts in a delegation chain used to fetch access token for the Service Control from Google Cloud IAM. The multiple delegates should be separated by \",\" and the flag only applies when ServiceControlIamServiceAccount is not empty.")

	BackendAuthIamServiceAccount       = flag.String("backend_auth_iam_service_account", "", "The service account used to fetch identity token for the Backend Auth from Google Cloud IAM")
	BackendAuthIamDelegates            = flag.String("backend_auth_iam_delegates", "", "The sequence of service accounts in a delegation chain used to fetch identity token for the Backend Auth from Google Cloud IAM. The multiple delegates should be separated by \",\" and the flag only applies when BackendAuthIamServiceAccount is not empty.")
	DisallowColonInWildcardPathSegment = flag.Bool("disallow_colon_in_wildcard_path_segment", false, `Whether disallow colon in the url wildcard path segment for route match. According to Google http url template spec[1], the literal colon cannot be used in url wildcard path segment. This flag isn't enabled for backward compatibility. 
		[1]https://github.com/googleapis/googleapis/blob/165280d3deea4d225a079eb5c34717b214a5b732/google/api/http.proto#L226-L252`)
)

Functions

func DefaultCommonOptionsFromFlags

func DefaultCommonOptionsFromFlags() options.CommonOptions