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

# Functions

NewDataHandle Returns an initialized scale data.
OSMDescribe givens the description of an e2e test.
RandomNameWithPrefix generates a random string with the given prefix.
WithLocalProxyMode sets the LocalProxyMode for OSM.

# Constants

CollectLogs is used to force log collection.
CollectLogsIfErrorOnly will collect logs only when test errors out.
ControlPlaneOnly will collect logs only for control plane processes.
CPUPanel is the ID of the CPU panel on OSM's MeshDetails dashboard.
DefaultOsmGrafanaPort is the default Grafana port.
DefaultOsmPrometheusPort default OSM prometheus port.
DefaultUpstreamServicePort is the default port on which the server apps listen for connections from client apps.
EnvoyOSMWindowsImage is Envoy Windows image used for testing.
HttpbinOSMWindowsImage is the Windows based httpbin image used for testing.
KindCluster Creates Kind cluster on docker and uses it as cluster, OSM installs through CLI.
MemRSSPanel is the ID of the MemRSS panel on OSM's MeshDetails dashboard.
MeshDetails is dashboard uuid and name as we have them load in Grafana.
NoCollectLogs will not collect logs.
NoInstall uses current kube cluster, assumes an OSM is present in `OsmNamespace`.
OSCrossPlatform indicates that a test can run on all operating systems.
OsmGrafanaAppLabel is the OSM Grafana deployment app label.
OsmPrometheusAppLabel is the OSM Prometheus deployment app label.
RegistrySecretName is the default name for the container registry secret.
SelfInstall uses current kube cluster, installs OSM using CLI.
StatusCodeWord is an identifier used on curl commands to print and parse REST Status codes.
Suite is to mark after-suite cleanup.
Test is to mark after-test cleanup.
WindowsNanoserverDockerImage is the base Windows image that is compatible with the test cluster.

# Variables

HttpbinCmd is the command to be used for httpbin applications in e2es.
NginxIngressSvc is the namespaced name of the nginx ingress service.
OsmCtlLabels is the list of app labels for OSM CTL.
PodCommandDefault is the default pod command (nothing).
Td the global context for test.

# Structs

DataHandle is the handle to specific resource information during a test.
DockerConfigEntry is a struct for docker-specific container registry secret structures.
DockerConfigJSON is a struct for docker-specific config.
FortioGRPCLoadTestDef defines a Fortio GRPC load test intent.
FortioHTTPLoadTestDef defines a Fortio HTTP load test intent.
FortioLoadResult represents Fortio load test result.
FortioLoadTestSpec defines the Fortio load test specification.
FortioReturnCodeEntry is a data entry for a single Fortio load test return code with related stats.
FortioTCPLoadTestDef defines a Fortio TCP load test intent.
Grafana is a simple handler to represent a target Grafana endpoint to run queries against.
GrafanaPanel identifies a target Panel to be saved at the end of the test.
GRPCRequestDef defines a remote GRPC request intent.
GRPCRequestResult represents the result of a GRPCRequest call.
HTTPMultipleRequest takes multiple HTTP request defs to issue them concurrently.
HTTPRequestDef defines a remote HTTP request intent.
HTTPRequestResult represents results of an HTTPRequest call.
InstallOSMOpts describes install options for OSM.
OSMDescribeInfo is a struct to represent the Tier and Bucket of a given e2e test.
OsmTestData stores common state, variables and flags for the test at hand.
Prometheus is a simple handler to represent a target Prometheus endpoint to run queries against.
Resource is used to store seen tracked resources during the test.
SimpleAllowPolicy is a simplified struct to later get basic SMI allow policy.
SimpleDeploymentAppDef defines some parametrization to create a deployment-based application from template.
SimplePodAppDef defines some parametrization to create a pod-based application from template.
TCPRequestDef defines a remote TCP request intent.
TCPRequestResult represents the result of a TCPRequest call.
TrackedLabel defines resources to track and monitor during the test.
TrafficSplitBackend is a simple define to refer to a TrafficSplit backend.
TrafficSplitDef is a simplified struct to get a TrafficSplit typed definition.

# Type aliases

CleanupType identifies what triggered the cleanup.
CollectLogsType defines if/when to collect logs.
DockerConfig and other configs are docker-specific container registry secret structures.
HTTPMultipleResults represents results from a multiple HTTP request call results come back as a map["srcNs/srcPod"]["dstNs/dstPod"] -> HTTPResults.
InstallOsmOpt is a function type for setting install options.
InstallType defines several OSM test deployment scenarios.
PodCommand describes a command for a pod.
RetryOnErrorFunc is a function type passed to RetryFuncOnError() to execute.
SuccessFunction is a simple definition for a success function.