Skip to content

Commit c6be1ff

Browse files
Merge pull request #43 from mbohlool/readme
Promote client capabilities to Silver and add relevant installation steps
2 parents ca0f256 + 1b464a9 commit c6be1ff

File tree

1 file changed

+41
-1
lines changed

1 file changed

+41
-1
lines changed

README.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,51 @@
11
# Kubernetes Java Client
22

33
[![Build Status](https://travis-ci.org/kubernetes-client/java.svg?branch=master)](https://travis-ci.org/kubernetes-client/java)
4-
[![Client Capabilities](https://img.shields.io/badge/Kubernetes%20client-Bronze-blue.svg?style=plastic&colorB=cd7f32&colorA=306CE8)](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/csi-new-client-library-procedure.md#client-capabilities)
4+
[![Client Capabilities](https://img.shields.io/badge/Kubernetes%20client-Silver-blue.svg?style=plastic&colorB=C0C0C0&colorA=306CE8)](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/csi-new-client-library-procedure.md#client-capabilities)
55
[![Client Support Level](https://img.shields.io/badge/kubernetes%20client-alpha-green.svg?style=plastic&colorA=306CE8)](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/csi-new-client-library-procedure.md#client-support-level)
66

77
Java client for the [kubernetes](http://kubernetes.io/) API.
88

9+
## Installation
10+
11+
To install the Java client library to your local Maven repository, simply execute:
12+
13+
```shell
14+
git clone --recursive https://github.com/kubernetes-client/java
15+
cd java
16+
mvn install
17+
```
18+
19+
Refer to the [official documentation](https://maven.apache.org/plugins/maven-deploy-plugin/usage.html) for more information.
20+
21+
### Maven users
22+
23+
Add this dependency to your project's POM:
24+
25+
```xml
26+
<dependency>
27+
<groupId>io.kubernetes</groupId>
28+
<artifactId>client-java</artifactId>
29+
<version>1.0-SNAPSHOT</version>
30+
<scope>compile</scope>
31+
</dependency>
32+
```
33+
34+
### Others
35+
36+
At first generate the JAR by executing:
37+
38+
```
39+
git clone --recursive https://github.com/kubernetes-client/java
40+
cd java
41+
mvn package
42+
```
43+
44+
Then manually install the following JARs:
45+
46+
* target/client-java-1.0-SNAPSHOT.jar
47+
* target/lib/*.jar
48+
949
## Example
1050

1151
list all pods:

0 commit comments

Comments
 (0)