Commit graph

403 commits

Author SHA1 Message Date
Mahmood Ali 130d8d36e7 update docs 2020-05-12 11:07:12 -04:00
Mahmood Ali 54565e3836
Apply suggestions from code review
Co-authored-by: Tim Gross <tgross@hashicorp.com>
2020-05-12 10:56:47 -04:00
Tim Gross 4374c1a837
csi: support Secrets parameter in CSI RPCs (#7923)
CSI plugins can require credentials for some publishing and
unpublishing workflow RPCs. Secrets are configured at the time of
volume registration, stored in the volume struct, and then passed
around as an opaque map by Nomad to the plugins.
2020-05-11 17:12:51 -04:00
Mahmood Ali 061a439f2c
Merge pull request #7912 from hashicorp/f-scheduler-algorithm-followup
Scheduler Algorithm Defaults handling and docs
2020-05-11 09:30:58 -04:00
Tim Gross 3aa761b151
Periodic GC for volume claims (#7881)
This changeset implements a periodic garbage collection of CSI volumes
with missing allocations. This can happen in a scenario where a node
update fails partially and the allocation updates are written to raft
but the evaluations to GC the volumes are dropped. This feature will
cover this edge case and ensure that upgrades from 0.11.0 and 0.11.1
get any stray claims cleaned up.
2020-05-11 08:20:50 -04:00
Mahmood Ali cb39226332 Document scheduler algorithm 2020-05-09 12:12:38 -04:00
Seth Hoenig 0235b23709
Merge pull request #7891 from hashicorp/docs-improve-connect-examples
docs: improve some connect examples
2020-05-08 09:50:31 -06:00
Tim Gross 298f67dca3
volume_mount doc tweak (#7900) 2020-05-08 11:14:16 -04:00
Seth Hoenig b28a26bfe3 docs: replace use of test/test with runnable examples
A few connect examples reference a fake 'test/test' image.
By replacing those with `hashicorpnomad/counter-api` we can
turn them into runnable examples.
2020-05-07 14:16:27 -06:00
Seth Hoenig b4c56293fe docs: fix misspelling of countdash example 2020-05-07 14:00:00 -06:00
Seth Hoenig 20d7a76d2c docs: mention Connect ACLs guide in jobspec connect docs
Promote the Connect ACLs guide on the jobspec connect stanza docs
page. This was suggested in a ticket after someone got stuck not
realizing they needed to enable Consul Intentions for their connect
enabled services, which is covered in the guide.
2020-05-07 13:53:22 -06:00
Seth Hoenig 2de039d570 docs: update examples for connect jobspec docs
Replace the existing top example with something that is directly
runnable on a `-dev-connect` nomad setup.

Add the _complete_ `countdash` example at the bottom in the
examples section, so that people do not need to go guide-hunting
to find a complete example. The hope is people will see more
runnable examples and be less afraid of connect.
2020-05-07 13:45:13 -06:00
Seth Hoenig b82e75c347 docs: improve connect expose path examples
This change replaces the top example for expose path configuration with
two new runnable examples. Users should be able to copy and paste those
jobs into a job file and run them against a basic connect enabled nomad
setup.

The example presented first demonstrates use of the service check expose
parameter with no dynamic port explicitly defined (new to 0.11.2).
This is expected to be the "90%" use case of users, and so we should
try to emphasise this pattern as best practice.

The example presented second demonstrates achieving the same goal as the
first exmaple, but utilizing the full plumbing available through the
`connect.proxy.expose` stanza. This should help readers comprehend what
is happening "under the hood".
2020-05-07 11:03:37 -06:00
Tim Gross 801ebcfe8d
periodic GC for CSI plugins (#7878)
This changeset implements a periodic garbage collection of unused CSI
plugins. Plugins are self-cleaning when the last allocation for a
plugin is stopped, but this feature will cover any missing edge cases
and ensure that upgrades from 0.11.0 and 0.11.1 get any stray plugins
cleaned up.
2020-05-06 16:49:12 -04:00
Jeff Escalante c1ad6b0862 fix some highlighting issues 2020-05-06 16:12:34 -04:00
Charlie Voiselle 7f9c0a1367
Fix version typo 2020-05-05 12:15:24 -04:00
Denis Palashevskiy 4095860116
Fix URL schema in drain documentation 2020-05-03 20:50:40 +04:00
Michael Schurter c901d0e7dd
Merge branch 'master' into b-reserved-scoring 2020-04-30 14:48:14 -07:00
Michael Schurter 439a9f7301
Update website/pages/docs/upgrade/upgrade-specific.mdx
Co-authored-by: Alex Dadgar <alex@hashicorp.com>
2020-04-30 14:47:12 -07:00
Charlie Voiselle f1ababc31b
Update docker.mdx 2020-04-24 23:20:02 -04:00
Michael Schurter 11c6a6e81c docs: mention scoring change from #7730 2020-04-23 14:51:34 -07:00
Tim Gross e7e9c83aa3
website: fix path for spellchecking and correct errors (#7790) 2020-04-23 10:38:08 -04:00
Seth Hoenig 3d16d56fbb
Merge pull request #7705 from hashicorp/docs-remove-connect-limitation
fixup references in connect docs
2020-04-20 10:15:50 -06:00
Charles Z e4a669598e
label csi as beta from 0.11 release notes (#7745) 2020-04-20 08:48:04 -04:00
James Rasell 59cee57396
docs: update Datadog agent telemetry link to rewritten version.
The Datadog agent was rewritten in Go from version 6. This means
the codebase resides in a new GitHub repository. This change
updates the Nomad telemetry configuration documentation to point
to the latest repo.
2020-04-20 09:56:04 +02:00
Jeffrey 'jf' Lim eab600d3e1
Fix/improve "job plan" messaging (#7580) 2020-04-17 15:53:16 -04:00
Yishan Lin b95309dc4b docs: update preemption page
This page has not been updated (yet) to reflect that support for all 3 job types (service, batch, system) which shipped in 0.9.2.

The current page implies that preemption is only available for system jobs.

This is early preparation for Nomad 0.12, where we plan to move Preemption from Enterprise feature suite to OSS for all.
2020-04-17 09:34:07 -07:00
Chris Baker a6e0d17433
update restart documentation (#7603)
* update `restart` documentation

#7288 added support for task-specific `restart` policy. this PR updates the docs to reflect that.

* added an explicit example of task-specific restart policy

* Update website/pages/docs/job-specification/restart.mdx
2020-04-13 16:29:43 -05:00
Seth Hoenig 07ccebca71 docs: add a link to the Connect w/ACLs guide
... from the docs/integration/consul-connect page.
2020-04-13 10:05:20 -06:00
Seth Hoenig a35a64b6bd docs: update connect limitations (acls & checks now supported) 2020-04-13 09:51:17 -06:00
Seth Hoenig 6cfecc6d03 docs: fix link to envoy proxy documentation on consul site 2020-04-09 13:46:59 -06:00
Mahmood Ali 2ef4ce04bb
change tense
Co-Authored-By: Chris Baker <1675087+cgbaker@users.noreply.github.com>
2020-04-08 07:59:11 -04:00
Mahmood Ali fa4a6f7052 docs: move rkt to external drivers 2020-04-07 23:13:16 -04:00
Michael Schurter 34581070f8 docs: remove 0.11 from scaling docs
Keep beta label for now.
2020-04-07 11:22:13 -07:00
Michael Schurter 75018847ec docs: remove beta marker from lifecycle 2020-04-07 11:22:04 -07:00
Michael Schurter fa9bf43cad
Update website/pages/docs/upgrade/upgrade-specific.mdx
Co-Authored-By: Buck Doyle <buck@hashicorp.com>
2020-04-07 11:08:40 -07:00
Michael Schurter a338597ec1 docs: update changelog/upgrade for 0.11.0 2020-04-07 10:32:23 -07:00
Charles Z 42e1070aa4
Fix wrong title in sidecar_task stanza docs (#7335) 2020-04-07 08:28:30 -04:00
Spencer Owen 51741f7aad
Improve vault language (#7644) 2020-04-07 07:54:25 -04:00
Tim Gross caa258b924
docs: add warnings for CSI plugin jobspec (#7642)
* Node/monolith plugins require root privileges and this wasn't being
  made super clear.
* Node/monolith plugins should always be run as system jobs.
2020-04-07 07:51:50 -04:00
Tim Gross 0a9b32e94e
docs: fix broken internal link on job plan page (#7640) 2020-04-06 16:39:11 -04:00
Drew Bailey 71b687e7d8
add note about query params for filtering 2020-04-06 13:07:38 -04:00
Ben Buzbee 769a3cd8b3 Rename OCIRuntime to Runtime; allow gpu conflicts is they are the same runtime; add conflict test 2020-04-03 12:15:11 -07:00
Ben Buzbee d4f26d1eee Support custom docker runtimes
This enables customers who want to use gvisor and have it configured on their clients.
2020-04-03 11:07:37 -07:00
Drew Bailey d55a10203b
Update website/pages/docs/configuration/audit.mdx
Co-Authored-By: Mahmood Ali <mahmood@hashicorp.com>
2020-04-03 08:53:38 -04:00
Drew Bailey ba5908d12f
make placement of filter and sinks stanzas clearer 2020-04-03 08:43:05 -04:00
Seth Hoenig f7ef64d264
Merge pull request #7440 from hashicorp/docs-connect-expose
docs: add documentation for proxy.expose configuration
2020-04-02 16:51:24 -06:00
Seth Hoenig 9a79b182b7 docs: add exposed TG service check examples to expose docs 2020-04-02 16:42:38 -06:00
Tim Gross 34348708ac
csi: internals docs (#7522)
Summarizes the internal RFCs for plugins and volume lifecycles.
2020-04-02 16:05:26 -04:00
Nick Ethier 92f8bfc729 connect: set task lifecycle config for injected sidecar task
fixes #7593
2020-04-01 21:19:41 -04:00
Charlie Voiselle 860dda2891
Merge pull request #7561 from hashicorp/docs-link2tdguide
[docs] Adding link to learn track
2020-04-01 17:53:18 -04:00
Seth Hoenig 9b6323e467 docs: add documentation for proxy.expose configuration
This changeset adds documentation changes for the new
`proxy.expose` stanza as well as the `check.expose` parameter.

The examples are centered around proposed changes for the "countdash"
`dashboard-service` in [demo-consul-101](github.com/hashicorp/demo-consul-101/pull/6).
The dashboard service will now serve two additonal endpoints

- `/health/api`
- `/metrics`

which should serve nicely as expose-able paths.
2020-04-01 08:19:21 -06:00
Zack Smith c1f67395aa Fix syntax error in docs
Prior to this commit, the HCL syntax was invalid. This commit adds a `,`
to make the example pass syntax checks.
2020-03-31 14:32:23 -07:00
Charlie Voiselle 0275177d5f
Shortening Learn CTA sentence. 2020-03-31 13:24:27 -04:00
Charlie Voiselle 6600a59a75 Adding link to learn track 2020-03-31 10:34:28 -04:00
Drew Bailey d148f35e5c
add a globbed example 2020-03-30 10:25:23 -04:00
Drew Bailey a98dc8c768
update audit examples to an endpoint that is audited 2020-03-30 10:03:11 -04:00
Charlie Voiselle 4f71d9d4d3
Merge pull request #7503 from hashicorp/docs-system-no-deploy
[docs] System scheduler doesn't do deployments.
2020-03-27 19:24:13 -04:00
Michael Schurter e7812acde2 docs: improve wording of linux requirement 2020-03-27 13:56:37 -07:00
Charlie Voiselle fe8c7fa1d0
Merge pull request #7517 from hashicorp/docs-sunset-guides
Sunset /guide folder; Fix links
2020-03-27 15:27:16 -04:00
Charlie Voiselle 4e4fbbebdd fix search and replace error 2020-03-27 11:39:03 -04:00
Drew Bailey a66b4be0f3
remove auditing for /ui/ 2020-03-27 10:12:42 -04:00
Charlie Voiselle 169a6f2ba2 Fixed pages with new changes 2020-03-26 19:58:26 -04:00
Charlie Voiselle a72208eebe more links
(cherry picked from commit 0e39e2e49b0371c246dc1a9b4bb20af0b2f642a0)
2020-03-26 19:27:55 -04:00
Charlie Voiselle 4b580df670 fixing links
(cherry picked from commit 575f22e970e2429b8f9871f11b8c3e0924c82dc2)
2020-03-26 19:27:05 -04:00
Charlie Voiselle e1e1dab5fe correcting layout for reparented pages
(cherry picked from commit ce9d9b5e69fe5f47847cc511ffd73f6b43de92e7)
2020-03-26 19:26:52 -04:00
Charlie Voiselle 2328e3dcac link-fixup; move navigation 2020-03-26 19:26:38 -04:00
Charlie Voiselle 0aaca7d969 Removing guide folder
reparented some elements to docs.

(cherry picked from commit 4fa35e51e0e0d193bf81f4465f4e1ba4caa5b3ca)
2020-03-26 19:20:39 -04:00
Jeff Escalante 78a9d7b856
Anchor Link Fixes (#7287) 2020-03-26 16:21:24 -04:00
Charlie Voiselle 9f2f448fb8
Update schedulers.mdx 2020-03-25 20:10:53 -04:00
Jasmine Dahilig 719d68698a
docs: add beta tag to lifecycle stanza (#7496) 2020-03-25 10:30:44 -07:00
Jasmine Dahilig c063e84129
docs: lifecycle stanza (#7493) 2020-03-25 09:57:53 -07:00
Mahmood Ali 28b951be81
Merge pull request #7478 from hashicorp/docs-scaling-api
docs: nomad scaling policy api
2020-03-25 12:50:56 -04:00
Drew Bailey e3a449bbee
fix typo 2020-03-24 19:48:29 -04:00
Drew Bailey ec2fd3329c
update enterprise audit blurb 2020-03-24 19:42:02 -04:00
Chris Baker 83c60e55ab added documentation for scaling stanza 2020-03-24 22:36:27 +00:00
Drew Bailey 4b74084aba
enterprise index page update 2020-03-24 14:22:37 -04:00
Drew Bailey 2f5e77dba4
Audit logging documentation
docs for audit logging

enterprise only note

enterprise page audit blurb

add audit to sidebar

add general options audit info

fix name for docs-navigation

link to docs

more docs

add audit log entry examples

fix audit link

clean up audit log docs
2020-03-24 14:20:27 -04:00
Tim Gross 4ef4a604c2
Documentation for CSI command line and jobspec (#7439)
Includes:

* changes `nomad alloc status` and `nomad node status`
* changes to `volume` block in jobspec
* new `csi_plugin` block in jobspec
* new `nomad volume register/deregister/status` commands
* new `nomad plugin status` command
2020-03-24 11:09:46 -04:00
James Rasell 1e4b534473
Merge pull request #7313 from hashicorp/docs-gh-7294
docs: explicitly detail IAM instance profile S3 artifact auth.
2020-03-18 15:43:41 +01:00
Michael Schurter 0b162dea7b docs: add some links to the acl guide
ACL APIs already have osme links, but the command and configuration
pages did not.
2020-03-13 10:16:01 -07:00
Jeff Escalante 77e6ad8867 Revert "Merge pull request #7322 from hashicorp/docs-fix-guide-links"
This reverts commit 4311f5e95657a2eb7b231daf326af252e6c75ae7, reversing
changes made to 5d5469e6facfc4ab59235d5532664bb95a597728.
2020-03-12 18:18:14 -04:00
Charlie Voiselle e1f6cf4734 Working on "/guides" links 2020-03-12 15:46:39 -04:00
Michael Schurter ca9f92fb18
Merge pull request #7226 from hashicorp/daneharrigan-patch-1
Fix rendered backslash in group "<required>"
2020-03-11 13:27:43 -07:00
James Rasell 3354a2665b
docs: explicitly detail IAM instance profile S3 artifact auth.
Previously the S3 artifact documentation only referenced using
options populated with access credentails when pulling from a
bucket that required authentication. This change upadtes the doc
to also detail using IAM instance profiles.
2020-03-11 12:55:37 +01:00
Michael Schurter b72b3e765c
Merge pull request #7170 from fredrikhgrelland/consul_template_upgrade
Update consul-template to v0.24.1 and remove deprecated vault grace
2020-03-10 14:15:47 -07:00
JanMa df1ee5b4d1 fix page layout settings 2020-02-29 18:07:15 +01:00
Jan Martens 5e082c7ac3 docs: add nspawn as external task driver plugin 2020-02-29 17:52:06 +01:00
Dane Harrigan 84f8ac8656
Fix rendered backslash in group "<required>"
The `<require>` tag contained backslashes and the first backslash was getting rendered. See on live site: https://nomadproject.io/docs/job-specification/job/#inlinecode-group-7
2020-02-25 19:22:30 -08:00
Fredrik Hoem Grelland edb3bd0f3f Update consul-template to v0.24.1 and remove deprecated vault_grace (#7170) 2020-02-23 16:24:53 +01:00
Michael Schurter d3a9ab3a79
Merge pull request #7083 from hashicorp/d-service-lifecycle
Document service lifecycle
2020-02-20 14:56:17 -08:00
Mahmood Ali 07943f95a4
Merge pull request #7149 from th0m/tlefebvre/no-pivot-root
client: support no_pivot_root in exec driver configuration
2020-02-19 12:18:51 -06:00
Michael Schurter 4d8de5eda1 docs: mention group service registration
A few minor tweaks and cleanups as well.
2020-02-19 08:29:58 -08:00
Kyle MacDonald 6be8cb2090 website: indent mode bullets in network params 2020-02-19 11:16:00 -05:00
Seth Hoenig 5c0971cd10
Merge pull request #7146 from hashicorp/doc-fix-cht-references
docs: fix references to consul environment variable
2020-02-19 08:41:07 -06:00
Seth Hoenig e0a4036651
Merge pull request #7143 from hashicorp/doc-cht-filtering
docs: upgrade-specific notes on CHT filtering
2020-02-19 08:40:15 -06:00
Alex Dadgar 7a22169c85 Document service lifecycle 2020-02-19 09:30:07 -05:00
Thomas Lefebvre 84baa950ce client: support no_pivot_root in exec driver configuration 2020-02-18 09:27:16 -08:00
Seth Hoenig 217a78f1b5 docs: document enable_tag_override field for service stanzas 2020-02-13 13:23:51 -06:00
Seth Hoenig 938f00ca60 docs: fix references to consul environment variable
We mistakenly reference `CONSUL_TOKEN` where we should be using `CONSUL_HTTP_TOKEN`.
There is one case where `CONSUL_TOKEN` is correct - client.mdx there is a list of
default filtered environment variables, which for legacy reasons `CONSUL_TOKEN` will
always be one.
2020-02-13 10:02:36 -06:00
Seth Hoenig 6b9fd8d269 docs: upgrade-specific notes on CHT filtering 2020-02-13 09:44:47 -06:00
Jeff Escalante 569bead286
fix a couple more links 2020-02-10 14:20:59 -05:00
Jeff Escalante 6c8f079d24
new website 2020-02-06 18:45:31 -05:00