index.html

<h1 id="eclipsejkube">Eclipse Jkube</h1>

<p>Eclipse Jkube is a collection of plugins and libraries that are used for generating and deploying Kubernetes/Openshift manifests at compile
time. It brings your Java applications on to Kubernetes and OpenShift. It provides a tight integration into Maven and benefits from 
the build configuration already provided. This project focus on two tasks: Building Docker images and creating Kubernetes and 
OpenShift resource descriptors.</p>

<h2 id="features">Features</h2>

<ul>
<li><p><strong>Jkube-kit</strong></p>

<ul>
<li><strong>Generator</strong> framework for automatically generating Docker images by examining project information.</li>

<li><strong>Enricher</strong> framework for creating and enhancing Kubernetes/Openshift resource descriptors.</li>

<li><strong>Profile</strong> combining configuration for generators and enrichers.</li>

<li><strong>Resource Configuration</strong> model objects for a simplified configuration of Kubernetes/Openshift resource.</li>

<li><strong>Image Configuration</strong> model objects for modeling Docker image configuration.</li></ul></li>

<li><p><strong>Kubernetes Maven Plugin</strong></p>

<ul>
<li>Generates docker images with flexible and powerful configuration.</li>

<li>Supports generating Kubernetes descriptors</li>

<li>Provides <strong>Zero Configuration</strong> for a quick ramp-up where opinionated defaults will be pre-selected.</li>

<li>Provides <strong>Inline Configuration</strong> within the plugin configuration in an XML syntax.</li>

<li>Provides <strong>External Configuration</strong> templates of real deployment descriptors which are enriched by plugin.</li></ul></li>

<li><p><strong>Openshift Maven Plugin</strong></p>

<p><ul>
<li>Dealing with S2I images and hence inherits its flexible and powerful configuration</li></p>

<p><li>Supports generating Openshift descriptors</li></p>

<p><li>Provides <strong>Zero Configuration</strong> for a quick ramp-up where opinionated defaults will be pre-selected.</li></p>

<p><li>Provides <strong>Inline Configuration</strong> within the plugin configuration in an XML syntax.</li></p>

<p><li>Provides <strong>External Configuration</strong> templates of real deployment descriptors which are enriched by plugin.</li></ul>

<p></p></li>
</ul></p>

<h2 id="gettingstarted">Getting Started</h2>

<ul>
<li><p>Check out our asciicasts for:</p>

<ul>
<li><a href="https://asciinema.org/a/253747">Kubernetes Maven Plugin</a>
<img src="https://raw.githubusercontent.com/eclipse/jkube/kubernetes-maven-plugin/master/k8s-maven-plugin-demo.gif" alt="Sample Demo" /></li>

<li><a href="https://asciinema.org/a/253742">Openshift Maven Plugin</a>
<img src="https://raw.githubusercontent.com/eclipse/jkube/openshift-maven-plugin/master/oc-maven-plugin-demo.gif" alt="Sample Demo" /></li></ul></li>

<li><p>Visit our <a href="https://github.com/eclipse/quickstarts">quickstarts samples</a> on github.</p></li>
</ul>

<h2 id="documentation">Documentation</h2>

<ul>
<li>Check out our documentation for for:


<ul>
<li><a href="./kubernetes-maven-plugin/doc/index.html">Kubernetes Maven Plugin</a></li>

<li><a href="./openshift-maven-plugin/doc/index.html">Openshift Maven Plugin</a></li></ul>
</li>
</ul>

<h2 id="gettinginvolved">Getting Involved</h2>

<ul>
<li>Follow us on <a href="https://twitter.com/jkubeio">Twitter</a></li>

<li>Contribute via bug fixes or issues on <a href="https://github.com/eclipse/jkube">Github</a></li>

<li>Our mailing list: jkube-dev@eclipse.org</li>

<li>Reach out to us on <a href="https://gitter.im/eclipse/jkube#">Gitter</a></li>
</ul>