OpenShift Java REST Client

The project is now in the maintenance mode. Only critical bugs will be fixed, and there won’t be any more feature development. Please consider moving to the OpenShift client library that's developed by the great team at fabric8.

This is the Java REST client for the version 3 architecture of OpenShift based on Kubernetes. The implementation is a work in progress to provide similar functionality and features of the command-line interface and is used by JBoss Tools for OpenShift. For compatibility with OpenShift 2.x see https://github.com/openshift/openshift-java-client/.

For questions or feedback, reach us on IRC on #openshift-client on Freenode or post to our mailing list

Download

You may either build from source using maven (mvn clean package) which, using the master branch, will generate a snapshot build of the latest updates. You may also retrieve final released jars from Maven Central.

Compatibility

Versions of this client known to be compatible with OpenShift

Client Version	OpenShift Origin Server
5.4.0-SNAPSHOT	v1.3.0
5.0.0-SNAPSHOT	latest, v1.3.0-alpha.2
	v1.3.0-alpha.3

Usage

Creating a client:

IClient client = new ClientBuilder("https://api.preview.openshift.com")
	.withUserName("openshiftdev")
	.withPassword("wouldntUlik3T0kn0w")
	.build();

This will authorize the client if the cluster is configured for basic authorization. The alternative is to retrieve your OAUTH token and provide it to the client. The token can be set with the builder or later by accessing the authorization context:

client.getAuthorizationContext().setToken("asfdsfd8a70a3qrfafdsadsf786324");

Create a project to associate with your application by submitting a project request:

IResource request = client.getResourceFactory().stub(ResourceKind.PROJECT_REQUEST, "myfirstproject");
IProject project =  (IProject)client.create(request);

Resources can be created by stubbing which will instantiate and instance of the resource but not create it on the server:

IService service = client.getResourceFactory().stub(ResourceKind.SERVICE, "myfirstservice", project.getName());
service.setSelector(labelSelectors);
service = client.create(service);

The client as well as resources supported by OpenShift may have certain capabilities that are instantiated when the resource is initialized. The capabilities are implemented using an adapter pattern and used like the following to create a BuildConfig:

IBuildConfig buildConfig = client.accept(new CapabilityVisitor<IBuildConfigBuilder, IBuildConfig>() {

		@Override
		public IBuildConfig visit(IBuildConfigBuilder builder) {
			return builder
					.named("mybuildconfig")
					.inNamespace(project.getName())
					.fromGitSource()
						.fromGitUrl("https://github.com/openshift/rails-example")
						.usingGitReference("master")
					.end()
					.usingSourceStrategy()
						.fromImageStreamTag("ruby:latest")
						.inNamespace("openshift")
						.withEnvVars(envVars)
					.end()
					.buildOnSourceChange(true)
					.buildOnConfigChange(true)
					.buildOnImageChange(true)
					.toImageStreamTag("mybuildconfig:latest")
				.build();
		}
	}, null);

Various examples of using the capabilities may be found in the integration tests.

Testing

To run the integration tests:

1. Define a user with cluster admin privilege
2. Download the oc binary
3. Run the tests: mvn integration-test -Pintegration-tests -DserverURL=https://localhost:8443 -Ddefault.cluster.admin=foo -Ddefault.cluster.password=bar -Ddefault.openshift.location=/tmp/oc