NOTE: this project has been migrated into the Trellis/Rosid repository.

• A Zookeeper ensemble (3.5.x or later)
• A Kafka cluster (0.11.x or later)
• Java 8 or 9
• An asynchronous processing application

The location of Kafka and Zookeeper will be defined in the ./etc/config.yml file.

Unpack a zip or tar distribution. In that directory, modify ./etc/config.yml to match the desired values for your system.

To run trellis directly from within a console, issue this command:

$ ./bin/trellis-app server ./etc/config.yml

Note: When running trellis, please be sure to also have an active asynchronous processor.

To install Trellis as a systemd service on linux, follow the steps below. systemd is used by linux distributions such as CentOS/RHEL 7+ and Ubuntu 15+.

1. Move the unpacked Trellis directory to a location such as /opt/trellis. If you choose a different location, please update the ./etc/trellis.service script.

2. Edit the ./etc/environment file as desired (optional).

3. Edit the ./etc/config.yml file as desired (optional).

4. Create a trellis user:

$ sudo useradd -r trellis -s /sbin/nologin

5. Create data directories. A different location can be used, but then please update the ./etc/config.yml file.

$ sudo mkdir /var/lib/trellis
$ sudo chown trellis.trellis /var/lib/trellis

6. Install the systemd file:

$ sudo ln -s /opt/trellis/etc/trellis.service /etc/systemd/system/trellis.service

7. Reload systemd to see the changes

$ sudo systemctl daemon-reload

8. Start the trellis service

$ sudo systemctl start trellis

To check that trellis is running, check the URL: http://localhost:8080

Application health checks are available at http://localhost:8081/healthcheck

1. Run ./gradlew clean install to build the application or download one of the releases.
2. Unpack the appropriate distribution in ./build/distributions
3. Start the application according to the steps above

The web application wrapper (Dropwizard.io) makes many configuration options available. Any of the configuration options defined by Dropwizard can be part of your application's configuration file.

Trellis defines its own configuration options, including:

partitions:
    - id: partition-name
      binaries:
        path: /path/to/binaries
      resources:
        path: /path/to/resources
      baseUrl: http://localhost:8080/

namespaces:
    file: /path/to/namespaces.json

zookeeper:
    ensembleServers: localhost:2181

kafka:
    bootstrapServers: localhost:9092

auth:
    webac:
        enabled: true
    anon:
        enabled: true
    jwt:
        enabled: true
        base64Encoded: false
        key: secret
    basic:
        enabled: true
        usersFile: /path/to/users.auth

cors:
    enabled: true
    allowOrigin:
        - "*"
    allowMethods:
        - "GET"
        - "POST"
        - "PATCH"
    allowHeaders:
        - "Content-Type"
        - "Link"
    exposeHeaders:
        - "Link"
        - "Location"
    maxAge: 180
    allowCredentials: true

async: false

cacheMaxAge: 86400