Commit Graph

3479 Commits

Author SHA1 Message Date
Seth Hoenig 38f24a7d41
docs: gateway task docs changes
Co-authored-by: Tim Gross <tgross@hashicorp.com>
2020-12-17 10:37:02 -06:00
Seth Hoenig 939407e643
docs: gateway task docs changes
Co-authored-by: Tim Gross <tgross@hashicorp.com>
2020-12-17 10:36:56 -06:00
Seth Hoenig 9ea4d9793b
docs: gateway task docs changes
Co-authored-by: Tim Gross <tgross@hashicorp.com>
2020-12-17 10:36:42 -06:00
Seth Hoenig 3a3a175e1a consul/connect: enable configuring custom gateway task
Add the ability to configure the Task used for Connect gateways,
similar to how sidecar Task can be configured.

The implementation here simply re-uses the sidecar_task stanza,
and now gets applied whether connect.sidecar_service or
connect.gateway is the thing being defined. In retrospect,
connect.sidecar_task could have been more generically named
like connect.task to make it a little more re-usable.

Closes #9474
2020-12-17 08:51:52 -06:00
Mahmood Ali 5ad721e35c note that the mount flag was added in 1.0.1 2020-12-16 18:56:08 -05:00
Mahmood Ali 39fd59638a document the new /dev/disk1s5 on / (apfs, local, read-only, journaled)
devfs on /dev (devfs, local, nobrowse)
/dev/disk1s1 on /System/Volumes/Data (apfs, local, journaled, nobrowse)
/dev/disk1s4 on /private/var/vm (apfs, local, journaled, nobrowse)
map auto_home on /System/Volumes/Data/home (autofs, automounted, nobrowse)
/dev/disk2s1 on /Volumes/nRF Connect 3.6.1 (hfs, local, nodev, nosuid, read-only, noowners, quarantine, mounted by notnoop) syntax
2020-12-16 17:25:02 -05:00
Mahmood Ali 9c315540a4 Revert "docs: deactivate var-file section"
This reverts commit 4ad0a882ec5f3ced986a058b17e5199a23940b45.
2020-12-16 17:17:16 -05:00
Mahmood Ali 201af6b1a6 Revert "docs: remove envvar option"
This reverts commit 205a1de6f3bdf870649197a1cc6f12ec19e17b6a.
2020-12-16 17:17:09 -05:00
Michael Schurter 72329f8356 docs: release v1.0.1
- Update release date in changelog
- Update download version
- Update alert banner to not be so specific
2020-12-16 13:55:09 -08:00
Tim Gross 1785822386
template: trigger change_mode for dynamic secrets on restore (#9636)
When a task is restored after a client restart, the template runner will
create a new lease for any dynamic secret (ex. Consul or PKI secrets
engines). But because this lease is being created in the prestart hook, we
don't trigger the `change_mode`.

This changeset uses the the existence of the task handle to detect a
previously running task that's been restored, so that we can trigger the
template `change_mode` if the template is changed, as it will be only with
dynamic secrets.
2020-12-16 13:36:19 -05:00
Mahmood Ali 62251e6fce
docs: more notes about hcl2 compatibility (#9634)
Make backward compatibility notes about Task Driver config options. Namely, call out the use of blocks with non-identifier attributes (like in docker systctl and storage_options) or nesting block syntax within an attribute assignment. Neither of these are valid HCL2. The solution is relatively simple: We can add = and quote the non-identifier attribute names.

Co-authored-by: Tim Gross <tgross@hashicorp.com>
2020-12-14 17:07:09 -05:00
Mahmood Ali 5351764b1b docs: remove envvar option 2020-12-11 13:34:53 -05:00
Michael Lange f265c7ba6d
Merge pull request #9599 from hashicorp/changli0617-patch-1
Highlight "alternative to Kubernetes"
2020-12-10 14:29:32 -08:00
Michael Lange a658295135
Merge pull request #9600 from hashicorp/changli0617-patch-2
Update index.jsx
2020-12-10 14:28:55 -08:00
Michael Lange ffc45ae5c5 Add a line break before the "learn why" cta on our home page 2020-12-10 12:26:53 -08:00
Michael Lange 70dc6ea14e Change the features-list component to support arbitrary markup in the content field 2020-12-10 12:05:17 -08:00
Michael Lange 0b0921ba6c Fix mismatched quotes in JSX strings 2020-12-10 12:04:11 -08:00
Seth Hoenig fcd95fab19
Merge pull request #9611 from hashicorp/b-gateway-concurrency
consul/connect: set default Envoy worker threads for gateways
2020-12-10 12:44:28 -06:00
Mahmood Ali 94016a2118
Apply suggestions from code review
Co-authored-by: Seth Hoenig <shoenig@hashicorp.com>
2020-12-10 12:21:01 -05:00
Mahmood Ali c7ad5d2b15 note environment variables needing to be valid unicode identifier 2020-12-10 12:03:19 -05:00
Mahmood Ali cbe742f1d8 docs: deactivate var-file section
--var-files has a bug where we don't honor it properly.  Let's remove it
from docs, to be enabled for 1.0.1.
2020-12-10 12:03:19 -05:00
Mahmood Ali 129dbd36ea docs: ensure meta keys are not quoted 2020-12-10 12:03:19 -05:00
Seth Hoenig 52c9dbbb91 consul/connect: set default Envoy worker threads for gateways
Applying the default --concurrency for gateways was missed before.
Set the default Envoy concurrency to 1 for connect gateways. The
same override value meta.connect.proxy_concurrency applies.
2020-12-10 10:36:29 -06:00
Mahmood Ali ef30655268 unquote env attributes 2020-12-10 11:30:01 -05:00
André Peters 29adb132e2 Update index.mdx
"Invalid argument name; Argument names must not be quoted."
2020-12-10 08:21:47 -05:00
changli0617 7210556b03
Update index.jsx
Replace a value card to show case "2 million container challenge"
2020-12-09 18:32:17 -08:00
James Rasell ccba39201a
docs: add PreserveCounts param to job API doc. 2020-12-09 14:30:08 +01:00
Michael Schurter 7d02f51494 docs: add an announcement for 1.0 2020-12-08 09:59:49 -08:00
Michael Schurter ddea65f8c9
Merge pull request #9569 from hashicorp/docs-100
docs: 1.0.0 download link
2020-12-08 09:09:29 -08:00
Mike Wickett 0be0fb54b7
website: Update k8s comparison docs, ecosystem and community (#9557)
* website: add k8s vs callout to homepage

* website: move resources to community

* website: add k8s comparison, ecosytem to docs

* website: update redirects

* website: fix homepage link

* website: fix sidebar data

* Update website/pages/docs/nomad-vs-kubernetes/index.mdx

Co-authored-by: changli0617 <39781496+changli0617@users.noreply.github.com>

* Update website/pages/docs/nomad-vs-kubernetes/alternative.mdx

Co-authored-by: changli0617 <39781496+changli0617@users.noreply.github.com>

* Update website/pages/docs/nomad-vs-kubernetes/alternative.mdx

Co-authored-by: changli0617 <39781496+changli0617@users.noreply.github.com>

* Update website/pages/docs/nomad-vs-kubernetes/alternative.mdx

Co-authored-by: changli0617 <39781496+changli0617@users.noreply.github.com>

Co-authored-by: changli0617 <39781496+changli0617@users.noreply.github.com>
2020-12-08 12:09:15 -05:00
Michael Schurter 5df1780bd7 docs: 1.0.0 download link 2020-12-08 08:00:21 -08:00
Mahmood Ali 020f6268b1
Remove Beta tag from 1.0 features (#9562)
* docs: Remove 1.0 beta warning about HCL2.0 docs

* docs: multiregion is not beta anymore either

* docs: scaling isn't beta

* docs: neither is events api
2020-12-08 09:39:25 -05:00
davemay99 36022c9c59 nomad operator debug changelog / doc updates 2020-12-08 08:51:45 -05:00
Charlie Voiselle 02e09b673a Upgade links to guides 2020-12-08 08:51:21 -05:00
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
Drew Bailey c0bd238eb2
fix allocation spelling error, update docs (#9527)
* fix allocation spelling error, update docs

* assign TopicACLPolicy and TopicACLToken properly
2020-12-04 12:04:58 -05:00
Michael Schurter 39fdc47914 docs: publish v1.0.0-rc1 2020-12-03 14:03:57 -08: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
Drew Bailey ce85288f2f
ensure node secret ID is not included in event stream (#9510) 2020-12-03 12:27:14 -05:00
Drew Bailey 17de8ebcb1
API: Event stream use full name instead of Eval/Alloc (#9509)
* use full name for events

use evaluation and allocation instead of short name

* update api event stream package and shortnames

* update docs

* make sync; fix typo

* backwards compat not from 1.0.0-beta event stream api changes

* use api types instead of string

* rm backwards compat note that only changed between prereleases

* remove backwards incompat that only existed in prereleases
2020-12-03 11:48:18 -05: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
Luiz Aoqui 63d6d3b0d1
website: update general help guidance 2020-11-30 19:12:43 -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 4e79ddea45
csi/api: populate ReadAllocs/WriteAllocs fields (#9377)
The API is missing values for `ReadAllocs` and `WriteAllocs` fields, resulting
in allocation claims not being populated in the web UI. These fields mirror
the fields in `nomad/structs.CSIVolume`. Returning a separate list of stubs
for read and write would be ideal, but this can't be done without either
bloating the API response with repeated full `Allocation` data, or causing a
panic in previous versions of the CLI.

The `nomad/structs` fields are persisted with nil values and are populated
during RPC, so we'll do the same in the HTTP API and populate the `ReadAllocs`
and `WriteAllocs` fields with a map of allocation IDs, but with null
values. The web UI will then create its `ReadAllocations` and
`WriteAllocations` fields by mapping from those IDs to the values in
`Allocations`, instead of flattening the map into a list.
2020-11-25 16:44:06 -05: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 1fedddd814 docs: update website to 0.12.9 2020-11-19 14:26:06 -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 95979336b7
Merge pull request #9384 from hashicorp/docs-artifact-bug
docs: document artifact bug #6929
2020-11-18 09:20:45 -08:00