Commit graph

134 commits

Author SHA1 Message Date
Buck Doyle 7855adf127 Add documentation for job name parameter 2020-07-30 10:03:50 -05:00
Buck Doyle adada0d5b0
Fix placement invocations (#8558) 2020-07-30 09:56:58 -05:00
Drew Bailey b296558b8e
oss compoments for multi-vault namespaces
adds in oss components to support enterprise multi-vault namespace feature

upgrade specific doc on vault multi-namespaces

vault docs

update test to reflect new error
2020-07-24 10:14:59 -04:00
James Rasell 71d9c23e47
docs: clarify scaling stanza is not supported within system jobs. 2020-07-24 10:05:38 +02:00
Michael Schurter 8340ad4da8 docs: s/hearbeat/heartbeat and fix link
Also fixed the same typo in a test. Fixing the typo fixes the link, but
the link was still broken when running the website locally due to the
trailing slash. It would have worked in prod thanks to redirects, but
using the canonical URL seems ideal.
2020-07-23 11:33:34 -07:00
Nick Ethier 5167bae0d5
website: remove usage of task network stanza (#8498)
* website: remove usage of task network stanza and add documentation for group network and service stanzas

* docs: fix broken link in client config

* Update website/pages/docs/job-specification/group.mdx

Co-authored-by: Seth Hoenig <shoenig@hashicorp.com>

* Update website/pages/docs/job-specification/group.mdx

Co-authored-by: Seth Hoenig <shoenig@hashicorp.com>

Co-authored-by: Seth Hoenig <shoenig@hashicorp.com>
2020-07-23 09:18:59 -04:00
Charlie Voiselle baaab98a0d
[docs] Reschedule does happen during deployments 2020-07-14 16:29:30 -04:00
Michael Schurter 64e81f0549
Merge pull request #7042 from hashicorp/docs-healthy-deadline
docs: clarify healthy/progress_deadline relationship
2020-07-13 08:40:11 -07:00
Seth Hoenig 61b1aa5775
Merge pull request #8417 from hashicorp/docs-docker-kill-signal
docs: clarify kill_signal default for docker
2020-07-10 11:50:21 -05:00
Seth Hoenig 21a74b4bd4 docs: clarify kill_signal default for docker
Before docker, the only default was `SIGINT` for `kill_signal`. The
docker driver however defaults to `SIGTERM`, and we should document
as such.

Fixes #7140
2020-07-10 09:57:49 -05:00
James Rasell d517c2e1d5
docs: fix minor incorrect syntax in autoscaling plugin docs.
This changes fixes a syntax error in the autoscaling apm plugin
docs as well as updates the scaling stanza doc. The stazna wording
implied its use was only for external autoscalers, whereas it also
is used by the UI.
2020-07-10 16:07:29 +02:00
Nick Ethier 119ece09a0
docs: add CNI and host_network docs (#8391)
Co-authored-by: Seth Hoenig <shoenig@hashicorp.com>
2020-07-08 15:45:04 -04:00
Seth Hoenig 1a75da0ce0 consul/connect: infer task name in service if possible
Before, the service definition for a Connect Native service would always
require setting the `service.task` parameter. Now, that parameter is
automatically inferred when there is only one task in the task group.

Fixes #8274
2020-07-08 13:31:44 -05:00
Tim Gross c74d820ae1
docs: note MRD is beta and removing regions doesn't work (#8370) 2020-07-06 16:02:10 -04:00
Chris Baker 64feb9aacf added scaling->min default discussion to group->count documentation 2020-07-04 18:33:19 +00:00
Michael Schurter d2a4e0557d docs: clarify healthy/progress_deadline relationship
Validation code already enforces this, but I think documenting it makes
it more immediately clear how the 2 settings interact.
2020-06-26 09:02:32 -04:00
Tim Gross d1f3c40098
docs: spellcheck fix for multiregion (#8286) 2020-06-25 12:56:40 -04:00
Seth Hoenig 3872b493e5
Merge pull request #8011 from hashicorp/f-cnative-host
consul/connect: implement initial support for connect native
2020-06-24 10:33:12 -05:00
Seth Hoenig 011c6b027f connect/native: doc and comment tweaks from PR 2020-06-24 10:13:22 -05:00
Jeff Escalante 6a1e059ff4
Dependency updates and improvements 2020-06-23 17:43:43 -04:00
Seth Hoenig 6c5ab7f45e consul/connect: split connect native flag and task in service 2020-06-23 10:22:22 -05:00
Mahmood Ali d30a7c3e37
Merge pull request #8031 from BijanJohn/reschedule_delay_requirement
add notes about delay requirement for reschedule
2020-06-23 08:39:03 -04:00
Seth Hoenig 4d71f22a11 consul/connect: add support for running connect native tasks
This PR adds the capability of running Connect Native Tasks on Nomad,
particularly when TLS and ACLs are enabled on Consul.

The `connect` stanza now includes a `native` parameter, which can be
set to the name of task that backs the Connect Native Consul service.

There is a new Client configuration parameter for the `consul` stanza
called `share_ssl`. Like `allow_unauthenticated` the default value is
true, but recommended to be disabled in production environments. When
enabled, the Nomad Client's Consul TLS information is shared with
Connect Native tasks through the normal Consul environment variables.
This does NOT include auth or token information.

If Consul ACLs are enabled, Service Identity Tokens are automatically
and injected into the Connect Native task through the CONSUL_HTTP_TOKEN
environment variable.

Any of the automatically set environment variables can be overridden by
the Connect Native task using the `env` stanza.

Fixes #6083
2020-06-22 14:07:44 -05:00
Tim Gross 2e2d9ad5ae
docs: fix for multiregion count explanation (#8202) 2020-06-19 07:52:58 -04:00
Nick Ethier 0bc0403cc3 Task DNS Options (#7661)
Co-Authored-By: Tim Gross <tgross@hashicorp.com>
Co-Authored-By: Seth Hoenig <shoenig@hashicorp.com>
2020-06-18 11:01:31 -07:00
Tim Gross 63ae10f0d0
docs: multiregion deployment feature (#8185) 2020-06-18 08:41:22 -04:00
Seth Hoenig 006dca2418 docs: update cronexpr github link 2020-06-15 08:48:32 -05:00
G cb07ba7b64
docs: static port incorrectly declared as a string (#8046)
static attribute of the port stanza is supposed to be an integer but is incorrectly declared as a string in the example.
2020-05-26 08:51:16 -04:00
BijanJohn d2a0d0d0cc add notes about delay requirement for reschedule 2020-05-20 11:57:12 -05:00
Tim Gross 4b4bf84d79
docs: notice to operators about script check timeouts (#8015)
The tasklet passes the timeout for the script check into the task
driver's `Exec`, and its up to the task driver to enforce that via a
golang `context.WithDeadline`. In practice, this deadline is started
before the task driver starts setting up the execution
environment (because we need it to do things like timeout Docker API
calls).

Under even moderate load, the time it takes to set up the execution
context for the script check regularly exceeds a full second or
two. This can cause script checks to unexpected timeout or even never
execute if the context expires before the task driver ever gets a
chance to `execve`.

This changeset adds a notice to operators about setting script check
timeouts with plenty of padding and what to monitor for problems.
2020-05-20 10:28:14 -04:00
Jeff Escalante 636f174f48
fix shell-session snippet error 2020-05-18 16:53:06 -04:00
Chris Baker 61abbf8d4c
Merge pull request #7950 from hashicorp/docs-dst
docs: clarify periodic dst behavior
2020-05-13 15:44:41 -05:00
Tim Gross 7249e56fce
docs for stop_on_client_disconnect stanza (#7938) 2020-05-13 16:39:24 -04:00
Michael Schurter f9067fe03c docs: clarify periodic dst behavior 2020-05-13 13:24:35 -07:00
Mahmood Ali c2e80386f0 document daylight saving change 2020-05-13 08:21:19 -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
Jeff Escalante c1ad6b0862 fix some highlighting issues 2020-05-06 16:12:34 -04:00
Tim Gross e7e9c83aa3
website: fix path for spellchecking and correct errors (#7790) 2020-04-23 10:38:08 -04:00
Charles Z e4a669598e
label csi as beta from 0.11 release notes (#7745) 2020-04-20 08:48:04 -04: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 6cfecc6d03 docs: fix link to envoy proxy documentation on consul site 2020-04-09 13:46:59 -06: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
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
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
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
Charlie Voiselle 4e4fbbebdd fix search and replace error 2020-03-27 11:39:03 -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 2328e3dcac link-fixup; move navigation 2020-03-26 19:26:38 -04:00
Jeff Escalante 78a9d7b856
Anchor Link Fixes (#7287) 2020-03-26 16:21:24 -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
Chris Baker 83c60e55ab added documentation for scaling stanza 2020-03-24 22:36:27 +00: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
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
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
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
Alex Dadgar 7a22169c85 Document service lifecycle 2020-02-19 09:30:07 -05: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
Jeff Escalante 6c8f079d24
new website 2020-02-06 18:45:31 -05:00