Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nightkr committed Oct 9, 2024
1 parent a1ae9a0 commit af27ec1
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/modules/listener-operator/pages/listenerclass.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ How exactly this is accomplished depends on the cloud provider in question, but
include::example$listenerclass-internal-gke.yaml[]
----

[#servicetype]
== Service types

The service type is defined by `ListenerClass.spec.serviceType`.
Expand Down Expand Up @@ -62,6 +63,24 @@ Compared to xref:#servicetype-nodeport[], this service type allows Pods to be mo
However, it requires https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer[a cloud controller manager that supports load balancers].
Additionally, many cloud providers charge for load-balanced traffic.

[#addresstype]
== Address types

The Stackable Listener Operator supports both IP addresses and DNS hostnames. The preferred address type for a given ListenerClass can be configured using the `ListenerClass.spec.preferredAddressType` field. If no `preferredAddressType` is specified then it defaults to xref:#addresstype-hostname[].

NOTE: If the preferred address type is not supported for a given environment then another type will be used.

[#addresstype-ip]
=== IP

The IP address of a resource. The addresses will be less predictable (especially for xref:#servicetype-clusterip[] services),
but does not require any special client configuration (beyond what the xref:#servicetype[] requires).

[#addresstype-hostname]
=== Hostname

The DNS hostname of a resource. Clients must be able to resolve these addresses in order to connect, which may require special DNS configuration.

== Default ListenerClasses

The Stackable Data Platform assumes the existence of a few predefined ListenerClasses, and will use them by default as appropriate:
Expand Down

0 comments on commit af27ec1

Please sign in to comment.