org.eclipse.jkube.kit.enricher.api

Interface ServiceExposer

All Superinterfaces:

Enricher, org.eclipse.jkube.kit.common.Named

public interface ServiceExposer
extends Enricher

Implementing Enrichers should generate Kubernetes Resources/Objects that Expose a Kubernetes Service.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ServiceExposer.Util

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXPOSE_LABEL This label was originally consumed by the the deprecated Expose controller.

Fields inherited from interface org.eclipse.jkube.kit.enricher.api.Enricher

INTERNAL_ANNOTATION_PREFIX

Method Summary

Modifier and Type	Method and Description
default boolean	canExposeService(io.fabric8.kubernetes.api.model.ServiceBuilder serviceBuilder) Services with the following properties will be automatically exposed: Exposure of a single port Are not labeled expose: false Not part of the Kubernetes System (?? legacy from IngressEnricher)
default Set<Integer>	getPorts(io.fabric8.kubernetes.api.model.ServiceBuilder serviceBuilder) Returns a Set of ports exposed by the Service.
default boolean	hasWebPorts(io.fabric8.kubernetes.api.model.ServiceBuilder serviceBuilder) Returns true if the Service exposes a 'web' port.
default boolean	isExposedWithLabel(io.fabric8.kubernetes.api.model.ServiceBuilder serviceBuilder) Returns true if the Service has a metadata.label with the key 'expose' and the value 'true'.

Methods inherited from interface org.eclipse.jkube.kit.enricher.api.Enricher

create, enrich, getContext

Methods inherited from interface org.eclipse.jkube.kit.common.Named

getName

Field Detail

EXPOSE_LABEL

static final String EXPOSE_LABEL

This label was originally consumed by the the deprecated Expose controller.

It is now used to prevent a Service from being exposed.

See Also:

Constant Field Values

Method Detail

getPorts

default Set<Integer> getPorts(io.fabric8.kubernetes.api.model.ServiceBuilder serviceBuilder)

Returns a Set of ports exposed by the Service.

Parameters:

serviceBuilder - the Service to get the ports from.

Returns:

the Set of ports exposed by the Service.

hasWebPorts

default boolean hasWebPorts(io.fabric8.kubernetes.api.model.ServiceBuilder serviceBuilder)

Returns true if the Service exposes a 'web' port.

Parameters:

serviceBuilder - the ServiceBuilder to check the ports from.

Returns:

true if the Service exposes a 'web' port, false otherwise.

canExposeService

default boolean canExposeService(io.fabric8.kubernetes.api.model.ServiceBuilder serviceBuilder)

Services with the following properties will be automatically exposed:

• Exposure of a single port
• Are not labeled expose: false
• Not part of the Kubernetes System (?? legacy from IngressEnricher)

Parameters:

serviceBuilder - the ServiceBuilder to check the ports from.

Returns:

true if the Service exposes a single port, false otherwise.

isExposedWithLabel

default boolean isExposedWithLabel(io.fabric8.kubernetes.api.model.ServiceBuilder serviceBuilder)

Returns true if the Service has a metadata.label with the key 'expose' and the value 'true'.

n.b. This label should be provided by a fragment or the jkube.enricher.jkube-service.expose configuration. Using the MetadataEnricher will add the label after the Service has been processed by the ServiceExposer(s).

Parameters:

serviceBuilder - the Service to check the label from.

Returns:

true if the Service has an expose label, false otherwise.