Commit graph

474 commits

Author SHA1 Message Date
Shishir a1b5c60bce
Update containerd task driver docs. (#9550) 2020-12-07 16:51:19 -05:00
Mark Lewis 80a3b87ec7
docs: grammatical fixes in service jobspec 2020-12-07 15:41:44 -05:00
Mahmood Ali d0495e1b56
document some hcl2 quarks (#9545)
Mainly note that block labels need to be string literals, and that decimals without a leading significant digits aren't acceptable anymore (e.g. .9 are required to be 0.9).

Dynamic blocks can be used here, but feels too much of a hack, or a hammer to highlight it here, specially given the error reporting and debugging isn't so straightforward. I'd advocate internally for relaxing the restriction and allowing expressions in block labels instead.

Related to https://github.com/hashicorp/nomad/issues/9522
2020-12-07 12:31:25 -05:00
Luiz Aoqui 20796e5815
docs: update autoscaling docs for the new query interface (#8917)
* update autoscaling docs for the new query interface
* update default value for query_window in scaling policy
2020-12-07 10:43:08 -05:00
Seth Hoenig 07568b6a7e docs: note conflist extension for cni plugin configuration files 2020-12-07 09:36:39 -06:00
Michael Schurter eb56a75bdd docs: may->will after confirming with Consul
Consul 1.9 switched to agentless intentions which no longer require
synchronous communication from Envoy to Consul.
2020-12-03 13:48:06 -08:00
Michael Schurter e948e0a012 docs: clarify connect upgrade procedure
During testing we discovered old versions of Nomad and Consul seemed to
prevent Envoy from accepting new connections while the Nomad agent was
being upgraded.
2020-12-03 13:36:13 -08:00
Seth Hoenig 4398511c04 docs: fix link to windows docker issues 2020-12-03 09:19:22 -06:00
Charlie Voiselle 7d37cd3f53
Small website updates (#9504)
* systemd should be downcased
* containerd should be downcased
* spellchecking, adjust list item spacing
* QEMU should be upcased
* spelling, it's->its
* Fewer exclamation points; drive-by list spacing
* Update website/pages/docs/internals/security.mdx
* Namespace is not ent only now.
Co-authored-by: Tim Gross <tgross@hashicorp.com>
2020-12-02 19:02:03 -05:00
Chris Baker 4b31759ef0 formatting fix from github-based commit 2020-12-02 22:25:36 +00:00
Chris Baker a9c151be2c
Update website/pages/docs/job-specification/hcl2/index.mdx
Co-authored-by: Michael Schurter <mschurter@hashicorp.com>
2020-12-02 16:12:07 -06:00
Chris Baker e1010c9227 added some discussion of HCL parsing context 2020-12-02 20:41:53 +00:00
Tim Gross 74b8375fc9
docs: using interpolation for volumes (#9449)
Expand `volume` and `volume_mount` sections to describe how to use HCL2
dynamic blocks and interpolation to have finer-grained control over how
allocations get volumes.
2020-12-02 08:57:47 -05:00
Seth Hoenig 3b2b083cbf
Merge pull request #9487 from hashicorp/f-connect-sidecar-concurrency
consul/connect: default envoy concurrency to 1
2020-12-01 15:51:41 -06:00
Michael Schurter 8ed8d9f786
Merge pull request #9485 from hashicorp/docs-check-restart
docs: check_restart is broken for group networks
2020-12-01 11:39:45 -08:00
Seth Hoenig bf857684d1 consul/connect: default envoy concurrency to 1
Previously, every Envoy Connect sidecar would spawn as many worker
threads as logical CPU cores. That is Envoy's default behavior when
`--concurrency` is not explicitly set. Nomad now sets the concurrency
flag to 1, which is sensible for the default cpu = 250 Mhz resources
allocated for sidecar proxies. The concurrency value can be configured
in Client configuration by setting `meta.connect.proxy_concurrency`.

Closes #9341
2020-12-01 13:12:45 -06:00
Tim Gross 180d6c7ef5
docs: move agent lifecycle doc under Operations heading (#9411) 2020-12-01 11:55:08 -05:00
Michael Schurter c087a1d46f docs: check_restart is broken for group networks
Add a warning about check_restart being limited to task networks and
link to the relevant issue: #9176.
2020-12-01 08:52:00 -08:00
Tim Gross 154e62fd3b
docs: warn about Docker auth_soft_fail behavior
If Docker auth helpers are used but aith fails or the image isn't found, we
hard fail the task. Users may set `auth_soft_fail` to fallback to the public
Docker Hub on a per-job basis. But users that mix public and private images
have to set `auth_soft_fail=true` for every job using a public image if Docker
auth helpers are used.
2020-12-01 09:05:35 -05:00
Mark Lewis ec8361fab9 Update proxy.mdx 2020-12-01 08:26:32 -05:00
Mark Lewis 894851a756 Update reschedule.mdx 2020-12-01 08:26:12 -05:00
Mark Lewis 523dad369b Update restart.mdx 2020-12-01 08:22:13 -05:00
Drew Bailey a0b7f05a7b
Remove Managed Sinks from Nomad (#9470)
* Remove Managed Sinks from Nomad

Managed Sinks were a beta feature in Nomad 1.0-beta2. During the beta
period it was determined that this was not a scalable approach to
support community and third party sinks.

* update comment

* changelog
2020-11-30 14:00:31 -05:00
Seth Hoenig fa6789a087
Merge pull request #9472 from hashicorp/f-connect-upstream-datacenter
consul/connect: enable setting datacenter in upstream
2020-11-30 12:29:05 -06:00
Seth Hoenig d38cd5268a docs: better clarify connect upstream datacenter 2020-11-30 12:28:08 -06:00
Seth Hoenig e81e9223ef consul/connect: enable setting datacenter in connect upstream
Before, upstreams could only be defined using the default datacenter.
Now, the `datacenter` field can be set in a connect upstream definition,
informing consul of the desire for an instance of the upstream service
in the specified datacenter. The field is optional and continues to
default to the local datacenter.

Closes #8964
2020-11-30 10:38:30 -06:00
Mark Lewis 338e8995e6
Update migrate.mdx 2020-11-30 10:35:25 -05:00
Mahmood Ali 7a629b7da9
docs: add sidebar title for cidrsubnets (#9469) 2020-11-30 10:34:51 -05:00
Seth Hoenig 49fd063324 docs: spell preceding the normal way 2020-11-30 09:29:24 -06:00
Mark Lewis 6334ad1b42 Update network.mdx 2020-11-30 08:53:17 -05:00
Mahmood Ali d1e139c3fb
Docs for HCL2 (#9322)
Add more detailed HCL2 docs, mostly lifted from Packer with tweaks for Nomad.

The function docs are basically verbatim taken from Packer with basic string substitutions. I commented out some for_each details as the examples are mostly driven towards Packer resources. I'll iterate on those with better Nomad examples.
2020-11-29 20:36:41 -05:00
James Rasell 1776047e6b
Merge pull request #9459 from hashicorp/ml4-patch-3
Update ephemeral_disk.mdx
2020-11-27 11:56:22 +01:00
James Rasell 1779d5f89c
Merge pull request #9460 from hashicorp/ml4-patch-4
Update group.mdx
2020-11-27 11:44:01 +01:00
James Rasell 4e378bb3f8
Merge pull request #9458 from hashicorp/ml4-patch-2-1
Update device.mdx
2020-11-27 11:36:02 +01:00
Mark Lewis 385a06d8e0
Update group.mdx
Typo
2020-11-27 07:37:44 +00:00
Mark Lewis fa3a5e5a7d
Update ephemeral_disk.mdx
Document says size is an `int`, but snippet shows string type.
2020-11-27 07:16:01 +00:00
Mark Lewis d5bfcba1fd
Update device.mdx
Fixed typos
2020-11-27 07:10:04 +00:00
Mark Lewis 1ac9d1c2bb
Update csi_plugin.mdx
typo
2020-11-27 06:56:13 +00:00
Tim Gross b9842c32c1 docs: enumerate required cgroups for exec driver 2020-11-25 09:41:37 -05:00
Nick Ethier 7266376ae6 nomad: update validate to check group networks for task port usage 2020-11-23 10:11:00 -06:00
Nick Ethier 8efa3c355a website: add mbits field back to network docs with notice 2020-11-23 10:11:00 -06:00
Nick Ethier c4ddb0a43a website: add mbits and network deprecation notice 2020-11-23 10:09:36 -06:00
Luiz Aoqui 26913da7c0
Merge pull request #9427 from hashicorp/docs-fix-cpu-allocated-unit
docs: fix nomad.client.allocs.cpu.allocated metric unit
2020-11-23 10:31:05 -05:00
Luiz Aoqui f50740a66b
docs: fix nomad.client.allocs.cpu.allocated metric unit 2020-11-23 10:25:15 -05:00
Tim Gross b844aeabae docs: template signal change_mode not compatible with env
Only `change_mode = "restart"` will result in the template environment
variables being updated in the task. Clarify the behavior of the unsupported
options.
2020-11-23 10:11:03 -05:00
Tim Gross 38120123c5
docs: add missing command documentation (#9415)
* `nomad operator keyring` was missing the general options section
* `nomad operator metrics` was missing a page in the docs entirely

Co-authored-by: Luiz Aoqui <luiz@hashicorp.com>
2020-11-23 08:10:10 -05:00
Tim Gross f1ad512986 docs: describe required ACLs for all commands 2020-11-20 13:38:29 -05:00
Tim Gross 6cc5c40cdb docs: clarify default signal for raw_exec on Windows 2020-11-20 13:25:48 -05:00
Michael Schurter d8e3adfad9
Merge pull request #9407 from hashicorp/docs-0129-backports
Add backports to changelog and 0.12.9 to website
2020-11-20 09:09:47 -08:00
Tim Gross 4331e86e8e docs: move telemetry under operations
Create a new "Operating Nomad" section of the docs where we can put reference
material for operators that doesn't quite fit in either configuration file /
command line documentation or a step-by-step Learn Guide. Pre-populate this
with the existing telemetry docs and some links out to the Learn Guide
sections.
2020-11-20 11:05:27 -05:00
Michael Schurter 876144302a docs: avoid the regression in 0.12.[78]
The suggest version, 0.12.7, includes regressions that are best avoided
so steer users to 0.12.9.
2020-11-19 14:32:59 -08:00
Michael Schurter 0cd73b44e9 docs: add task_token_ttl default
See
https://github.com/hashicorp/nomad/blob/v0.12.7/nomad/vault.go#L36-L39
2020-11-19 16:14:25 -05:00
Tim Gross 716451b793 docs: template behavior warnings
* vault secrets named with `-` characters cannot be read by `consul-template`
  due to limitations in golang's template rendering engine.
* environment variables are not modified in running tasks if
`change_mode.noop` is set.
2020-11-19 16:06:48 -05:00
Tim Gross c1a3496a55 docs: remove -namespace option from commands when not applicable 2020-11-19 16:06:28 -05:00
Tim Gross d67afa2e21 docs/help: -no-color does not apply to alloc logs content
The `nomad alloc logs` command does not remove terminal escape sequences for
color from the log outputs of a task. Clarify that the standard `-no-color`
flag, which does apply to Nomad's error responses from `nomad alloc logs`,
does not apply to the log output.
2020-11-19 15:29:12 -05:00
Tim Gross 9788a514a0 docs: fix some markdown escaping errors 2020-11-19 14:11:53 -05:00
Tim Gross 47ce5ff471 docs: expand artifact getter options
Adds an example of using HTTP Basic Auth, git options, and using HCL2 syntax
to encode an SSH key from file.
2020-11-19 12:07:02 -05:00
Tim Gross 2139e029ec docs: make dispatch payload size limit unambiguous 2020-11-19 12:06:49 -05:00
Michael Schurter cb9f9800bf docs: document artifact bug #6929 2020-11-17 22:00:21 -08:00
James Rasell 4b34e705f6
docs: Add new Autoscaling Azure VMSS target plugin detail. (#9186)
Co-authored-by: Luiz Aoqui <luiz@hashicorp.com>
2020-11-16 11:40:22 +01:00
Seth Hoenig 4cc3c01d5b
Merge pull request #9352 from hashicorp/f-artifact-headers
jobspec: add support for headers in artifact stanza
2020-11-13 14:04:27 -06:00
Seth Hoenig bb8a5816a0 jobspec: add support for headers in artifact stanza
This PR adds the ability to set HTTP headers when downloading
an artifact from an `http` or `https` resource.

The implementation in `go-getter` is such that a new `HTTPGetter`
must be created for each artifact that sets headers (as opposed
to conveniently setting headers per-request). This PR maintains
the memoization of the default Getter objects, creating new ones
only for artifacts where headers are set.

Closes #9306
2020-11-13 12:03:54 -06:00
Seth Hoenig f7e5fc65c7 docs: update brige network subnet docs
Update the default value for `client.bridge_network_subnet` in docs
to match the new value from 99742f2665. Was `172.26.66.0/23`, is
now `172.26.64.0/20`.

Fixes #9316
2020-11-12 09:11:24 -06:00
Mahmood Ali 25281a88e7 driver/docker: mark cpusets as beta
The cpuset_cpus flag may be subject to change when we revise cpu
management. Also, it's only available in 1.0.0 Beta.
2020-11-12 08:28:50 -05:00
Shishir Mahajan 572c398187 Fix review comments. 2020-11-11 12:30:00 -08:00
Shishir Mahajan c30fea5cd3 Add cpuset_cpus to docker driver. 2020-11-11 12:30:00 -08:00
Tim Gross 0ef0b17b82
docker: disallow volume mounts from host by default (#9321)
The default behavior for `docker.volumes.enabled` is intended to be `false`,
but the HCL schema defaults to `true` if the value is unset. Set the default
literal value to `true`.

Additionally, Docker driver mounts of type "volume" (but not "bind") are not
being properly sandboxed with that setting. Disable Docker mounts with type
"volume" entirely whenever the `docker.volumes.enabled` flag is set to
false. Note this is unrelated to the `volume_mount` feature, which is
constrained to preconfigured host volumes or whatever is mounted by a CSI
plugin.

This changeset includes updates to unit tests that should have been failing
under the documented behavior but were not.
2020-11-11 10:03:46 -05:00
Byron Wolfman 0c65d11538
Document correct default nomad port (#9290) 2020-11-06 16:37:36 -05:00
James Rasell d20e2d773c
docs: add recommendation CLI documentation. (#9288)
Co-authored-by: Chris Baker <1675087+cgbaker@users.noreply.github.com>
2020-11-06 16:30:24 +01:00
Tim Gross c15a16301e
docs: internals documentation for alloc filesystem (#9195)
We recently added documentation disambiguating the terminology of the
allocation/task working directories. This changeset adds an internals document
that describes in more detail exactly what does into the allocation working
directory, how this interacts with the filesystem isolation provided by task
drivers, and how this interacts with features like `artifact` and `template`.

Co-authored-by: Charlie Voiselle <464492+angrycub@users.noreply.github.com>
2020-11-04 09:59:19 -05:00
James Rasell fca529e7c4
docs: update scaling policy list docs to detail all flags. 2020-11-04 13:36:04 +01:00
Kris Hicks 1da9e7fc67
Add event sink API and CLI commands (#9226)
Co-authored-by: Drew Bailey <2614075+drewbailey@users.noreply.github.com>
2020-11-02 09:57:35 -08:00
Mahmood Ali 895fa1e3fa
First draft of HCLv2 docs (#9218)
This is a first draft of HCLv2 docs - I added the details under hcl2 doc with some minimal info highlighting the hcl2 introductions.

As a longer term strategy, we'll want to mimic the Packer HCL docs structure that details all the blocks and allowed expressions/functions in greater details. However, given that the exact functions and templating syntax is still somewhat influx, I opt to push that to another time.
2020-11-02 12:27:53 -05:00
Tim Gross 6c2df5d64c
docs: remove outdated reference to template.allow_host_source (#9237)
The `template.allow_host_source` configuration was not operable, leading to
the recent security patch in 0.12.6. We forgot to update this piece of the
documentation referring to the correct configuration value.
2020-10-30 15:56:37 -04:00
James Rasell 9f980a9599
Merge pull request #9193 from hashicorp/f-dynamic-app-sizing-oss-docs-merge
docs: DAS related documentation updates
2020-10-27 17:32:00 +01:00
James Rasell 799b07182e
Merge pull request #9194 from hashicorp/f-autoscaler-policy-eval-agent-docs
docs: update Autoscaler agent docs with policy_eval config params.
2020-10-27 17:30:33 +01:00
James Rasell 527421b4bb
Merge pull request #9162 from hashicorp/f-gh-8648-docs
docs: add new job scale and scaling-events CLI website docs.
2020-10-27 16:33:38 +01:00
James Rasell 8640fdde3d
docs: update autoscaling policy to detail DAS policy syntax. 2020-10-27 16:30:36 +01:00
James Rasell d73b1af441
docs: update autoscaling overview to include DAS overview. 2020-10-27 16:30:07 +01:00
James Rasell 00ca13a081
docs: add DAS Nomad target plugin to Autoscaling docs. 2020-10-27 16:28:42 +01:00
James Rasell cbf7cc5eb7
docs: add DAS strategy plugin detail to autoscaling docs. (#479)
Co-authored-by: Chris Baker <1675087+cgbaker@users.noreply.github.com>
2020-10-27 16:26:09 +01:00
Chris Baker 72164753a3
docs: updated enterprise page with DAS feature 2020-10-27 16:25:07 +01:00
James Rasell 15aaada0cd
docs: update Autoscaler agent docs with policy_eval config params. 2020-10-27 12:23:27 +01:00
James Rasell 592c28c6ba
docs: add new scaling command website documentation. (#9143)
Co-authored-by: Chris Baker <1675087+cgbaker@users.noreply.github.com>
2020-10-27 07:15:11 +01:00
Allen 476b6d7af3
Fix command typo of vault token create (#9169) 2020-10-26 08:16:19 -04:00
Michael Schurter dc5d16bd9e
Merge pull request #9135 from hashicorp/f-namespaces
core: open source namespaces
2020-10-23 10:23:55 -07:00
Stefan Richter 484ef8a1e8
Add NOMAD_JOB_ID and NOMAD_JOB_PAERENT_ID env variables (#8967)
Beforehand tasks and field replacements did not have access to the
unique ID of their job or its parent. This adds this information as
new environment variables.
2020-10-23 10:49:58 -04:00
Tim Gross 10b6551065
docs: add regression warning for GH-9148 to upgrade guide (#9157)
* docs: add regression warning for GH-9148 to upgrade guide
* changelog entry
2020-10-23 10:05:56 -04:00
James Rasell b9a0d49cb2
docs: add new job scale and scaling-events CLI website docs. 2020-10-23 09:30:04 +02:00
Michael Schurter 2c78d6cb5d docs: namespaces are oss in Nomad 1.0 2020-10-22 15:26:32 -07:00
Drew Bailey f3dcefe5a9
remove event durability (#9147)
* remove event durability

temporarily removing go-memdb event durability until a new strategy is developed on how to best handled increased durability needs

* drop events table schema and state store methods

* fix neweventbuffer invocations
2020-10-22 12:21:03 -04:00
Tim Gross 70c9faabd2 upgrade guide documentation 2020-10-21 14:34:12 -04:00
José Maia 186d85fd34
Remove limitation that has been fixed
Issue #6459 has been fixed for a while, but the docs still point to it as a limitation
2020-10-20 15:32:41 +01:00
Tim Gross 17e14b79ac
docs: clarify task working directories (#9098)
The terms task directory and allocation directory are used throughout the
documentation but these directories are not the same as the `NOMAD_TASK_DIR`
and `NOMAD_ALLOC_DIR` locations. This is confusing when trying to use the
`template` and `artifact` stanzas, especially when trying to use a destination
outside the Nomad-mounted directories for Docker and similar drivers.

This changeset introduces "allocation working directory" to mean the location
on disk where the various directories and artifacts are staged, and "task
working directory" for the task. Clarify how specific task drivers interact
with the task working directory.

Co-authored-by: Charlie Voiselle <464492+angrycub@users.noreply.github.com>
2020-10-16 12:56:09 -04:00
Tim Gross da75edc42f
Update website/pages/docs/drivers/external/lxc.mdx
Co-authored-by: Charlie Voiselle <464492+angrycub@users.noreply.github.com>
2020-10-16 12:55:45 -04:00
Tim Gross ced132199d improve language for LXC volumes 2020-10-16 11:40:06 -04:00
Tim Gross fbf98543f2 clarify raw_exec doesn't have filesystem isolation 2020-10-16 11:38:23 -04:00
Drew Bailey ea6fcf5f4e
Events/docs (#9100)
* /v1/event/stream docs

* events sidebar

* wip server config

* make ids match

* fix typo

* add server config opts

* Update website/pages/api-docs/events.mdx

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

* Update website/pages/api-docs/events.mdx

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

* address feedback

Co-authored-by: Seth Hoenig <shoenig@hashicorp.com>
2020-10-16 11:23:47 -04:00
Tim Gross 8fb55a2148 Apply suggestions from code review
Co-authored-by: Charlie Voiselle <464492+angrycub@users.noreply.github.com>
2020-10-16 11:02:49 -04:00
Tim Gross a3561a3d96 fix anchor links 2020-10-16 11:02:49 -04:00