org.kevoree:org.kevoree.framework

Kevoree Framework Core


Keywords
component-based, deployment, java-8, runtime
Licenses
LGPL-2.0/LGPL-3.0

Documentation

Kevoree

Please find documentation at http://doc.kevoree.org

Kevoree icon

Please visit kevoree.org

Structure

This repository contains all the Kevoree Java core, api and tooling.

Kevoree Java Runtime

Current dev version that only works with https://new-registry.kevoree.org is 5.5.0-SNAPSHOT

Download

mkdir -p /tmp/kevoree
cd /tmp/kevoree
wget http://oss.sonatype.org/service/local/artifact/maven/redirect?r=public\&g=org.kevoree\&a=org.kevoree.tools.runtime\&v=LATEST -O kevoree.jar

Run

java -jar kevoree.jar

⚠️ Note that you need to make your .kevoree/config.json point to the new Kevoree registry available at https://new-registry.kevoree.org for dev version 5.5.0-SNAPSHOT

Usage with Docker

Maybe the easiest way to get started with Kevoree is to use the Docker image: kevoree/java:5.5.0-SNAPSHOT

docker run -it -v /tmp/main.kevs:/tmp/main.kevs kevoree/java:5.5.0-SNAPSHOT -Dregistry.host=new-registry.kevoree.org -Dnode.bootstrap=/tmp/main.kevs

In the example above we are starting a Docker container using the kevoree/java:5.5.0-SNAPSHOT image.
We are mounting a local KevScript file (in /tmp/main.kevs to the same location in the container) and we are telling Kevoree to use it to bootstrap with -Dnode.bootstrap=/tmp/main.kevs.
We are also by-passing the default registry.host (ie. editor.kevoree.org) to point to the new one at new-registry.kevoree.org

Usage with Maven

POM file inheriting

If you want to create your own Kevoree component, node, group or channel you can use the starter-parent artefact:

<parent>
  <groupId>org.kevoree.library</groupId>
  <artifactId>starter-parent</artifactId>
  <version>KEVOREE_VERSION</version>
</parent>

Manual dependencies management

You can also create your own pom.xml from scratch without using any <parent> like so:

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
	<modelVersion>4.0.0</modelVersion>

	<groupId>your.group.id</groupId>
	<artifactId>my-kevoree-comp</artifactId>
	<version>1.0.0-SNAPSHOT</version>
	<name>YourGroupId :: MyKevoreeComp</name>

	<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<java.version>1.8</java.version>
		<maven.compiler.source>${java.version}</maven.compiler.source>
		<maven.compiler.target>${java.version}</maven.compiler.target>
		<kevoree.version>KEVOREE_VERSION</kevoree.version>
		<kevoree.registry.namespace>yournamespace</kevoree.registry.namespace>
		<kevoree.registry.url>https://registry.kevoree.org</kevoree.registry.url>
	</properties>

	<dependencies>
		<dependency>
			<groupId>org.kevoree</groupId>
			<artifactId>org.kevoree.api</artifactId>
			<version>${kevoree.version}</version>
			<scope>provided</scope>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-surefire-plugin</artifactId>
			</plugin>
			<!-- Kevoree plugins -->
			<plugin>
				<groupId>org.kevoree</groupId>
				<artifactId>org.kevoree.tools.mavenplugin</artifactId>
				<version>${kevoree.version}</version>
				<executions>
					<execution>
						<goals>
							<goal>generate</goal>
							<goal>deploy</goal>
						</goals>
					</execution>
				</executions>
				<configuration>
					<registry>${kevoree.registry.url}</registry>
					<namespace>${kevoree.registry.namespace}</namespace>
					<kevscript>${env.KEVS}</kevscript>
				</configuration>
			</plugin>
		</plugins>
	</build>

</project>

2. Standard Library documentation

> Standard libraries repository