luxolus/open-nomad
2
0
Fork 0
Code Issues 1 Pull requests Packages Releases Wiki Activity
open-nomad/website/source/layouts/docs.erb
Omar Khawaja 55ccd41634
add plugin content (docs) (#5186) 
* call out pluggable drivers in task drivers section and link/add info to plugin stanza

* fix hyphenation

* removing page and nav that tells users drivers are not pluggable

* show new syntax for configuring raw_exec plugin on client

* enabled option value for raw_exec is boolean

* add plugin options section and mark client options as soon to be deprecated

* fix typos

* add plugin options for rkt task drivers and place deprecation warning in client options

* add some plugin options with plugin configuration example + mark client options as soon to be deprecated

* modify deprecation warning

* replace colon with - for options

* add docker plugin options

* update links within docker task driver to point to plugin options

* fix typo and clarify config options for lxc task driver

* replace raw_exec plugin syntax example with docker example

* create external section

* restructure lxc docs and add backward incompatibility warning

* update lxc driver doc

* add redirect for lxc driver doc

* call out plugin options and mark client config options for drivers as deprecated

* add placeholder for lxc driver binary download

* update data_dir/plugins reference with plugin_dir reference

* Update website/source/docs/external/lxc.html.md

Co-Authored-By: Omar-Khawaja <Omar-Khawaja@users.noreply.github.com>

* corrections

* remove lxc from built-in drivers navigation

* reorganize doc structure and fix redirect

* add detail about 0.9 changes

* implement suggestions/fixes

* removed extraneous punctuation

* add official lxc driver link
2019-01-29 15:53:05 -05:00

515 lines
23 KiB
Plaintext
Raw Blame History

<% wrap_layout :inner do %>
<% content_for :sidebar do %>
<ul class="nav docs-sidenav">
<li<%= sidebar_current("docs-internal") %>>
<a href="/docs/internals/index.html">Internals</a>
<ul class="nav">
<li<%= sidebar_current("docs-internals-architecture") %>>
<a href="/docs/internals/architecture.html">Architecture</a>
</li>
<li<%= sidebar_current("docs-internals-scheduling") %>>
<a href="/docs/internals/scheduling/index.html">Scheduling</a>
<ul class="nav">
<li <%= sidebar_current("docs-internals-scheduling-internals") %>>
<a href="/docs/internals/scheduling/scheduling.html">Internals</a>
</li>
<li <%= sidebar_current("docs-configuration-autopilot") %>>
<a href="/docs/internals/scheduling/preemption.html">Preemption
<sup>0.9 Beta</sup>
</a>
</li>
</ul>
</li>
<li<%= sidebar_current("docs-internals-consensus") %>>
<a href="/docs/internals/consensus.html">Consensus Protocol</a>
</li>
<li<%= sidebar_current("docs-internals-gossip") %>>
<a href="/docs/internals/gossip.html">Gossip Protocol</a>
</li>
</ul>
</li>
<li<%= sidebar_current("docs-configuration") %>>
<a href="/docs/configuration/index.html">Configuration</a>
<ul class="nav">
<li <%= sidebar_current("docs-configuration-acl") %>>
<a href="/docs/configuration/acl.html">acl</a>
</li>
<li <%= sidebar_current("docs-configuration-autopilot") %>>
<a href="/docs/configuration/autopilot.html">autopilot</a>
</li>
<li <%= sidebar_current("docs-configuration-client") %>>
<a href="/docs/configuration/client.html">client</a>
</li>
<li <%= sidebar_current("docs-configuration-consul") %>>
<a href="/docs/configuration/consul.html">consul</a>
</li>
<li <%= sidebar_current("docs-configuration-plugin") %>>
<a href="/docs/configuration/plugin.html">plugin
<sup>0.9 Beta</sup>
</a>
</li>
<li <%= sidebar_current("docs-configuration-sentinel") %>>
<a href="/docs/configuration/sentinel.html">sentinel</a>
</li>
<li <%= sidebar_current("docs-configuration-server") %>>
<a href="/docs/configuration/server.html">server</a>
</li>
<li <%= sidebar_current("docs-configuration--server-join") %>>
<a href="/docs/configuration/server_join.html">server_join</a>
</li>
<li <%= sidebar_current("docs-configuration-telemetry") %>>
<a href="/docs/configuration/telemetry.html">telemetry</a>
</li>
<li <%= sidebar_current("docs-configuration-tls") %>>
<a href="/docs/configuration/tls.html">tls</a>
</li>
<li <%= sidebar_current("docs-configuration-vault") %>>
<a href="/docs/configuration/vault.html">vault</a>
</li>
</ul>
</li>
<li<%= sidebar_current("docs-commands") %>>
<a href="/docs/commands/index.html">Commands (CLI)</a>
<ul class="nav">
<li<%= sidebar_current("docs-commands-acl") %>>
<a href="/docs/commands/acl.html">acl</a>
<ul class="nav">
<li<%= sidebar_current("docs-commands-acl-bootstrap") %>>
<a href="/docs/commands/acl/bootstrap.html">bootstrap</a>
</li>
<li<%= sidebar_current("docs-commands-acl-policy-apply") %>>
<a href="/docs/commands/acl/policy-apply.html">policy apply</a>
</li>
<li<%= sidebar_current("docs-commands-acl-policy-delete") %>>
<a href="/docs/commands/acl/policy-delete.html">policy delete</a>
</li>
<li<%= sidebar_current("docs-commands-acl-policy-info") %>>
<a href="/docs/commands/acl/policy-info.html">policy info</a>
</li>
<li<%= sidebar_current("docs-commands-acl-policy-list") %>>
<a href="/docs/commands/acl/policy-list.html">policy list</a>
</li>
<li<%= sidebar_current("docs-commands-acl-token-create") %>>
<a href="/docs/commands/acl/token-create.html">token create</a>
</li>
<li<%= sidebar_current("docs-commands-acl-token-delete") %>>
<a href="/docs/commands/acl/token-delete.html">token delete</a>
</li>
<li<%= sidebar_current("docs-commands-acl-token-info") %>>
<a href="/docs/commands/acl/token-info.html">token info</a>
</li>
<li<%= sidebar_current("docs-commands-acl-token-self") %>>
<a href="/docs/commands/acl/token-self.html">token self</a>
</li>
<li<%= sidebar_current("docs-commands-acl-token-update") %>>
<a href="/docs/commands/acl/token-update.html">token update</a>
</li>
</ul>
</li>
<li<%= sidebar_current("docs-commands-_agent") %>>
<a href="/docs/commands/agent.html">agent</a>
</li>
<li<%= sidebar_current("docs-commands-agent-info") %>>
<a href="/docs/commands/agent-info.html">agent-info</a>
</li>
<li<%= sidebar_current("docs-commands-alloc") %>>
<a href="/docs/commands/alloc.html">alloc</a>
<ul class="nav">
<li<%= sidebar_current("docs-commands-alloc-fs") %>>
<a href="/docs/commands/alloc/fs.html">fs</a>
</li>
<li<%= sidebar_current("docs-commands-alloc-logs") %>>
<a href="/docs/commands/alloc/logs.html">logs</a>
</li>
<li<%= sidebar_current("docs-commands-alloc-status") %>>
<a href="/docs/commands/alloc/status.html">status</a>
</li>
</ul>
</li>
<li<%= sidebar_current("docs-commands-deployment") %>>
<a href="/docs/commands/deployment.html">deployment</a>
<ul class="nav">
<li<%= sidebar_current("docs-commands-deployment-fail") %>>
<a href="/docs/commands/deployment/fail.html">fail</a>
</li>
<li<%= sidebar_current("docs-commands-deployment-list") %>>
<a href="/docs/commands/deployment/list.html">list</a>
</li>
<li<%= sidebar_current("docs-commands-deployment-pause") %>>
<a href="/docs/commands/deployment/pause.html">pause</a>
</li>
<li<%= sidebar_current("docs-commands-deployment-promote") %>>
<a href="/docs/commands/deployment/promote.html">promote</a>
</li>
<li<%= sidebar_current("docs-commands-deployment-resume") %>>
<a href="/docs/commands/deployment/resume.html">resume</a>
</li>
<li<%= sidebar_current("docs-commands-deployment-status") %>>
<a href="/docs/commands/deployment/status.html">status</a>
</li>
</ul>
</li>
<li<%= sidebar_current("docs-commands-eval-status") %>>
<a href="/docs/commands/eval-status.html">eval status</a>
</li>
<li<%= sidebar_current("docs-commands-job") %>>
<a href="/docs/commands/job.html">job</a>
<ul class="nav">
<li<%= sidebar_current("docs-commands-job-deployments") %>>
<a href="/docs/commands/job/deployments.html">deployments</a>
</li>
<li<%= sidebar_current("docs-commands-job-dispatch") %>>
<a href="/docs/commands/job/dispatch.html">dispatch</a>
</li>
<li<%= sidebar_current("docs-commands-job-eval") %>>
<a href="/docs/commands/job/eval.html">eval</a>
</li>
<li<%= sidebar_current("docs-commands-job-history") %>>
<a href="/docs/commands/job/history.html">history</a>
</li>
<li<%= sidebar_current("docs-commands-job-init") %>>
<a href="/docs/commands/job/init.html">init</a>
</li>
<li<%= sidebar_current("docs-commands-job-inspect") %>>
<a href="/docs/commands/job/inspect.html">inspect</a>
</li>
<li<%= sidebar_current("docs-commands-job-plan") %>>
<a href="/docs/commands/job/plan.html">plan</a>
</li>
<li<%= sidebar_current("docs-commands-job-promote") %>>
<a href="/docs/commands/job/promote.html">promote</a>
</li>
<li<%= sidebar_current("docs-commands-job-revert") %>>
<a href="/docs/commands/job/revert.html">revert</a>
</li>
<li<%= sidebar_current("docs-commands-job-run") %>>
<a href="/docs/commands/job/run.html">run</a>
</li>
<li<%= sidebar_current("docs-commands-job-status") %>>
<a href="/docs/commands/job/status.html">status</a>
</li>
<li<%= sidebar_current("docs-commands-job-stop") %>>
<a href="/docs/commands/job/stop.html">stop</a>
</li>
<li<%= sidebar_current("docs-commands-job-validate") %>>
<a href="/docs/commands/job/validate.html">validate</a>
</li>
</ul>
</li>
<li<%= sidebar_current("docs-commands-namespace") %>>
<a href="/docs/commands/namespace.html">namespace</a>
<ul class="nav">
<li<%= sidebar_current("docs-commands-namespace-apply") %>>
<a href="/docs/commands/namespace/apply.html">apply</a>
</li>
<li<%= sidebar_current("docs-commands-namespace-delete") %>>
<a href="/docs/commands/namespace/delete.html">delete</a>
</li>
<li<%= sidebar_current("docs-commands-namespace-inspect") %>>
<a href="/docs/commands/namespace/inspect.html">inspect</a>
</li>
<li<%= sidebar_current("docs-commands-namespace-list") %>>
<a href="/docs/commands/namespace/list.html">list</a>
</li>
<li<%= sidebar_current("docs-commands-namespace-status") %>>
<a href="/docs/commands/namespace/status.html">status</a>
</li>
</ul>
</li>
<li<%= sidebar_current("docs-commands-node") %>>
<a href="/docs/commands/node.html">node</a>
<ul class="nav">
<li<%= sidebar_current("docs-commands-node-config") %>>
<a href="/docs/commands/node/config.html">config</a>
</li>
<li<%= sidebar_current("docs-commands-node-drain") %>>
<a href="/docs/commands/node/drain.html">drain</a>
</li>
<li<%= sidebar_current("docs-commands-node-eligibility") %>>
<a href="/docs/commands/node/eligibility.html">eligibility</a>
</li>
<li<%= sidebar_current("docs-commands-node-status") %>>
<a href="/docs/commands/node/status.html">status</a>
</li>
</ul>
</li>
<li<%= sidebar_current("docs-commands-operator") %>>
<a href="/docs/commands/operator.html">operator</a>
<ul class="nav">
<li<%= sidebar_current("docs-commands-operator-autopilot-get-config") %>>
<a href="/docs/commands/operator/autopilot-get-config.html">autopilot get-config</a>
</li>
<li<%= sidebar_current("docs-commands-operator-autopilot-set-config") %>>
<a href="/docs/commands/operator/autopilot-set-config.html">autopilot set-config</a>
</li>
<li<%= sidebar_current("docs-commands-operator-keygen") %>>
<a href="/docs/commands/operator/keygen.html">keygen</a>
</li>
<li<%= sidebar_current("docs-commands-operator-keyring") %>>
<a href="/docs/commands/operator/keyring.html">keyring</a>
</li>
<li<%= sidebar_current("docs-commands-operator-raft-list-peers") %>>
<a href="/docs/commands/operator/raft-list-peers.html">raft list-peers</a>
</li>
<li<%= sidebar_current("docs-commands-operator-raft-remove-peer") %>>
<a href="/docs/commands/operator/raft-remove-peer.html">raft remove-peer</a>
</li>
</ul>
</li>
<li<%= sidebar_current("docs-commands-quota") %>>
<a href="/docs/commands/quota.html">quota</a>
<ul class="nav">
<li<%= sidebar_current("docs-commands-quota-apply") %>>
<a href="/docs/commands/quota/apply.html">apply</a>
</li>
<li<%= sidebar_current("docs-commands-quota-delete") %>>
<a href="/docs/commands/quota/delete.html">delete</a>
</li>
<li<%= sidebar_current("docs-commands-quota-init") %>>
<a href="/docs/commands/quota/init.html">init</a>
</li>
<li<%= sidebar_current("docs-commands-quota-inspect") %>>
<a href="/docs/commands/quota/inspect.html">inspect</a>
</li>
<li<%= sidebar_current("docs-commands-quota-list") %>>
<a href="/docs/commands/quota/list.html">list</a>
</li>
<li<%= sidebar_current("docs-commands-quota-status") %>>
<a href="/docs/commands/quota/status.html">status</a>
</li>
</ul>
</li>
<li<%= sidebar_current("docs-commands-sentinel") %>>
<a href="/docs/commands/sentinel.html">sentinel</a>
<ul class="nav">
<li<%= sidebar_current("docs-commands-sentinel-apply") %>>
<a href="/docs/commands/sentinel/apply.html">apply</a>
</li>
<li<%= sidebar_current("docs-commands-sentinel-delete") %>>
<a href="/docs/commands/sentinel/delete.html">delete</a>
</li>
<li<%= sidebar_current("docs-commands-sentinel-list") %>>
<a href="/docs/commands/sentinel/list.html">list</a>
</li>
<li<%= sidebar_current("docs-commands-sentinel-read") %>>
<a href="/docs/commands/sentinel/read.html">read</a>
</li>
</ul>
</li>
<li<%= sidebar_current("docs-commands-server") %>>
<a href="/docs/commands/server.html">server</a>
<ul class="nav">
<li<%= sidebar_current("docs-commands-server-force-leave") %>>
<a href="/docs/commands/server/force-leave.html">force-leave</a>
</li>
<li<%= sidebar_current("docs-commands-server-join") %>>
<a href="/docs/commands/server/join.html">join</a>
</li>
<li<%= sidebar_current("docs-commands-server-members") %>>
<a href="/docs/commands/server/members.html">members</a>
</li>
</ul>
</li>
<li<%= sidebar_current("docs-commands-status") %>>
<a href="/docs/commands/status.html">status</a>
</li>
<li<%= sidebar_current("docs-commands-ui") %>>
<a href="/docs/commands/ui.html">ui</a>
</li>
<li<%= sidebar_current("docs-commands-version") %>>
<a href="/docs/commands/version.html">version</a>
</li>
</ul>
</li>
<hr>
<li<%= sidebar_current("docs-job-specification") %>>
<a href="/docs/job-specification/index.html">Job Specification</a>
<ul class="nav">
<li<%= sidebar_current("docs-job-specification-artifact")%>>
<a href="/docs/job-specification/artifact.html">artifact</a>
</li>
<li<%= sidebar_current("docs-job-specification-affinity")%>>
<a href="/docs/job-specification/affinity.html">affinity
<sup>0.9 Beta</sup>
</a>
</li>
<li<%= sidebar_current("docs-job-specification-check_restart")%>>
<a href="/docs/job-specification/check_restart.html">check_restart</a>
</li>
<li<%= sidebar_current("docs-job-specification-constraint")%>>
<a href="/docs/job-specification/constraint.html">constraint</a>
</li>
<li<%= sidebar_current("docs-job-specification-device")%>>
<a href="/docs/job-specification/device.html">device</a>
</li>
<li<%= sidebar_current("docs-job-specification-dispatch-payload")%>>
<a href="/docs/job-specification/dispatch_payload.html">dispatch_payload</a>
</li>
<li<%= sidebar_current("docs-job-specification-env")%>>
<a href="/docs/job-specification/env.html">env</a>
</li>
<li<%= sidebar_current("docs-job-specification-ephemeral_disk")%>>
<a href="/docs/job-specification/ephemeral_disk.html">ephemeral_disk</a>
</li>
<li<%= sidebar_current("docs-job-specification-group")%>>
<a href="/docs/job-specification/group.html">group</a>
</li>
<li<%= sidebar_current("docs-job-specification-job")%>>
<a href="/docs/job-specification/job.html">job</a>
</li>
<li<%= sidebar_current("docs-job-specification-logs")%>>
<a href="/docs/job-specification/logs.html">logs</a>
</li>
<li<%= sidebar_current("docs-job-specification-meta")%>>
<a href="/docs/job-specification/meta.html">meta</a>
</li>
<li<%= sidebar_current("docs-job-specification-migrate")%>>
<a href="/docs/job-specification/migrate.html">migrate</a>
</li>
<li<%= sidebar_current("docs-job-specification-network")%>>
<a href="/docs/job-specification/network.html">network</a>
</li>
<li<%= sidebar_current("docs-job-specification-parameterized")%>>
<a href="/docs/job-specification/parameterized.html">parameterized</a>
</li>
<li<%= sidebar_current("docs-job-specification-periodic")%>>
<a href="/docs/job-specification/periodic.html">periodic</a>
</li>
<li<%= sidebar_current("docs-job-specification-reschedule")%>>
<a href="/docs/job-specification/reschedule.html">reschedule</a>
</li>
<li<%= sidebar_current("docs-job-specification-resources")%>>
<a href="/docs/job-specification/resources.html">resources</a>
</li>
<li<%= sidebar_current("docs-job-specification-restart")%>>
<a href="/docs/job-specification/restart.html">restart</a>
</li>
<li<%= sidebar_current("docs-job-specification-service")%>>
<a href="/docs/job-specification/service.html">service</a>
</li>
<li<%= sidebar_current("docs-job-specification-spread")%>>
<a href="/docs/job-specification/spread.html">spread
<sup>0.9 Beta</sup>
</a>
</li>
<li<%= sidebar_current("docs-job-specification-task")%>>
<a href="/docs/job-specification/task.html">task</a>
</li>
<li<%= sidebar_current("docs-job-specification-template")%>>
<a href="/docs/job-specification/template.html">template</a>
</li>
<li<%= sidebar_current("docs-job-specification-update")%>>
<a href="/docs/job-specification/update.html">update</a>
</li>
<li<%= sidebar_current("docs-job-specification-vault")%>>
<a href="/docs/job-specification/vault.html">vault</a>
</li>
</ul>
</li>
<li<%= sidebar_current("docs-drivers") %>>
<a href="/docs/drivers/index.html">Task Drivers</a>
<ul class="nav">
<li<%= sidebar_current("docs-drivers-docker") %>>
<a href="/docs/drivers/docker.html">Docker</a>
</li>
<li<%= sidebar_current("docs-drivers-exec") %>>
<a href="/docs/drivers/exec.html">Isolated Fork/Exec</a>
</li>
<li<%= sidebar_current("docs-drivers-java") %>>
<a href="/docs/drivers/java.html">Java</a>
</li>
<li<%= sidebar_current("docs-drivers-qemu") %>>
<a href="/docs/drivers/qemu.html">Qemu</a>
</li>
<li<%= sidebar_current("docs-drivers-raw-exec") %>>
<a href="/docs/drivers/raw_exec.html">Raw Fork/Exec</a>
</li>
<li<%= sidebar_current("docs-drivers-rkt") %>>
<a href="/docs/drivers/rkt.html">Rkt</a>
</li>
</ul>
</li>
<li<%= sidebar_current("docs-devices") %>>
<a href="/docs/devices/index.html">Device Plugins</a>
<ul class="nav">
<li<%= sidebar_current("docs-devices-nvidia") %>>
<a href="/docs/devices/nvidia.html">Nvidia</a>
</li>
<li<%= sidebar_current("docs-devices-community") %>>
<a href="/docs/devices/community.html">Community Supported</a>
</li>
</ul>
</li>
<li<%= sidebar_current("docs-schedulers") %>>
<a href="/docs/schedulers.html">Schedulers</a>
</li>
<li<%= sidebar_current("docs-runtime-environment") %>>
<a href="/docs/runtime/environment.html">Runtime Environment</a>
</li>
<li<%= sidebar_current("docs-telemetry") %>>
<a href="/docs/telemetry/index.html">Telemetry</a>
</li>
<li<%= sidebar_current("docs-variable-interpolation") %>>
<a href="/docs/runtime/interpolation.html">Variable Interpolation</a>
</li>
<li<%= sidebar_current("docs-vault-integration") %>>
<a href="/docs/vault-integration/index.html">Vault Integration</a>
</li>
<li<%= sidebar_current("docs-external-plugins") %>>
<a href="/docs/drivers/external/index.html">External Plugins</a>
</li>
<hr>
<li<%= sidebar_current("docs-enterprise") %>>
<a href="/docs/enterprise/index.html">Nomad Enterprise</a>
<ul class="nav">
<li<%= sidebar_current("docs-enterprise-namespaces") %>>
<a href="/docs/enterprise/namespaces/index.html">Namespaces</a>
</li>
<li<%= sidebar_current("docs-enterprise-quotas") %>>
<a href="/docs/enterprise/quotas/index.html">Resource Quotas</a>
</li>
<li<%= sidebar_current("docs-enterprise-sentinel") %>>
<a href="/docs/enterprise/sentinel/index.html">Sentinel Policies</a>
</li>
<li<%= sidebar_current("docs-enterprise-autopilot") %>>
<a href="/docs/enterprise/autopilot/index.html">Advanced Autopilot</a>
</li>
</ul>
</li>
<li<%= sidebar_current("docs-faq") %>>
<a href="/docs/faq.html">FAQ</a>
</li>
</ul>
<% end %>
<%= yield %>
<% end %>
Reference in a new issue View git blame Copy permalink