Skip to content

Latest commit

 

History

History
42 lines (27 loc) · 3 KB

V220DevfileParentComponentsItemsContainerEndpoints.md

File metadata and controls

42 lines (27 loc) · 3 KB
Raw

V220DevfileParentComponentsItemsContainerEndpoints

Properties

Name Type Description Notes
annotation Map<String, String> Annotations to be added to Kubernetes Ingress or Openshift Route [optional]
attributes Object Map of implementation-dependant string-based free-form attributes. Examples of Che-specific attributes: - cookiesAuthEnabled: &quot;true&quot; / &quot;false&quot;, - type: &quot;terminal&quot; / &quot;ide&quot; / &quot;ide-dev&quot;, [optional]
exposure ExposureEnum Describes how the endpoint should be exposed on the network. - `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route. - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. - `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address. Default value is `public` [optional]
name String
path String Path of the endpoint URL [optional]
protocol ProtocolEnum Describes the application and transport protocols of the traffic that will go through this endpoint. - `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`. - `https`: Endpoint will have `https` traffic, typically on a TCP connection. - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. Default value is `http` [optional]
secure Boolean Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`. [optional]
targetPort Integer Port number to be used within the container component. The same port cannot be used by two different container components. [optional]

Enum: ExposureEnum

Name Value
PUBLIC "public"
INTERNAL "internal"
NONE "none"

Enum: ProtocolEnum

Name Value
HTTP "http"
HTTPS "https"
WS "ws"
WSS "wss"
TCP "tcp"
UDP "udp"