MultiCluster v1alpha1 API Reference

cluster is the name of the exporting cluster. Must be a valid RFC-1123 DNS label.

in-cluster service, it’s the cluster IPs otherwise, it’s the url of accessing that service in remote cluster for example, http(s)://[Ingress IP/domain name]:[port]/[path]

Type of global load distribution

"ActiveActive"

ActiveActiveLbType defines AA load balance type

"FailOver"

FailOverLbType defines FO load balance type

"Locality"

LocalityLbType defines OL load balance type

"Conflict"

ServiceExportConflict means that there is a conflict between two exports for the same Service. When “True”, the condition message should contain enough information to diagnose the conflict: field(s) under contention, which cluster won, and why. Users should not expect detailed per-cluster information in the conflict message.

"Valid"

ServiceExportValid means that the service referenced by this service export has been recognized as valid by controller. This will be false if the service is found to be unexportable (ExternalName, not found).

The port number of service

Path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional “path” part of a URL as defined by RFC 3986. Paths must begin with a ‘/’ and must be present when using PathType with value “Exact” or “Prefix”.

PathType determines the interpretation of the Path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by ‘/’. Matching is done on a path element by element basis. A path element refers is the list of labels in the path split by the ‘/’ separator. A request is a match for path p if every p is an element-wise prefix of p of the request path. Note that if the last element of the path is a substring of the last element in request path, it is not a match (e.g. /foo/bar matches /foo/bar/baz, but does not match /foo/barbaz).

PathRewrite, it shares ONE rewrite rule for the same ServiceExport

Indicates if session sticky is enabled

The LoadBalancer Type applied to the Ingress Rules those created by the ServiceExport

The paths for accessing the service via Ingress controller

If empty, service is exported to all managed clusters. If not empty, service is exported to specified clusters, must be in format [region]/[zone]/[group]/[cluster]

The ServiceAccount associated with this service

ip will be used as the VIP for this service when type is ClusterSetIP.

type defines the type of this service. Must be ClusterSetIP or Headless.

Supports “ClientIP” and “None”. Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. Ignored when type is Headless More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies

sessionAffinityConfig contains session affinity configuration.

The ServiceAccount associated with this service

clusters is the list of exporting clusters from which this service was derived.

"ClusterSetIP"

ClusterSetIP are only accessible via the ClusterSet IP.

"Headless"

Headless services allow backend pods to be addressed directly.

The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the ‘name’ field in the EndpointPort. Optional if only one ServicePort is defined on this service.

The IP protocol for this port. Supports “TCP”, “UDP”, and “SCTP”. Default is TCP.

The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. Field can be enabled with ServiceAppProtocol feature gate.

The port that will be exposed by this service.

The address of accessing the service

Format: [region]/[zone]/[group]/[cluster]