package
1.2.4
Repository: https://github.com/openservicemesh/osm.git
Documentation: pkg.go.dev

# Constants

ADSServerPort is the port on which the Aggregated Discovery Service (ADS) listens for new gRPC connections from Envoy proxies.
AppLabel is the label used to identify the app.
CertificationAuthorityCommonName is the CN used for the root certificate for OSM.
a decade.
ClusterWeightAcceptAll is the weight for a cluster that accepts 100 percent of traffic sent to it.
DebugPort is the port on which OSM exposes its debug server.
#nosec G101: Potential hardcoded credentials.
DefaultEnvoyLogLevel is the default envoy log level if not defined in the osm MeshConfig.
DefaultOSMLogLevel is the default OSM log level if none is specified.
DefaultTracingEndpoint is the default endpoint route.
DefaultTracingHost is the default tracing server name.
DefaultTracingPort is the tracing listener port.
DomainDelimiter is a delimiter used in representing domains.
EnvoyAdminPort is Envoy's admin port.
EnvoyAdminPortName is Envoy's admin port name.
EnvoyContainerName is the name used to identify the envoy sidecar container added on mesh-enabled deployments.
EnvoyInboundListenerPort is Envoy's inbound listener port number.
EnvoyInboundListenerPortName is Envoy's inbound listener port name.
EnvoyInboundPrometheusListenerPortName is Envoy's inbound listener port name for prometheus.
EnvoyMetricsCluster is the cluster name of the Prometheus metrics cluster.
EnvoyOutboundListenerPort is Envoy's outbound listener port number.
EnvoyOutboundListenerPortName is Envoy's outbound listener port name.
EnvoyPrometheusInboundListenerPort is Envoy's inbound listener port number for prometheus.
EnvoyServiceNodeSeparator is the character separating the strings used to create an Envoy service node parameter.
EnvoyTracingCluster is the default name to refer to the tracing cluster.
EnvoyUID is the Envoy's User ID.
EnvoyUniqueIDLabelName is the label applied to pods with the unique ID of the Envoy sidecar.
EnvoyWindowsUser is the Envoy's User name on Windows.
EnvVarHumanReadableLogMessages is an environment variable, which when set to "true" enables colorful human-readable log messages.
EnvVarLogKubernetesEvents is the name of the env var instructing the event handlers whether to log at all (true/false).
HealthcheckPath is the path to use for healthcheck probe.
HealthcheckPort is the port to use for healthcheck probe.
IgnoreLabel is the label used to ignore a resource.
InitContainerName is the name of the init container.
InjectorWebhookPort is the port on which the sidecar injection webhook listens.
KubernetesOpaqueSecretCAKey is the key which holds the CA bundle in a Kubernetes secret.
KubernetesOpaqueSecretRootPrivateKeyKey is the key which holds the CA's private key in a Kubernetes secret.
LivenessProbePath is the path to use for liveness probe.
LivenessProbePort is the port to use for liveness probe.
LocalhostIPAddress is the local host address.
LogFieldContext is the key used to specify the logging context.
MetricsAnnotation is the annotation used for enabling/disabling metrics.
MetricsPath is the path at which OSM controller serves metrics.
MRCStateActive is the active status option for the State of the MeshRootCertificate.
MRCStateError is the error status option for the State of the MeshRootCertificate.
MRCStateInactive is the inactive status option for the State of the MeshRootCertificate.
MRCStateIssuingRollback is the issuing rollback status option for the State of the MeshRootCertificate.
MRCStateIssuingRollout is the issuing rollout status option for the State of the MeshRootCertificate.
MRCStateValidatingRollback is the validating rollback status option for the State of the MeshRootCertificate.
MRCStateValidatingRollout is the validating rollout status option for the State of the MeshRootCertificate.
OSLinux is the name for Linux operating system.
App labels as defined in the "osm.labels" template in _helpers.tpl of the Helm chart.
App labels as defined in the "osm.labels" template in _helpers.tpl of the Helm chart.
App labels as defined in the "osm.labels" template in _helpers.tpl of the Helm chart.
App labels as defined in the "osm.labels" template in _helpers.tpl of the Helm chart.
OSMBootstrapName is the name of the OSM Bootstrap.
a decade.
OSMControllerLivenessPath is the path at which OSM controller serves liveness probes.
OSMControllerName is the name of the OSM Controller (formerly ADS service).
OSMControllerReadinessPath is the path at which OSM controller serves readiness probes.
OSMControllerSMIVersionPath is the path at which OSM controller servers SMI version info.
OSMHTTPServerPort is the port on which osm-controller and osm-injector serve HTTP requests for metrics, health probes etc.
OSMInjectorName is the name of the OSM Injector.
OSMKubeResourceMonitorAnnotation is the key of the annotation used to monitor a K8s resource.
OSMMeshConfig is the name of the OSM MeshConfig.
OSWindows is the name for Windows operating system.
PrometheusDefaultRetentionTime is the default days for which data is retained in prometheus.
PrometheusPathAnnotation is the annotation used to configure the path to scrape on.
PrometheusPortAnnotation is the annotation used to configure the port to scrape on.
PrometheusScrapeAnnotation is the annotation used to configure prometheus scraping.
PrometheusScrapePath is the path for prometheus to scrap envoy metrics from.
gRPC protocol.
HTTP protocol.
HTTPS protocol.
TCP protocol.
ProtocolTCPServerFirst implies TCP based server first protocols Ex.
ReadinessProbePath is the path to use for readiness probe.
ReadinessProbePort is the port to use for readiness probe.
ReconcileLabel is the label used to reconcile a resource.
RegexMatchAll is a regex pattern match for all.
ServiceAliveResponse is the response returned by the server to indicate it is alive.
ServiceReadyResponse is the response returned by the server to indicate it is ready.
SidecarInjectionAnnotation is the annotation used for sidecar injection.
StartupProbePath is the path to use for startup probe.
StartupProbePort is the port to use for startup probe.
ValidatorWebhookPort is the port on which the resource validator webhook listens.
VersionPath is the path at which OSM controller serves version info.
WebhookHealthPath is the path at which the webooks serve health probes.
WildcardHTTPMethod is a wildcard for all HTTP methods.
WildcardIPAddr is a string constant.

# Variables

SupportedProtocolsInMesh is a list of the protocols OSM supports for in-mesh traffic.