Commit graph

289 commits

Author SHA1 Message Date
Jasmine Dahilig 3d9d4d0522
upgrade guide for 0.10.0 (#6266) 2019-09-05 13:27:37 -07:00
Charlie Voiselle 967c80005d docs: Add Persistent Workload using Host Volumes guide (#6263)
* Added Persistent Workload guide using Host Volumes

* Update website/source/guides/stateful-workloads/stateful-workloads.html.md

Co-Authored-By: Danielle <dani@hashicorp.com>

* fix client config and job spec formatting

* fix typo in description

* fix navigation for both stateful workloads guides

* show output from nomad node status to verify host volumes

* Add value prop info; info about HA

From feedback, added more information about the value proposition for
host volumes (h/t @rkettelerij), and corrected an orphaned bit from
the original guide this one was created from.
2019-09-05 12:33:10 -04:00
Omar Khawaja 77464b700b fix typo 2019-09-05 12:20:34 -04:00
Omar Khawaja 6f50f0eb6f change localhost to host ip 2019-09-05 12:08:55 -04:00
Michael Schurter a59e8ca4a6 mention variable interpolation limitation 2019-09-05 08:58:24 -07:00
Michael Schurter 58f13da372 minor corrections
* hcl formatting
* demo is on localhost not host ip
* clarify consul on PATH
2019-09-05 08:56:39 -07:00
Omar Khawaja e866e92ff4 capitalize Consul 2019-09-04 20:56:38 -04:00
Omar Khawaja deb2a250f0 update example summary and remove redis references 2019-09-04 19:58:47 -04:00
Omar Khawaja ea7eb660ae add screenshot of count dashboard 2019-09-04 18:00:49 -04:00
Omar Khawaja 1e904a28a9 remove tech preview status and update limitations 2019-09-04 17:46:02 -04:00
Omar Khawaja a98fe3c9ca remove reference to consul 1.6-beta and update nomad agent command 2019-09-04 17:30:45 -04:00
Omar Khawaja 4596f00d40 formatting paragraphs 2019-09-04 17:25:06 -04:00
Mahmood Ali 3e2ab6e2a3 address review feedback 2019-09-03 21:44:39 -04:00
Mahmood Ali 6eabf53b91 Default raft protocol to version 3 2019-08-28 15:56:59 -04:00
Preetha Appan fa93345c5d
Fix broken link 2019-07-30 13:37:44 -05:00
Omar Khawaja f1a0086b53
fix typo for link to acl bootstrap reset process (#6032) 2019-07-29 17:11:14 -04:00
Michael Schurter efcfa09031
Merge pull request #6027 from hashicorp/docs-ref-arch
docs: mention acls & sentinel are multi-region
2019-07-29 13:47:06 -07:00
Omar Khawaja 0d52fd8893
Service and Batch Job Preemption Guide (#5853)
* fix navigation issue for spread guide

* skeleton for preemption guide

* background info, challenge, and pre-reqs

* steps

* rewording of intro

* re-wording

* adding more detail to intro

* clarify use of preemption in intro
2019-07-29 16:38:18 -04:00
Michael Schurter 163821c82e docs: mention acls & sentinel are multi-region
The reference architecture neglected to mention ACLs and Sentinel
policies are the exception to "no data is shared between regions."
2019-07-29 08:14:20 -07:00
Michael Schurter 5d5a9676e8
docs: cluster -> region 2019-07-25 15:23:10 -07:00
Spencer Owen 835e74f3b2
Clarify encryption keys are shared across datacenters
#5973
2019-07-24 21:03:46 -06:00
Michael Schurter d3157160ce website: link to nick's talk 2019-07-10 09:20:37 +02:00
Michael Schurter 75936652c0 website: mention cni plugin requirement 2019-07-10 09:13:10 +02:00
Michael Schurter 58e14ffa66 website: Add link to connect tp download 2019-07-09 17:01:35 +02:00
Michael Schurter 5594739eb4 website: switch to prettier demo 2019-07-09 14:44:35 +02:00
Michael Schurter af0e7b8495 website: link to consul 1.6 beta 2019-07-08 22:20:02 +02:00
Michael Schurter 1ef8b37d8d website: minor connect improvements 2019-07-08 13:31:07 +02:00
Nick Ethier c6064c663a
website: change consul and nomad start up to reflect changes 2019-07-07 06:07:26 -04:00
Preetha Appan 1206c895f6
First pass at a Consul Connect example docs 2019-07-06 10:50:02 -05:00
Yishan Lin cd8fc7c983
Merge pull request #5804 from hashicorp/yishan/revised-enterprise-docs
Revised Nomad Enterprise page
2019-07-01 10:41:32 -07:00
Danielle c798d21f23
Merge pull request #5801 from jrasell/patch-5
Fix incorrect link to the sample Grafana dashboard
2019-06-13 16:39:23 +02:00
Preetha Appan cd813e50ec
Add warning docs around downgrades 2019-06-11 13:16:37 -05:00
Yishan Lin cf4d7c90a6 Revised Nomad Enterprise page
- Revised Enterprise content to reflect new pricing & packaging modules
- Consolidated feature pages into single Enterprise pager
- Made each feature into its own subsection on the Enterprise page
- Added direct links to their respective guides below
- Upleveled all Enterprise features onto the navbar
- Updated redirects
2019-06-10 14:08:15 -07:00
James Rasell fcd8444779
Fix incorrect link to the sample Grafana dashboard
closes #5799
2019-06-10 17:26:27 +02:00
Lang Martin 14b9cae7cb deployment update website examples to say 'requires manual promotion' 2019-06-04 13:45:44 -04:00
Lang Martin 5261c737b2 website update auto_promote doc 2019-05-22 12:32:08 -04:00
Omar Khawaja 8039426701
Vagrant optional (#5724)
* specify Vagrant as optional in getting started and installation

* edit next steps
2019-05-17 16:50:16 -04:00
Justin Weissig c0c4e01157
docs: fixed wording
Fixed wording: "as show below"/shown.
2019-05-15 00:08:18 -07:00
Mahmood Ali d36bcc5210 Make spark.html the index 2019-05-14 17:30:08 -04:00
Michael Schurter 1e4330bf2b docs: mention regression in task config validation 2019-05-13 14:08:46 -07:00
Justin Weissig e137b7f2e3
docs: fixed typo
Fixed typo: programatic/programmatic
2019-05-11 10:40:39 -07:00
Mahmood Ali 3a3165f127 update links to use new canonical location 2019-05-10 09:41:19 -04:00
Justin Weissig 9f9785dde8
doc: wording
Fixed wording: "as show below" -> "as shown below".
2019-05-10 00:12:55 -07:00
Yishan Lin 7df9d2570f Merge branch 'master' into yishan/revised-nomadproject-structure 2019-05-09 12:59:53 -07:00
Yishan Lin 4dbe029a99 Changed from "Container Management" to "Container Orchestration"
Removed Terraform mention in integrations without existing guide.
2019-05-09 10:14:01 -07:00
Yishan Lin 968e67547a Revised NomadProject Structure
- Revised "What is Nomad" copy
- Added "Key Features" section with links to task drivers & device plugins with lift-and-shift from README
- Added "Who Uses Nomad" section with users, talks, blog posts
- Removed Hadoop YARN, Docker Swarm, HTCondor from comparisons
- Revamped Guides section
- Inserted "Installing Nomad", "Upgrading", "Integrations" as persistent in Guides navbar
- Split Installing Nomad into two paths for users (one for Sandbox with "Quickstart", one for Production)
- Surfaced "Upgrading" and "Integrations" section from documentation
- Changed "Job Lifecycle" section into "Deploying & Managing Applications"
- Reworked "Operations" into "Operating Nomad"
- Reworked "Security" into "Securing Nomad"
- Segmented Namespaces, Resource Quotas, Sentinel into "Governance & Policy" subsection
- Reworked "Spark integration" into its own "Analytical Workloads" section
2019-05-08 14:40:38 -07:00
Charlie Voiselle ce5023ee95
Typo fixes (#5661)
* Typo fixes
* it's -> its
* plugable -> pluggable
2019-05-08 12:54:44 -04:00
Justin Weissig 77e53de301
Fixed Typo
Fixed typo: schedular/scheduler.
2019-05-07 05:11:36 -07:00
Mahmood Ali bfc907827c docs: update s3 urls to use virtual bucket style
In response to https://forums.aws.amazon.com/ann.jspa?annID=6776
2019-05-06 10:39:51 -04:00
Justin Weissig e2ea24a0de
Fix Typo
Fixed Typo: Behing/Behind.
2019-05-05 05:42:40 -07:00
Preetha 50bffbda16
Merge pull request #5606 from hashicorp/docs-ea-update-0.9
Docs ea update 0.9
2019-04-24 10:48:57 -05:00
Michael Schurter 6e43f72a12 docs: bump deployment guide to 0.9.0 2019-04-19 12:39:38 -07:00
Chris Baker a26d4fe1e5
docs: -vault-namespace, VAULT_NAMESPACE, and config
agent: added VAULT_NAMESPACE env-based configuration
2019-04-10 10:34:10 -05:00
Omar Khawaja 72a5f3defc
Nomad TLS with Vault (#5454)
* navigation and initial steps of guide

* generate certs with appropriate token

* configure Nomad to use TLS

* add cli keys and certs

* add server gossip encryption section

* fix mislabeled steps

* vault paths formatting

* remove bit about cert revocation

* add clarification in challenge that we will be securing an existing Nomad cluster

* add some comments to consul-template.hcl to help user walk through it

* clarifying comments for CLI certs templates

* reorganize steps, change permissions on certs, and sub pkill command with systemctl reload nomad

* correct step reference

* add rpc upgrade mode instructions

* correct typo
2019-04-09 12:13:37 -04:00
Michael Schurter 3c78271ea2 docs: remove partial sig/checksum verification
Point users to security doc instead. Right now it takes a lot of
explaining to describe to users exactly how to validate the binary and
what the output of the tools used means.

For example, this is the output when validating according to the
instructions in this guide and the linked doc:

```
vagrant@linux:/tmp$ gpg --verify nomad_0.8.7_SHA256SUMS.sig
nomad_0.8.7_SHA256SUMS
gpg: Signature made Fri 11 Jan 2019 09:47:56 PM UTC using RSA key ID
348FFC4C
gpg: Good signature from "HashiCorp Security <security@hashicorp.com>"
gpg: WARNING: This key is not certified with a trusted signature!
gpg:          There is no indication that the signature belongs to the
owner.
Primary key fingerprint: 91A6 E7F8 5D05 C656 30BE  F189 5185 2D87 348F
FC4C
vagrant@linux:/tmp$ shasum -a 256 -c nomad_0.8.7_SHA256SUMS
shasum: ./nomad_0.8.7_darwin_amd64.zip:
./nomad_0.8.7_darwin_amd64.zip: FAILED open or read
shasum: ./nomad_0.8.7_linux_386.zip: No such file or directory
./nomad_0.8.7_linux_386.zip: FAILED open or read
shasum: ./nomad_0.8.7_linux_amd64-lxc.zip: No such file or directory
./nomad_0.8.7_linux_amd64-lxc.zip: FAILED open or read
./nomad_0.8.7_linux_amd64.zip: OK
shasum: ./nomad_0.8.7_linux_arm64.zip: No such file or directory
./nomad_0.8.7_linux_arm64.zip: FAILED open or read
shasum: ./nomad_0.8.7_linux_arm.zip: No such file or directory
./nomad_0.8.7_linux_arm.zip: FAILED open or read
shasum: ./nomad_0.8.7_windows_386.zip: No such file or directory
./nomad_0.8.7_windows_386.zip: FAILED open or read
shasum: ./nomad_0.8.7_windows_amd64.zip: No such file or directory
./nomad_0.8.7_windows_amd64.zip: FAILED open or read
shasum: WARNING: 7 listed files could not be read
```

There are only two lines that matter in all of that output:

```
...
gpg: Good signature from "HashiCorp Security <security@hashicorp.com>"
...
./nomad_0.8.7_linux_amd64.zip: OK
...
```

I feel like trying to teach users how to use and interpret these tools
in our deployment guide may be as likely to reduce confidence as
increase it.
2019-03-20 09:36:29 -07:00
Mahmood Ali 4c3dbd2f84
Don't use "datacenter" in a confusing way
Co-Authored-By: schmichael <michael.schurter@gmail.com>
2019-03-20 08:08:37 -07:00
Michael Schurter 30db07cccb docs: sync systemd unit files; update deploy guide
The systemd configs spread across our repo were fairly out of sync. This
should get them on our best practices.

The deployment guide also had some strange things like running Nomad as
a non-root user. It would be fine for servers but completely breaks
clients. For simplicity I simply removed the non-root user references.
2019-03-19 15:18:12 -07:00
Omar Khawaja 5327904f54
Portworx guide (#5399)
* skeleton

* configure portworx

* destroy and redeploy mysql with data intact

* rename all directories and references from persistent storage to stateful workloads

* add considerations and remove references to StorageOS

* update wording and headings

* create portworx volume externally and modify jobfile to reflect that

* fix typo

* Update website/source/guides/stateful-workloads/portworx.html.md

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

* Update website/source/guides/stateful-workloads/portworx.html.md

Co-Authored-By: Omar-Khawaja <Omar-Khawaja@users.noreply.github.com>
2019-03-15 11:33:46 -04:00
Omar Khawaja 61d7156e61
update formatting and add toJSON function with explanation (#5366)
* update formatting and add toJSON function with explanation

* edit typo

* Update website/source/guides/operations/vault-integration/index.html.md

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

* fixing clarification bullet explaining the use of toJSON
2019-02-28 13:00:25 -05:00
Omar Khawaja 084230a12b
reformat lxc guide (#5339)
* reformat lxc guide

* reformat lxc guide
2019-02-21 17:40:22 -05:00
Dan Brown bf3e1a7c8d
Confirm DG against Nomad 0.9.0-beta2
Change product_version frontmatter to ea_version and increase to 0.9
2019-02-11 14:35:21 +00:00
Dan Brown 07d9d61563
Confirm RA against Nomad 0.9.0-beta2
Change product_version frontmatter to ea_version and increase to 0.9
2019-02-11 14:33:36 +00:00
Omar Khawaja b18006fe3f
add some cross-linking for easier reference (#5292) 2019-02-01 13:12:18 -05:00
Matthias Endler 22cca2bbd6
Fix typo in "discovery" 2019-02-01 14:24:02 +01:00
Omar Khawaja fe6a95ef63 fix typo 2019-01-30 17:48:08 -05:00
Mahmood Ali 62b48264e9
website: update lxc references to 0.1.0-rc2 (#5283) 2019-01-30 17:05:44 -05:00
Michael Schurter 728585b9c2 docs: add 0.9 specific upgrade notes 2019-01-29 15:18:15 -08:00
Alex Dadgar 05b1b03156 fix lxc sidebar 2019-01-29 15:03:02 -08:00
Omar Khawaja d11a4c5d6b
fix typo from plugin_dir to data_dir (#5267) 2019-01-29 16:49:28 -05:00
Omar Khawaja 45a07ce15f
LXC driver guide (#5255)
* skeleton for external plugins guide section

* initial content

* add installation and configuration steps

* complete steps to deployg lxc workload

* update link

* correct typo in link

* change link name

* fix alignment and word wrap at 80

* updates

* update lxc driver download link and commands in step 3

* fix link typo
2019-01-29 16:02:58 -05:00
Mahmood Ali 2e29f96875 fix link typo 2019-01-28 14:04:46 -05:00
Charlie Voiselle e3a38806e8
Update outage.html.markdown 2019-01-28 09:04:52 -05:00
Preetha Appan 2d135e96b7
Fix broken scheduling links in advanced scheduling guide 2019-01-26 10:57:49 -06:00
Omar Khawaja 69c887972b
Advanced scheduling guides (affinity + spread) (#5001)
* initial structure

* add to affinity guide

* add to affinity guide

* update affinity guide

* spread guide

* update content

* update step 3 to spread stanza

* update

* add wording to motivate the use of spread and affinity

* improve guide description and use clearer wording to distinguish constrain from affinity

* clarify challenge to user with specific example

* improve wording in the solution section

* incorporate rest of suggestions into affinity guide

* modify spread guide description

* improve wording of spread docs

* change instance count from 5 to 10 to more easily show spread

* improving spread guide and changing demo architecture

* motivate spread a bit more

* clarification about spread

* fix wording
2019-01-25 10:43:39 -05:00
Omar Khawaja b723f48d52
add link on monitoring home for easier navigation (#5028) 2018-12-19 14:13:13 -05:00
Danielle Tomlinson 80c95d3b76
Merge pull request #4982 from hashicorp/f-acls-glob-ns
acl: Add support for globbing namespaces
2018-12-19 12:49:43 +01:00
Danielle Tomlinson c623609e89 guides: Update for globbed namespace rules 2018-12-19 12:48:56 +01:00
Omar Khawaja b1ab008abf
Commenting out dead link to demo.nomadproject.io (#5017)
* removing dead link

* comment out header and footer to UI demo

* adding reference to link back and commenting it out
2018-12-18 17:26:51 -05:00
Alex Dadgar 1e3c3cb287 Deprecate IOPS
IOPS have been modelled as a resource since Nomad 0.1 but has never
actually been detected and there is no plan in the short term to add
detection. This is because IOPS is a bit simplistic of a unit to define
the performance requirements from the underlying storage system. In its
current state it adds unnecessary confusion and can be removed without
impacting any users. This PR leaves IOPS defined at the jobspec parsing
level and in the api/ resources since these are the two public uses of
the field. These should be considered deprecated and only exist to allow
users to stop using them during the Nomad 0.9.x release. In the future,
there should be no expectation that the field will exist.
2018-12-06 15:09:26 -08:00
Dan Brown 8aebe8c47d Add Reference Architecture and Deployment Guide (#4768)
* Add Nomad RA

* Add deployment guide and nav

* Deployment Guide update

* Minor typo fixes

* Update diagrams

* Fixes for review

* Link fixes and typo fix

* Edits following review

- Update image text from "zone" to "datacenter" to match Nomad terminology
- Clean up text based on Preetha's feedback

* Text updates

Based on feedback from Rob

* Update diagrams

* fixing spelling

* Add suggestions from Preetha and Omar
2018-12-04 11:49:35 -05:00
Omar Khawaja ce5ef3ab26
fix step 5 broken link (#4939) 2018-11-29 14:35:39 -05:00
Omar Khawaja 77945c9e4f
New Nomad Vault Integration Guide (#4886)
* add vault integration guide in guides section and move current vault integration content to docs section

* complete guide with image

* fix typos

* rename step 6 and fix typos

* fix typos and awkward phrasing along with links

* fix duplicated step #

* fix typo

* fix links so that pages that pointed to the original vault integration content still point there
2018-11-27 10:28:01 -05:00
Omar Khawaja be1c2e6624
Move current telemetry page to docs (#4898)
* move current telemetry page to docs

* fix broken links to telemetry doc
2018-11-26 15:18:57 -05:00
Omar Khawaja 181381f456
change instrumented webserver job file (#4897) 2018-11-17 01:10:44 -05:00
Chris Baker a16fe95de9
Merge pull request #4762 from hashicorp/f-678-check-broken-links
docs: check website for broken links
2018-10-09 16:35:06 -04:00
Chris Baker 0d0da84462
Merge pull request #4743 from hashicorp/doc-rpc-port-discussion
docs: make explicit the communication pattern on RPC port (4647)
2018-10-08 16:01:41 -04:00
Chris Baker 6172eb92ca docs: fixed broken links to schedulers page 2018-10-08 13:23:14 -04:00
Omar Khawaja b833e4e8f6
editing monitoring.html (#4754) 2018-10-04 18:40:13 -04:00
Omar Khawaja ceb2eed3e5
editing lb guide (#4753) 2018-10-04 18:26:51 -04:00
Omar Khawaja b3937e3fc6
Monitoring and Alerting Guide with Prometheus [WIP] (#4706)
* add prometheus configuration guide

* fixing sub navigation issue

* Add detail to Next Steps

* add alerting component to guide

* update

* change docker image name and shorten job templates

* re-arrange to fix broken links
2018-10-04 17:15:10 -04:00
Omar Khawaja adfd89ded8
Load Balancing with Fabio Guide (#4445)
* add load-balancing guide

* restructure load balancing section

* defining consul lb strategies inline and giving fabio its own bullet point

* update docker image name and shorten job template

* changing system scheduler link to relative link and moving load balancing navigation link right to right above Web UI
2018-10-04 16:18:52 -04:00
Chris Baker 33328c973d docs: amended description per @dadgar suggestions in https://github.com/hashicorp/nomad/pull/4743 2018-10-02 13:02:56 -04:00
Chris Baker 307d66590c docs: make explicit the communication pattern on RPC port (4647) 2018-10-02 12:19:37 -04:00
Dominykas Djačenko e66d8926b0
Update federation.md command
This fixes the documentation to use the most recent syntax for `nomad server join`
2018-09-18 12:58:42 -07:00
Rob Genova e5050a332f
Misc. /guides updates 2018-08-25 11:35:56 -05:00
Rob Genova 2e5f483dc2
Update guides/spark 2018-08-25 11:35:56 -05:00
Rob Genova 1ebdcf7688
Update guides/security 2018-08-25 11:35:56 -05:00
Rob Genova 8ae384dac7
Update guides/operating-a-job 2018-08-25 11:35:56 -05:00
Rob Genova 0bd33ee163
Updates to guides/operations 2018-08-25 11:35:56 -05:00
Rob Genova e4120e34c9
Re-organize existing docs and guides 2018-08-25 11:35:56 -05:00