* initial documentation refactoring * more updates and changes * fixing pom * rename intro to spring-cloud-kubernetes.adoc * creating root document * fixing docs index
37 lines
1.6 KiB
Markdown
37 lines
1.6 KiB
Markdown
## Spring Cloud Kubernetes
|
|
|
|
[Spring Cloud](http://projects.spring.io/spring-cloud/) integration with [Kubernetes](http://kubernetes.io/)
|
|
|
|
[](https://maven-badges.herokuapp.com/maven-central/org.springframework.cloud/spring-cloud-starter-kubernetes/)
|
|

|
|
[](http://www.javadoc.io/doc/org.springframework.cloud/spring-cloud-starter-kubernetes)
|
|
|
|
|
|
---
|
|
|
|
#### Version and compatibility
|
|
|
|
The current version of Spring Cloud Kubernetes is using version 2.2.x of the [Fabric8 Kubernetes Client](https://github.com/fabric8io/kubernetes-client) and is expected to work with version 1.x of [Kubernetes](https://github.com/kubernetes/kubernetes) and 1.x of [Openshift](https://github.com/openshift/origin).
|
|
Note, that [Kubernetes](https://github.com/kubernetes/kubernetes) and [Openshift](https://github.com/openshift/origin) are for the most part backwards compatible so, its expected that this framework is compatible with both the latest and earlier versions.
|
|
|
|
|
|
### Building
|
|
|
|
You can just use maven to build it from sources:
|
|
|
|
```
|
|
mvn clean install
|
|
```
|
|
|
|
### Usage
|
|
|
|
The project provides a "starter" module, so you just need to add the following dependency in your project.
|
|
|
|
```xml
|
|
<dependency>
|
|
<groupId>org.springframework.cloud</groupId>
|
|
<artifactId>spring-cloud-starter-kubernetes</artifactId>
|
|
<version>x.y.z</version>
|
|
</dependency>
|
|
```
|