DC/OS Package Manager (Cosmos)
Provides an API for the orderly, harmonious, and complete management of DC/OS service packages.
Teamcity CI : Build & Compile and Integration Tests
Table of Contents
- Running tests
- Running Cosmos
- Project structure
- Versions & Compatibility
- API Documentation
- Reporting Problems
Scala style checks
This project enforces certain scalastyle rules. To run those check against the code run:
There is a suite of unit tests that can be ran by running
sbt clean test:test
To generate an scoverage report for unit tests run the following command:
sbt clean coverage test:test coverageReport coverageAggregate
The generated report can then be found at
NOTE: You should never run coverage at the same time as one-jar because the produced one-jar will contains scoverage instrumented class files and will fail to run.
There is a suite of integration tests that can be ran by running
sbt clean it:test
At this time it is not possible to easily generate an scoverage report for the integration suite
cosmos-server. This is due to some classpath scoping issues related to the cosmos server
being forked before the integration suite is ran.
- A running DC/OS cluster
Running the tests
The integration tests support three ways of configuring the tests. This is done using the following system properties:
com.mesosphere.cosmos.dcosUri- Location of the DC/OS cluster as an HTTP URL.
trueor undefined the integration tests will automatically execute the Cosmos defined in this repository. If
falsethen the integration tests will not execute a Cosmos.
com.mesosphere.cosmos.test.CosmosIntegrationTestClient.CosmosClient.uri- This property is not required. If set to a URL, it will override the default value. The integration tests assume that the Cosmos described in this system property is configured to control the same cluster described in
- Run the integration tests against the Cosmos implemented in this repo. This is done by
automatically starting an in process ZooKeeper cluster and a Cosmos server that controls a DC/OS
cluster. This configuration can be enabled by setting the
export COSMOS_AUTHORIZATION_HEADER="token=$(http --ignore-stdin <dcos-host-url>/acs/api/v1/auth/login uid=<dcos-user> password=<user-password> | jq -r ".token")" sbt -Dcom.mesosphere.cosmos.dcosUri=<dcos-host-url> \ clean it:test
- Run the integration tests against the Cosmos running in a DC/OS cluster. This configuration can
be enabled by setting the
export COSMOS_AUTHORIZATION_HEADER="token=$(http --ignore-stdin <dcos-host-url>/acs/api/v1/auth/login uid=<dcos-user> password=<user-password> | jq -r ".token")" sbt -Dcom.mesosphere.cosmos.dcosUri=<dcos-host-url> \ -Dcom.mesosphere.cosmos.boot=false \ clean it:test
- Run the integration tests against a Cosmos already configured to control a DC/OS cluster. This
configuration can be enabled by setting the
export COSMOS_AUTHORIZATION_HEADER="token=$(http --ignore-stdin <dcos-host-url>/acs/api/v1/auth/login uid=<dcos-user> password=<user-password> | jq -r ".token")" sbt -Dcom.mesosphere.cosmos.dcosUri=<dcos-host-url> \ -Dcom.mesosphere.cosmos.boot=false \ -Dcom.mesosphere.cosmos.test.CosmosIntegrationTestClient.CosmosClient.uri=http://localhost:7070 \ clean it:test
To run a single test, something like the following can be used in the sbt console:
# to run a single test suite it:testOnly *ServiceUpdateSpec # To run a single test from a single suite it:testOnly *ServiceUpdateSpec -- -z "user should be able to update a service via custom manager"
Cosmos requires a ZooKeeper instance to be available. It looks for one at
zk://localhost:2181/cosmos by default; to override with an alternate
<zk-uri>, specify the flag
-com.mesosphere.cosmos.zookeeperUri <zk-uri> on the command line when starting Cosmos (see
We also need a One-JAR to run Cosmos:
The jar will be created in the
cosmos-server/target/scala-2.12/ directory. This can be executed
java -jar cosmos-server/target/scala-2.12/cosmos-server_2.12-<version>-SNAPSHOT-one-jar.jar \ -com.mesosphere.cosmos.dcosUri <dcos-host-url>
It can also be executed with ZooKeeper authentication with:
export ZOOKEEPER_USER <user> export ZOOKEEPER_SECRET <secret> java -jar cosmos-server/target/scala-2.12/cosmos-server_2.12-<version>-SNAPSHOT-one-jar.jar \ -com.mesosphere.cosmos.dcosUri <dcos-host-url>
Cosmos Admin Portal
Cosmos exposes an admin portal at
http://<cosmos-host>:9990/admin. If Cosmos is running locally
and you are just interested in the metrics run the following command.
The code is organized into several subprojects, each of which has a JAR published to the Sonatype OSS repository. Here's an overview:
src/maindirectory: defines the code and resources used by both the unit and integration tests.
src/testdirectory: defines the unit tests and any resources they require.
src/maindirectory: defines the integration tests and any resources they require.
- The remaining subprojects define the main code for Cosmos, always within their
All the list of RPCs that cosmos supports are located in
com/mesosphere/cosmos/rpc package in the
cosmos-common module. The RPC's are structured according to their version like
v2 and so on.
cosmos grows, only the two most recent versions of rpc will be supported. Every time a new rpc is
added, the oldest rpc will be removed if there are more than two versions. In essence, this means
that the tail version should always be considered as deprecated.
Versions & Compatibility
The following table outlines which version of Cosmos is bundled with each version of DC/OS
|DC/OS Release Version||Cosmos Version|
The below table is a compatibility matrix between Cosmos and Universe repository consumption format.
Rows represent Cosmos versions, columns represent repository formats.
|Version 2||Version 3||Version 4|
|0.1.x||Supported||Not Supported||Not Supported|
The below table is a compatibility matrix between Cosmos and Universe packaging versions.
Rows represent Cosmos versions, columns represent packaging versions.
|0.1.x||Supported||Not Supported||Not Supported|
Cosmos Version 0.3.x Docs
Cosmos Version 0.4.x Docs
The tooling for packaging docs is at mesosphere/packaging-docs
If you encounter a problem that seems to be related to a Cosmos bug, please create an issue at
DC/OS Jira. To create an issue click on the
Create button at the top and add
cosmos to the component field.