github.com/anth0d/nomad@v0.0.0-20221214183521-ae3a0a2cad06/website/content/plugins/drivers/community/rookout.mdx (about)

     1  ---
     2  layout: docs
     3  page_title: 'Drivers: Rookout'
     4  description: The Rookout driver is used to run your Java app with Rookout.
     5  ---
     6  
     7  # Rookout Driver
     8  
     9  Name: `java-rookout`
    10  
    11  The Rookout Nomad driver is used to execute Java applications packaged into a Java Jar file and automatically add the Rookout SDK to them.
    12  
    13  [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.
    14  
    15  More info about the Rookout SDK is available in the [Rookout docs](https://docs.rookout.com).
    16  
    17  ## Prerequisites
    18  
    19  Using this driver requires you to have a Rookout token which you can get by [signing up](http://rookout.com).
    20  
    21  This driver is based on the Nomad [Java driver](https://www.nomadproject.io/docs/drivers/java).
    22  
    23  1. Clone the driver's repo: `git clone https://github.com/rookout/rookout-nomad-driver`
    24  2. Change to the cloned dir: `cd rookout-nomad-driver`
    25  3. Create a plugin dir (unless you already have one for your Nomad installation): `mkdir plugins`
    26  4. Copy the corresponding binary from the `bin` folder, for example: `cp ./bin/java-rookout-linux-x64 plugins/java-rookout`
    27  5. Make sure that the driver has execution permission: `chmod +x ./plugins/java-rookout`
    28  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`
    29  
    30  ## Task Configuration
    31  
    32  The `java-rookout` driver accepts all configuration options of the [`java`](https://www.nomadproject.io/docs/drivers/java) driver.
    33  
    34  Set the `rookout_token` config key to your Rookout token, or define it as a variable and pass it as a parameter.
    35  
    36  For example:
    37  ```hcl
    38  task "run-with-rookout" {
    39    driver = "java-rookout"
    40  
    41    config {
    42      rookout_token = "ea15c38c4e05cf4549b..."
    43    }
    44  }
    45  ```
    46  
    47  Additional Rookout configuration can be passed as environment variables like so:
    48  ```hcl
    49  env {
    50      ROOKOUT_REMOTE_ORIGIN="https://github.com/Rookout/tutorial-java"
    51  }
    52  ```