From e82698fc61434a976624b10124866bdcbe52e87f Mon Sep 17 00:00:00 2001 From: Alex Dadgar Date: Tue, 17 Nov 2015 15:39:38 -0800 Subject: [PATCH] Update rkt docs to denote its experimental status --- website/source/docs/drivers/rkt.html.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/website/source/docs/drivers/rkt.html.md b/website/source/docs/drivers/rkt.html.md index d96a4b16f..ddbb76601 100644 --- a/website/source/docs/drivers/rkt.html.md +++ b/website/source/docs/drivers/rkt.html.md @@ -3,20 +3,22 @@ layout: "docs" page_title: "Drivers: Rkt" sidebar_current: "docs-drivers-rkt" description: |- - The Rkt task driver is used to run application containers using Rkt. + The rkt task driver is used to run application containers using rkt. --- -# Rkt Driver +# Rkt Driver - Experimental Name: `rkt` -The `Rkt` driver provides an interface for using CoreOS Rkt for running +The `rkt` driver provides an interface for using CoreOS rkt for running application containers. Currently, the driver supports launching -containers. +containers but does not support resource isolation or dynamic ports. This can +lead to resource over commitment and port conflicts and as such, this driver is +being marked as experimental and should be used with care. ## Task Configuration -The `Rkt` driver supports the following configuration in the job spec: +The `rkt` driver supports the following configuration in the job spec: * `trust_prefix` - **(Optional)** The trust prefix to be passed to rkt. Must be reachable from the box running the nomad agent. If not specified, the image is run without @@ -28,23 +30,23 @@ hash, ACI address or docker registry. ## Task Directories -The `Rkt` driver does not currently support mounting the `alloc/` and `local/` -directory. It is currently blocked by this [Rkt +The `rkt` driver does not currently support mounting the `alloc/` and `local/` +directory. It is currently blocked by this [rkt issue](https://github.com/coreos/rkt/issues/761). As such the coresponding [environment variables](/docs/jobspec/environment.html#task_dir) are not set. ## Client Requirements -The `Rkt` driver requires rkt to be installed and in your systems `$PATH`. +The `rkt` driver requires rkt to be installed and in your systems `$PATH`. The `trust_prefix` must be accessible by the node running Nomad. This can be an internal source, private to your cluster, but it must be reachable by the client over HTTP. ## Client Attributes -The `Rkt` driver will set the following client attributes: +The `rkt` driver will set the following client attributes: -* `driver.rkt` - Set to `1` if Rkt is found on the host node. Nomad determines +* `driver.rkt` - Set to `1` if rkt is found on the host node. Nomad determines this by executing `rkt version` on the host and parsing the output * `driver.rkt.version` - Version of `rkt` eg: `0.8.1` * `driver.rkt.appc.version` - Version of `appc` that `rkt` is using eg: `0.8.1`