mirror of
https://github.com/kemko/nomad.git
synced 2026-01-06 18:35:44 +03:00
8a597a172d
* Docs SEO: task drivers and plugins; refactor virt section * add redirects for virt driver files * Some updates. committing rather than stashing * fix content-check errors * Remove docs/devices/ and redirect to plugins/devices * Update docs/drivers descriptions * Move USB device plugin up a level. Finish descriptions. * Apply suggestions from Jeff's code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * Apply title case suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * apply title case suggestions; fix indentation --------- Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
53 lines
2.0 KiB
Plaintext
53 lines
2.0 KiB
Plaintext
---
|
||
layout: docs
|
||
page_title: Rookout task driver plugin
|
||
description: Use the community-supported Rookout task driver to run your Java application with Rookout in Nomad jobs.
|
||
---
|
||
|
||
# Rookout task driver plugin
|
||
|
||
Name: `java-rookout`
|
||
|
||
The Rookout Nomad driver is used to execute Java applications packaged into a Java Jar file and automatically add the Rookout SDK to them.
|
||
|
||
[Rookout](https://rookout.com) is a developer solution for Cloud Native debugging and live-data collection. Rookout’s Non-Breaking Breakpoints let you collect any type of data on the fly with no extra coding, redeployments, or restarts.
|
||
|
||
More info about the Rookout SDK is available in the [Rookout docs](https://docs.rookout.com).
|
||
|
||
## Prerequisites
|
||
|
||
Using this driver requires you to have a Rookout token which you can get by [signing up](http://rookout.com).
|
||
|
||
This driver is based on the Nomad [Java driver](/nomad/docs/drivers/java).
|
||
|
||
1. Clone the driver's repo: `git clone https://github.com/rookout/rookout-nomad-driver`
|
||
2. Change to the cloned dir: `cd rookout-nomad-driver`
|
||
3. Create a plugin dir (unless you already have one for your Nomad installation): `mkdir plugins`
|
||
4. Copy the corresponding binary from the `bin` folder, for example: `cp ./bin/java-rookout-linux-x64 plugins/java-rookout`
|
||
5. Make sure that the driver has execution permission: `chmod +x ./plugins/java-rookout`
|
||
6. When running the Nomad agent, be sure to set the plugins dir accordingly, for example: `sudo nomad agent -dev -plugin-dir=/home/user/rookout-nomad-driver/plugins`
|
||
|
||
## Task Configuration
|
||
|
||
The `java-rookout` driver accepts all configuration options of the [`java`](/nomad/docs/drivers/java) driver.
|
||
|
||
Set the `rookout_token` config key to your Rookout token, or define it as a variable and pass it as a parameter.
|
||
|
||
For example:
|
||
```hcl
|
||
task "run-with-rookout" {
|
||
driver = "java-rookout"
|
||
|
||
config {
|
||
rookout_token = "ea15c38c4e05cf4549b..."
|
||
}
|
||
}
|
||
```
|
||
|
||
Additional Rookout configuration can be passed as environment variables like so:
|
||
```hcl
|
||
env {
|
||
ROOKOUT_REMOTE_ORIGIN="https://github.com/Rookout/tutorial-java"
|
||
}
|
||
```
|