The Ocopea orcs component contains all the codebase for building the orchestration components of Ocopea and the orcs Docker image. Visit the Ocopea extensions for platform specific installation instructions.
Learn More:
The Orcs repository contains codebase for several independent microservices and components that can be built separately. It is however recommended to build the project as a whole at least once in order to populate the local maven repository with latest versions of all libraries. The project is using maven, so in order to build, clone the repo and use the mvn command.
- maven 3.2.5
- JDK8
$ git clone https://github.com/ocopea/orcs.git
$ cd orcs
$ mvn clean install
Once the project is built, development of each service can be done separately using maven from the component folder. For example, for building the Site microservice and running all Site tests:
$ cd site
$ mvn clean install
In order to build a Docker image containing the local code, use the deployer/orcs-docker-image project:
$ cd deployer/orcs-docker-image
$ mvn clean install
$ cd target/docker
$ ./buildImage.sh
This will build the orcs Docker image (ocopea/orcs-k8s-runner) locally on the Docker machine that your Docker client is using.
Every pull request must pass the following:
- Code checkstyle must be enforced (use the "checkstyle" maven profile to validate)
- Unit tests of each modified module must pass
- Integration tests must pass. to run the integration tests build the "deployer" module using maven