Skip to content

Latest commit

 

History

History
164 lines (120 loc) · 5.4 KB

README.md

File metadata and controls

164 lines (120 loc) · 5.4 KB
Raw

KubeDB Java Client

Build Status Client Capabilities Maven Central

Official Java client for the KubeDB by AppsCode - Production-grade databases on Kubernetes.

Installation

To install the Java client library to your local Maven repository, simply execute:

git clone --recursive https://github.com/kubedb-client/java
cd java
mvn install

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>com.kubedb</groupId>
    <artifactId>client-java</artifactId>
    <version>1.0</version>
    <scope>compile</scope>
</dependency>

Gradle users

compile 'com.kubedb:client-java:1.0'

Others

At first generate the JAR by executing:

git clone --recursive https://github.com/kubedb-client/java
cd java
mvn package

Then manually install the following JARs:

  • target/client-java-1.0-SNAPSHOT.jar
  • target/lib/*.jar

Example

list all pods:

import com.kubedb.client.ApiClient;
import com.kubedb.client.ApiException;
import com.kubedb.client.Configuration;
import com.kubedb.client.apis.KubedbComV1alpha1Api;
import com.kubedb.client.models.V1alpha1Redis;
import com.kubedb.client.models.V1alpha1RedisList;
import com.kubedb.client.util.Config;
import java.io.IOException;

public class Example {
  public static void main(String[] args) throws IOException, ApiException {
    ApiClient client = Config.defaultClient();
    Configuration.setDefaultApiClient(client);

    KubedbComV1alpha1Api api = new KubedbComV1alpha1Api();
    V1alpha1RedisList list =
        api.listRedisForAllNamespaces(null, null, null, null, null, null, null, null, null);
    for (V1alpha1Redis item : list.getItems()) {
      System.out.println(item.getMetadata().getName());
    }
  }
}

watch on redis object:

import com.google.gson.reflect.TypeToken;
import com.kubedb.client.ApiClient;
import com.kubedb.client.ApiException;
import com.kubedb.client.Configuration;
import com.kubedb.client.apis.KubedbComV1alpha1Api;
import com.kubedb.client.models.V1alpha1Redis;
import com.kubedb.client.util.Config;
import com.kubedb.client.util.Watch;
import java.io.IOException;
import java.util.concurrent.TimeUnit;

public class WatchExample {
  public static void main(String[] args) throws IOException, ApiException {
    ApiClient client = Config.defaultClient();
    client.getHttpClient().setReadTimeout(60, TimeUnit.SECONDS);
    Configuration.setDefaultApiClient(client);

    KubedbComV1alpha1Api api = new KubedbComV1alpha1Api();

    Watch<V1alpha1Redis> watch =
        Watch.createWatch(
            client,
            api.listRedisForAllNamespacesCall(
                null, null, null, null, null, "false", null, null, Boolean.TRUE, null, null),
            new TypeToken<Watch.Response<V1alpha1Redis>>() {}.getType());

    for (Watch.Response<V1alpha1Redis> item : watch) {
      System.out.printf("%s : %s%n", item.type, item.object.getMetadata().getName());
    }
  }
}

More examples can be found in examples folder. To run examples, run this command:

mvn exec:java -Dexec.mainClass="Example"

Documentation

All APIs and Models' documentation can be found at the Generated client's README file

Compatibility

Kubernetes 1.4 Kubernetes 1.5 Kubernetes 1.6 Kubernetes 1.7 Kubernetes 1.8 Kubernetes 1.9
1.0 + + + + ✓ -

Key:

  • ✓ Exactly the same features / API objects in both java-client and the Kubernetes version.
  • + java-client has features or api objects that may not be present in the Kubernetes cluster, but everything they have in common will work.
  • - The Kubernetes cluster has features the java-client library can't use (additional API objects, etc).

See the CHANGELOG for a detailed description of changes between java-client versions.

Community, Support, Discussion

We use Slack for public discussions. To chit chat with us or the rest of the community, join us in the Kubernetes Slack team channel #kubedb. To sign up, use our Slack inviter.

To receive product announcements, please join our mailing list or follow us on Twitter. Our mailing list is also used to share design docs shared via Google docs.

If you have any problem with the package or any suggestions, please file an issue.

Development

Update client

To update the client clone the gen repo and run this command at the root of this repo:

../gen/openapi/autoupdate.sh