Config v1alpha3 API Reference

IssuerName specifies the name of the Issuer resource

IssuerKind specifies the kind of Issuer

IssuerGroup specifies the group the Issuer belongs to

ServiceCertValidityDuration defines the service certificate validity duration.

CertKeyBitSize defines the certicate key bit size.

IngressGateway defines the certificate specification for an ingress gateway.

Name defines the name of cluster property.

Value defines the name of cluster property.

IsManaged defines if the cluster is managed.

UID defines Unique ID of cluster.

Region defines Region of cluster.

Zone defines Zone of cluster.

Group defines Group of cluster.

Name defines Name of cluster.

ControlPlaneUID defines the unique ID of the control plane cluster, in case it’s managed

Properties defines properties for cluster.

Enabled defines if flb is enabled.

LogLevel defines the log level of gateway api.

Mode defines the mode of egress gateway.

Port defines the port of egress gateway.

AdminPort defines the admin port of egress gateway.

Replicas defines the replicas of egress gateway.

Enable defines a boolean indicating if the external authorization policy is to be enabled.

Address defines the remote address of the external authorization endpoint.

Port defines the destination port of the remote external authorization endpoint.

StatPrefix defines a prefix for the stats sink for this external authorization policy.

Timeout defines the timeout in which a response from the external authorization endpoint. is expected to execute.

FailureModeAllow defines a boolean indicating if traffic should be allowed on a failure to get a response against the external authorization endpoint.

Enabled defines if flb is enabled.

StrictMode defines if flb is in strict mode.

UpstreamMode defines the upstream mode of flb.

SecretName defines the secret name of flb.

"Endpoint"

"NodePort"

EnableEgressPolicy defines if FSM’s Egress policy is enabled.

EnableSnapshotCacheMode defines if XDS server starts with snapshot cache.

EnableAsyncProxyServiceMapping defines if FSM will map proxies to services asynchronously.

EnableIngressBackendPolicy defines if FSM will use the IngressBackend API to allow ingress traffic to service mesh backends.

EnableAccessControlPolicy defines if FSM will use the AccessControl API to allow access control traffic to service mesh backends.

EnableAccessCertPolicy defines if FSM can issue certificates for external services..

EnableSidecarActiveHealthChecks defines if FSM will Sidecar active health checks between services allowed to communicate.

EnableRetryPolicy defines if retry policy is enabled.

EnablePluginPolicy defines if plugin policy is enabled.

EnableAutoDefaultRoute defines if auto default route is enabled.

EnableValidateGatewayListenerHostname defines if validate gateway listener hostname is enabled.

EnableValidateHTTPRouteHostnames defines if validate http route hostnames is enabled.

EnableValidateGRPCRouteHostnames defines if validate grpc route hostnames is enabled.

EnableValidateTCPRouteHostnames defines if validate tcp route hostnames is enabled.

EnableGatewayAgentService defines if agent service is enabled.

EnableGatewayProxyTag defines if gateway proxy-tag header is enabled.

Enabled defines if gateway api is enabled.

LogLevel defines the log level of gateway api.

FGWLogLevel defines the log level of FGW.

StripAnyHostPort defines if strip any host port is enabled.

SSLPassthroughUpstreamPort defines the default upstream port of SSL passthrough.

HTTP1PerRequestLoadBalancing defines if load balancing based on per-request is enabled for http1.

HTTP2PerRequestLoadBalancing defines if load balancing based on per-request is enabled for http2.

ProxyTag defines the proxy tag configuration of gateway api.

Enabled defines if http is enabled.

Bind defines the bind port of http.

Listen defines the listen port of http.

NodePort defines the node port of http.

Registry defines the registry of docker image.

Tag defines the tag of docker image.

PullPolicy defines the pull policy of docker image.

SubjectAltNames defines the Subject Alternative Names (domain names and IP addresses) secured by the certificate.

ValidityDuration defines the validity duration of the certificate.

Secret defines the secret in which the certificate is stored.

Enabled defines if ingress is enabled.

Namespaced defines if ingress is namespaced.

Type defines the type of ingress service.

LogLevel defines the log level of ingress.

HTTP defines the http configuration of ingress.

TLS defines the tls configuration of ingress.

Enable defines a boolean indicating if the sidecars are enabled for local DNS Proxy.

PrimaryUpstreamDNSServerIPAddr defines a primary upstream DNS server for local DNS Proxy.

SecondaryUpstreamDNSServerIPAddr defines a secondary upstream DNS server for local DNS Proxy.

Wildcard defines Wildcard DN.

DB defines Resolve DB.

"Localhost"

LocalProxyModeLocalhost indicates the the sidecar should communicate with the main application over localhost

"PodIP"

LocalProxyModePodIP indicates that the sidecar should communicate with the main application via the pod ip

Object’s metadata.

Spec is the MeshConfig specification.

ClusterSetSpec defines the configurations of cluster.

Sidecar defines the configurations of the proxy sidecar in a mesh.

RepoServer defines the configurations of pipy repo server.

Traffic defines the traffic management configurations for a mesh instance.

Observalility defines the observability configurations for a mesh instance.

Certificate defines the certificate management configurations for a mesh instance.

FeatureFlags defines the feature flags for a mesh instance.

PluginChains defines the default plugin chains.

Ingress defines the configurations of Ingress features.

GatewayAPI defines the configurations of GatewayAPI features.

ServiceLB defines the configurations of ServiceLBServiceLB features.

FLB defines the configurations of FLB features.

EgressGateway defines the configurations of EgressGateway features.

Image defines the configurations of Image info

Misc defines the configurations of misc info

Object’s metadata

Spec is the MeshRootCertificate config specification

Status of the MeshRootCertificate resource

Provider specifies the mesh certificate provider

TrustDomain is the trust domain to use as a suffix in Common Names for new certificates.

State specifies the state of the certificate provider All states are specified in constants.go

CurlImage defines the image of curl.

RepoServerImage defines the image of repo server.

FSMLogLevel defines the log level for FSM control plane logs.

EnableDebugServer defines if the debug endpoint on the FSM controller pod is enabled.

Tracing defines FSM’s tracing configuration.

RemoteLogging defines FSM’s remote logging configuration.

Plugin defines the name of plugin

Priority defines the priority of plugin

Disable defines the visibility of plugin

InboundTCPChains defines inbound tcp chains

InboundHTTPChains defines inbound http chains

OutboundTCPChains defines outbound tcp chains

OutboundHTTPChains defines outbound http chains

CertManager specifies the cert-manager provider configuration

Vault specifies the vault provider configuration

Tresor specifies the Tresor provider configuration

SrcHostHeader defines the src host header.

DstHostHeader defines the dst host header.

Enable defines a boolean indicating if the sidecars are enabled for remote logging.

Level defines the remote logging’s level.

Port defines the remote logging’s port.

Address defines the remote logging’s hostname.

Endpoint defines the API endpoint for remote logging requests sent to the collector.

Authorization defines the access entity that allows to authorize someone in remote logging service.

SampledFraction defines the sampled fraction.

SecretName defines the name of the secret that contains the configuration for remote logging.

IPAddr of the pipy repo server

Port defines the pipy repo server’s port.

Codebase is the folder used by fsmController

DN defines resolve DN.

IPv4 defines a ipv4 address for resolve DN.

Enabled defines if ssl passthrough is enabled.

UpstreamPort defines the upstream port of ssl passthrough.

Name specifies the name of the secret in which the Vault token is stored

Key specifies the key whose value is the Vault token

Namespace specifies the namespace of the secret in which the Vault token is stored

Enabled defines if service lb is enabled.

Image defines the service lb image.

EnablePrivilegedInitContainer defines a boolean indicating whether the init container for a meshed pod should run as privileged.

LogLevel defines the logging level for the sidecar’s logs. Non developers should generally never set this value. In production environments the LogLevel should be set to error.

SidecarImage defines the container image used for the proxy sidecar.

SidecarDisabledMTLS defines whether mTLS is disabled.

MaxDataPlaneConnections defines the maximum allowed data plane connections from a proxy sidecar to the FSM controller.

ConfigResyncInterval defines the resync interval for regular proxy broadcast updates.

SidecarTimeout defines the connect/idle/read/write timeout.

Resources defines the compute resources for the sidecar.

TLSMinProtocolVersion defines the minimum TLS protocol version that the sidecar supports. Valid TLS protocol versions are TLS_AUTO, TLSv1_0, TLSv1_1, TLSv1_2 and TLSv1_3.

TLSMaxProtocolVersion defines the maximum TLS protocol version that the sidecar supports. Valid TLS protocol versions are TLS_AUTO, TLSv1_0, TLSv1_1, TLSv1_2 and TLSv1_3.

CipherSuites defines a list of ciphers that listener supports when negotiating TLS 1.0-1.2. This setting has no effect when negotiating TLS 1.3. For valid cipher names, see the latest OpenSSL ciphers manual page. E.g. https://www.openssl.org/docs/man1.1.1/apps/ciphers.html.

ECDHCurves defines a list of ECDH curves that TLS connection supports. If not specified, the curves are [X25519, P-256] for non-FIPS build and P-256 for builds using BoringSSL FIPS.

LocalProxyMode defines the network interface the proxy will use to send traffic to the backend service application. Acceptable values are [Localhost, PodIP]. The default is Localhost

LocalDNSProxy improves the performance of your computer by caching the responses coming from your DNS servers

Enabled defines if tls is enabled.

Bind defines the bind port of tls.

Listen defines the listen port of tls.

NodePort defines the node port of tls.

MTLS defines if mTLS is enabled.

SSLPassthrough defines the ssl passthrough configuration of tls.

Enable defines a boolean indicating if the sidecars are enabled for tracing.

Port defines the tracing collector’s port.

Address defines the tracing collectio’s hostname.

Endpoint defines the API endpoint for tracing requests sent to the collector.

SampledFraction defines the sampled fraction.

InterceptionMode defines a string indicating which traffic interception mode is used.

EnableEgress defines a boolean indicating if mesh-wide Egress is enabled.

OutboundIPRangeExclusionList defines a global list of IP address ranges to exclude from outbound traffic interception by the sidecar proxy.

OutboundIPRangeInclusionList defines a global list of IP address ranges to include for outbound traffic interception by the sidecar proxy. IP addresses outside this range will be excluded from outbound traffic interception by the sidecar proxy.

OutboundPortExclusionList defines a global list of ports to exclude from outbound traffic interception by the sidecar proxy.

InboundPortExclusionList defines a global list of ports to exclude from inbound traffic interception by the sidecar proxy.

EnablePermissiveTrafficPolicyMode defines a boolean indicating if permissive traffic policy mode is enabled mesh-wide.

ServiceAccessMode defines a string indicating service access mode.

InboundExternalAuthorization defines a ruleset that, if enabled, will configure a remote external authorization endpoint for all inbound and ingress traffic in the mesh.

NetworkInterfaceExclusionList defines a global list of network interface names to exclude from inbound and outbound traffic interception by the sidecar proxy.

HTTP1PerRequestLoadBalancing defines a boolean indicating if load balancing based on request is enabled for http1.

HTTP1PerRequestLoadBalancing defines a boolean indicating if load balancing based on request is enabled for http2.

SecretRef specifies the secret in which the root certificate is stored

CA specifies Tresor’s ca configuration

Host specifies the name of the Vault server

Port specifies the port of the Vault server

Role specifies the name of the role for use by mesh control plane

Protocol specifies the protocol for connections to Vault

Token specifies the configuration of the token to be used by mesh control plane to connect to Vault

SecretKeyRef specifies the secret in which the Vault token is stored

Enable defines a boolean indicating if wildcard are enabled for local DNS Proxy.

IPv4 defines a ipv4 address for wildcard DN.