Openshift Builds

Since Camel 2.17

Only producer is supported

The Openshift Builds component is one of Kubernetes Components which provides a producer to execute Openshift builds operations.

Configuring Options

Camel components are configured on two separate levels:

  • component level

  • endpoint level

Configuring Component Options

The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.

Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.

Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.

Configuring Endpoint Options

Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.

Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL and DataFormat DSL as a type safe way of configuring endpoints and data formats in Java.

A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.

The following two sections lists all the options, firstly for the component followed by the endpoint.

Component Options

The Openshift Builds component supports 3 options, which are listed below.

Name Description Default Type

kubernetesClient (producer)

Autowired To use an existing kubernetes client.

KubernetesClient

lazyStartProducer (producer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

autowiredEnabled (advanced)

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

boolean

Endpoint Options

The Openshift Builds endpoint is configured using URI syntax:

openshift-builds:masterUrl

with the following path and query parameters:

Path Parameters (1 parameters)

Name Description Default Type

masterUrl (producer)

Required URL to a remote Kubernetes API server. This should only be used when your Camel application is connecting from outside Kubernetes. If you run your Camel application inside Kubernetes, then you can use local or client as the URL to tell Camel to run in local mode. If you connect remotely to Kubernetes, then you may also need some of the many other configuration options for secured connection with certificates, etc.

String

Query Parameters (21 parameters)

Name Description Default Type

apiVersion (producer)

The Kubernetes API Version to use.

String

dnsDomain (producer)

The dns domain, used for ServiceCall EIP.

String

kubernetesClient (producer)

Default KubernetesClient to use if provided.

KubernetesClient

namespace (producer)

The namespace.

String

operation (producer)

Producer operation to do on Kubernetes.

String

portName (producer)

The port name, used for ServiceCall EIP.

String

portProtocol (producer)

The port protocol, used for ServiceCall EIP.

tcp

String

lazyStartProducer (producer (advanced))

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

connectionTimeout (advanced)

Connection timeout in milliseconds to use when making requests to the Kubernetes API server.

Integer

caCertData (security)

The CA Cert Data.

String

caCertFile (security)

The CA Cert File.

String

clientCertData (security)

The Client Cert Data.

String

clientCertFile (security)

The Client Cert File.

String

clientKeyAlgo (security)

The Key Algorithm used by the client.

String

clientKeyData (security)

The Client Key data.

String

clientKeyFile (security)

The Client Key file.

String

clientKeyPassphrase (security)

The Client Key Passphrase.

String

oauthToken (security)

The Auth Token.

String

password (security)

Password to connect to Kubernetes.

String

trustCerts (security)

Define if the certs we used are trusted anyway or not.

Boolean

username (security)

Username to connect to Kubernetes.

String

Message Headers

The Openshift Builds component supports 4 message header(s), which is/are listed below:

Name Description Default Type

CamelKubernetesOperation (producer)

Constant: KUBERNETES_OPERATION

The Producer operation.

String

CamelKubernetesNamespaceName (producer)

Constant: KUBERNETES_NAMESPACE_NAME

The namespace name.

String

CamelKubernetesBuildsLabels (producer)

Constant: KUBERNETES_BUILDS_LABELS

The Openshift build labels.

Map

CamelKubernetesBuildName (producer)

Constant: KUBERNETES_BUILD_NAME

The Openshift build name.

String

Supported producer operation

  • listBuilds

  • listBuildsByLabels

  • getBuild

Openshift Builds Producer Examples

  • listBuilds: this operation list the Builds on an Openshift cluster

from("direct:list").
    toF("openshift-builds:///?kubernetesClient=#kubernetesClient&operation=listBuilds").
    to("mock:result");

This operation return a List of Builds from your Openshift cluster

  • listBuildsByLabels: this operation list the builds by labels on an Openshift cluster

from("direct:listByLabels").process(new Processor() {
            @Override
            public void process(Exchange exchange) throws Exception {
                Map<String, String> labels = new HashMap<>();
                labels.put("key1", "value1");
                labels.put("key2", "value2");
                exchange.getIn().setHeader(KubernetesConstants.KUBERNETES_BUILDS_LABELS, labels);
            }
        });
    toF("openshift-builds:///?kubernetesClient=#kubernetesClient&operation=listBuildsByLabels").
    to("mock:result");

This operation return a List of Builds from your cluster, using a label selector (with key1 and key2, with value value1 and value2)