GatewayConfig
stunner.l7mp.io / v1alpha1
apiVersion: stunner.l7mp.io/v1alpha1
kind: GatewayConfig
metadata:
name: example
apiVersion
string
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind
string
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata
object
spec object
GatewayConfigSpec defines the desired state of GatewayConfig
authLifetime
integer
AuthLifetime defines the lifetime of "longterm" authentication credentials in seconds.
format:
int32authRef object
Note that externally set credentials override any inline auth credentials (AuthType,
AuthUsername, etc.): if AuthRef is nonempty then it is expected that the referenced
Secret exists and *all* authentication credentials are correctly set in the referenced
Secret (username/password or shared secret). Mixing of credential sources
(inline/external) is not supported.
group
string
Group is the group of the referent. For example, "gateway.networking.k8s.io".
When unspecified or empty string, core API group is inferred.
pattern:
^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$maxLength:
253
kind
string
Kind is kind of the referent. For example "Secret".
pattern:
^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$minLength:
1maxLength:
63
name
string required
Name is the name of the referent.
minLength:
1maxLength:
253
namespace
string
Namespace is the namespace of the referenced object. When unspecified, the local
namespace is inferred.
Note that when a namespace different than the local namespace is specified,
a ReferenceGrant object is required in the referent namespace to allow that
namespace's owner to accept the reference. See the ReferenceGrant
documentation for details.
Support: Core
pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?$minLength:
1maxLength:
63
authType
string
AuthType is the type of the STUN/TURN authentication mechanism.
pattern:
^plaintext|static|longterm|ephemeral|timewindowed$
dataplane
string
Dataplane defines the TURN server to set up for the STUNner Gateways using this
GatewayConfig. Can be used to select the stunnerd image repo and version or deploy into
the host-network namespace.
healthCheckEndpoint
string
HealthCheckEndpoint is the URI of the form `http://address:port` exposed for external
HTTP health-checking. A liveness probe responder will be exposed on path `/live` and
readiness probe on path `/ready`. The scheme (`http://`) is mandatory, default is to
enable health-checking at "http://0.0.0.0:8086".
loadBalancerServiceAnnotations
object
LoadBalancerServiceAnnotations is a list of annotations that will go into the
LoadBalancer services created automatically by the operator to wrap Gateways.
NOTE: removing annotations from a GatewayConfig will not result in the removal of the
corresponding annotations from the LoadBalancer service, in order to prevent the
accidental removal of an annotation installed there by Kubernetes or the cloud
provider. If you really want to remove an annotation, do this manually or simply remove
all Gateways (which will remove the corresponding LoadBalancer services), update the
GatewayConfig and then recreate the Gateways, so that the newly created LoadBalancer
services will contain the required annotations.
logLevel
string
LogLevel specifies the default loglevel for the STUNner daemon.
maxPort
integer
MaxRelayPort is the smallest relay port assigned for STUNner relay connections.
format:
int32
metricsEndpoint
string
MetricsEndpoint is the URI in the form `http://address:port/path` exposed for metric
scraping (Prometheus). The scheme (`http://`) is mandatory. Default is to expose no
metric endpoint.
minPort
integer
MinRelayPort is the smallest relay port assigned for STUNner relay connections.
format:
int32
password
string
Password defines the `password` credential for "plaintext" authentication.
pattern:
^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
realm
string
Realm defines the STUN/TURN authentication realm to be used for clients toauthenticate
with STUNner.
The realm must consist of lower case alphanumeric characters or '-', and must start and
end with an alphanumeric character. No other punctuation is allowed.
pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
sharedSecret
string
SharedSecret defines the shared secret to be used for "longterm" authentication.
stunnerConfig
string
StunnerConfig specifies the name of the ConfigMap into which the operator renders the
stunnerd configfile.
pattern:
^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$maxLength:
64
userName
string
Username defines the `username` credential for "plaintext" authentication.
pattern:
^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$No matches. Try .spec.authLifetime for an exact path