mirror of
https://github.com/kemko/nomad.git
synced 2026-01-01 16:05:42 +03:00
Docs: Chore: Ent labels (#26323)
* replace outdated tutorial links * update more tutorial links * Add CE/ENT or ENT to left nav * remove ce/ent labels * revert enterprise features
This commit is contained in:
Aimee Ukasick
@@ -10,6 +10,6 @@ description: |-
|
||||
The `/acl` endpoints provide access to the ACL subsystem which includes ACL
|
||||
bootstrapping, ACL Policies, ACL Roles, ACL Tokens, ACL Auth Methods, and ACL
|
||||
Binding Rules. For more details about ACLs, please see the [ACL
|
||||
Guide](/nomad/tutorials/access-control).
|
||||
Guide](/nomad/docs/secure/acl).
|
||||
|
||||
Please choose a subsection in the navigation for more information.
|
||||
|
||||
@@ -7,7 +7,7 @@ description: The /acl/policy endpoints are used to configure and manage ACL poli
|
||||
# ACL Policies HTTP API
|
||||
|
||||
The `/acl/policies` and `/acl/policy/` endpoints are used to manage ACL policies.
|
||||
For more details about ACLs, please see the [ACL Guide](/nomad/tutorials/access-control).
|
||||
For more details about ACLs, please see the [ACL Guide](/nomad/docs/secure/acl).
|
||||
|
||||
## List Policies
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ description: The /acl/token/ endpoints are used to configure and manage ACL toke
|
||||
# ACL Tokens HTTP API
|
||||
|
||||
The `/acl/bootstrap`, `/acl/tokens`, and `/acl/token/` endpoints are used to manage ACL tokens.
|
||||
For more details about ACLs, please see the [ACL Guide](/nomad/tutorials/access-control).
|
||||
For more details about ACLs, please see the [ACL Guide](/nomad/docs/secure/acl).
|
||||
|
||||
## Bootstrap Token
|
||||
|
||||
|
||||
@@ -85,7 +85,7 @@ by default, requiring a management token.
|
||||
| Node | Node |
|
||||
| NodeDrain | Node |
|
||||
| NodePool | NodePool |
|
||||
| Operator | UtilizationSnapshot (Enterprise only) |
|
||||
| Operator | UtilizationSnapshot <EnterpriseAlert inline/> |
|
||||
| Service | Service Registrations |
|
||||
|
||||
### Event Types
|
||||
|
||||
@@ -68,7 +68,7 @@ administration.
|
||||
|
||||
Several endpoints in Nomad use or require ACL tokens to operate. The token are used to authenticate the request and determine if the request is allowed based on the associated authorizations. Tokens are specified per-request by using the `X-Nomad-Token` request header or with the Bearer scheme in the authorization header set to the `SecretID` of an ACL Token.
|
||||
|
||||
For more details about ACLs, please see the [ACL Guide](/nomad/tutorials/access-control).
|
||||
For more details about ACLs, please see the [ACL Guide](/nomad/docs/secure/acl).
|
||||
|
||||
## Authentication
|
||||
|
||||
|
||||
@@ -106,15 +106,15 @@ The table below shows this endpoint's support for
|
||||
cluster. Only takes effect if all servers are running Raft protocol version 3
|
||||
or higher. Must be a duration value such as `30s`.
|
||||
|
||||
- `EnableRedundancyZones` `(bool: false)` - (Enterprise-only) Specifies whether
|
||||
- `EnableRedundancyZones` `(bool: false)` - <EnterpriseAlert inline/> Specifies whether
|
||||
to enable redundancy zones.
|
||||
|
||||
- `DisableUpgradeMigration` `(bool: false)` - (Enterprise-only) Disables Autopilot's
|
||||
- `DisableUpgradeMigration` `(bool: false)` - <EnterpriseAlert inline/> Disables Autopilot's
|
||||
upgrade migration strategy in Nomad Enterprise of waiting until enough
|
||||
newer-versioned servers have been added to the cluster before promoting any of
|
||||
them to voters.
|
||||
|
||||
- `EnableCustomUpgrades` `(bool: false)` - (Enterprise-only) Specifies whether to
|
||||
- `EnableCustomUpgrades` `(bool: false)` - <EnterpriseAlert inline/> Specifies whether to
|
||||
enable using custom upgrade versions when performing migrations.
|
||||
|
||||
## Read Health
|
||||
@@ -222,7 +222,7 @@ $ curl \
|
||||
status of 200 will be returned. If `Healthy` is false, then a status of 429 will be returned.
|
||||
|
||||
<EnterpriseAlert>
|
||||
This API endpoint return with more information in Nomad Enterprise. This is
|
||||
This API endpoint returns with more information in Nomad Enterprise. This is
|
||||
not present in Nomad Community Edition.
|
||||
</EnterpriseAlert>
|
||||
|
||||
|
||||
@@ -585,7 +585,8 @@ $ curl \
|
||||
|
||||
If the search Context is `all` when fuzzy searching, the object types that are
|
||||
identified only with UUIDs are also concurrently prefix-searched. Those types include
|
||||
deployments, evals, volumes, and quotas (Enterprise).
|
||||
deployments, evaluations, volumes, and resource quotas. Note that resource quotas is
|
||||
an Enterprise feature.
|
||||
|
||||
### Sample Payload (prefix match)
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ description: >-
|
||||
The `/sentinel/policies` and `/sentinel/policy/` endpoints are used to manage Sentinel policies.
|
||||
For more details about Sentinel policies, please see the [Sentinel Policy Guide](/nomad/docs/govern/sentinel).
|
||||
|
||||
Sentinel endpoints are only available when ACLs are enabled. For more details about ACLs, please see the [ACL Guide](/nomad/tutorials/access-control).
|
||||
Sentinel endpoints are only available when ACLs are enabled. For more details about ACLs, please see the [ACL Guide](/nomad/docs/secure/acl).
|
||||
|
||||
<EnterpriseAlert product="nomad"/>
|
||||
|
||||
|
||||
@@ -495,9 +495,7 @@ This page lists all allocations for a CSI plugin. Each allocation includes the s
|
||||
|
||||
- `type` `(string: "")` - Filters the list of allocations to only those with a matching plugin type. Value must be `controller`, `node`, or unset.
|
||||
|
||||
## Optimize
|
||||
|
||||
~> **Enterprise Only!** This feature depends on functionality only present in Nomad Autoscaler Enterprise.
|
||||
## Optimize <EnterpriseAlert inline/>
|
||||
|
||||
This page lists all recommendations surfaced by [dynamic application sizing](/nomad/tools/autoscaling#dynamic-application-sizing). This page will automatically redirect to the recommendation summary route for the first recommendation sorted by relevance.
|
||||
|
||||
|
||||
@@ -77,6 +77,6 @@ subcommands are available:
|
||||
[roledelete]: /nomad/commands/acl/role/delete
|
||||
[roleinfo]: /nomad/commands/acl/role/info
|
||||
[rolelist]: /nomad/commands/acl/role/list
|
||||
[secure-guide]: /nomad/tutorials/access-control
|
||||
[federated]: //nomad/docs/deploy/clusters/federate-regions
|
||||
[secure-guide]: /nomad/docs/secure/acl
|
||||
[federated]: /nomad/docs/deploy/clusters/federate-regions
|
||||
[`authoritative_region`]: /nomad/docs/configuration/server#authoritative_region
|
||||
|
||||
@@ -16,14 +16,12 @@ hours.
|
||||
If ACLs are enabled, this command requires a token with the `operator:write`
|
||||
capability.
|
||||
|
||||
<Note title="Nomad Enterprise">
|
||||
<EnterpriseAlert />
|
||||
|
||||
Refer to the [manual license utilization
|
||||
reporting](/nomad/docs/enterprise/license/utilization-reporting) page to learn
|
||||
more about reporting your Nomad Enterprise license utilization.
|
||||
|
||||
</Note>
|
||||
|
||||
## Options
|
||||
|
||||
- `-message` `(string; "")` - Provide context about the conditions under which
|
||||
|
||||
@@ -31,7 +31,7 @@ but the general mechanisms for a secure Nomad deployment revolve around:
|
||||
internal abuse by preventing unauthenticated access to network components
|
||||
within the cluster.
|
||||
|
||||
- **[ACLs](/nomad/tutorials/access-control)** Enables authorization for
|
||||
- **[ACLs](/nomad/docs/secure/acl)** Enables authorization for
|
||||
authenticated connections by granting capabilities to ACL tokens.
|
||||
|
||||
- **[Namespaces](/nomad/docs/govern/namespaces)** Access to read
|
||||
@@ -50,7 +50,7 @@ granularity may change depending on your team's use case where rigorous roles
|
||||
can be accurately defined and managed using the [Nomad backend secret engine for
|
||||
Vault](/vault/docs/secrets/nomad). This is
|
||||
described further with getting started steps using a development server
|
||||
[here](/nomad/tutorials/access-control).
|
||||
[here](/nomad/docs/secure/acl).
|
||||
|
||||
It's important to note that there's no traditional concept of a user
|
||||
within Nomad itself.
|
||||
@@ -135,7 +135,7 @@ recommendations accordingly.
|
||||
when using `tls.verify_https_client=false`. You can use a reverse proxy or
|
||||
other external means to restrict access to them.
|
||||
|
||||
- [ACLs enabled](/nomad/tutorials/access-control) The
|
||||
- [ACLs enabled](/nomad/docs/secure/acl) The
|
||||
access control list (ACL) system provides a capability-based control
|
||||
mechanism for Nomad administrators allowing for custom roles (typically
|
||||
within Vault) to be tied to an individual human or machine operator
|
||||
|
||||
@@ -160,19 +160,21 @@ jobs:
|
||||
configuration and examples.
|
||||
- The [Schedulers] page explains the different types of Nomad schedulers and how
|
||||
those schedulers run jobs.
|
||||
- The [Declare jobs][deploy-jobs] section contains guides for creating a job,
|
||||
using task drivers, and deployment strategies.
|
||||
|
||||
These tutorial resources contain examples of different kinds of jobs and how to
|
||||
configure them:
|
||||
|
||||
- The [Quick Start][quickstart] tutorials cover deploying an application and
|
||||
its resources, which include parameterized and periodic jobs.
|
||||
- The [Deploy and Manage Jobs][deploy-jobs] tutorial contains examples of different types of jobs.
|
||||
- The [Create Nomad Job Specifications][job-spec-tutorial] collection explains several aspects of job creation, including parameterized jobs and deploying a Java app on Nomad.
|
||||
- The [Create Nomad Job Specifications][job-spec-tutorial] collection contains
|
||||
guides for migrating a Java application to Nomad.
|
||||
|
||||
|
||||
[allocations]: /nomad/docs/glossary#allocation
|
||||
[deployment]: /nomad/docs/glossary/#deployment
|
||||
[deploy-jobs]: /nomad/tutorials/manage-jobs/
|
||||
[deploy-jobs]: /nomad/docs/job-declare
|
||||
[job-spec]: /nomad/docs/job-specification
|
||||
[job-spec-tutorial]: /nomad/tutorials/job-specifications
|
||||
[quickstart]: /nomad/tutorials/get-started/gs-deploy-job
|
||||
|
||||
@@ -64,4 +64,4 @@ Nomad Networking documentation](/nomad/docs/networking/cni).
|
||||
[cni_spec]: https://www.cni.dev/docs/spec/
|
||||
[cni_spec_net_config]: https://github.com/containernetworking/cni/blob/main/SPEC.md#configuration-format
|
||||
[cni_spec_plugin_config]: https://github.com/containernetworking/cni/blob/main/SPEC.md#plugin-configuration-objects
|
||||
[nomad_install]: /nomad/tutorials/get-started/get-started-install#linux-post-installation-steps
|
||||
[nomad_install]: /nomad/docs/deploy#linux-post-installation-steps
|
||||
|
||||
@@ -76,7 +76,7 @@ and volumes:
|
||||
- [Considerations for Stateful Workloads](/nomad/docs/architecture/storage/stateful-workloads) explores the options for persistent storage of workloads running in Nomad.
|
||||
- The [Nomad volume specification][volumes] defines the schema for creating and registering volumes.
|
||||
- The [job specification `volume` block](/nomad/docs/job-specification/volume) lets you configure a group that requires a specific volume from the cluster.
|
||||
- The [Stateful Workloads](/nomad/tutorials/stateful-workloads) tutorials explore techniques to run jobs that require access to persistent storage.
|
||||
- The [Stateful Workloads](/nomad/docs/stateful-workloads) guides explore techniques to run jobs that require access to persistent storage.
|
||||
|
||||
[allocation]: /nomad/docs/glossary#allocation
|
||||
[delete]: /nomad/api-docs/volumes#delete-task-group-host-volume-claims
|
||||
|
||||
@@ -66,6 +66,6 @@ acl {
|
||||
TTL value for an ACL token when setting expiration. This is used by the Nomad
|
||||
servers to validate ACL tokens and ACL authentication methods.
|
||||
|
||||
[secure-guide]: /nomad/tutorials/access-control
|
||||
[secure-guide]: /nomad/docs/secure/acl
|
||||
[authoritative-region]: /nomad/docs/configuration/server#authoritative_region
|
||||
[Configure for multiple regions]: /nomad/docs/secure/acl/bootstrap#configure-for-multiple-regions
|
||||
|
||||
@@ -8,13 +8,14 @@ description: >-
|
||||
# `audit` Block in Agent Configuration
|
||||
|
||||
<Placement groups={['audit']} />
|
||||
<EnterpriseAlert product="nomad"/>
|
||||
|
||||
This page provides reference information for configuring audit logging behavior
|
||||
in the `audit` block of a Nomad agent configuration. Enable audit logs, define a
|
||||
sink to stream audit logs to, and change filter rules to exclude events from the
|
||||
audit log.
|
||||
|
||||
<EnterpriseAlert product="nomad"/>
|
||||
|
||||
```hcl
|
||||
audit {
|
||||
enabled = true
|
||||
|
||||
@@ -46,17 +46,17 @@ autopilot {
|
||||
cluster. Only takes effect if all servers are running Raft protocol version 3
|
||||
or higher. Must be a duration value such as `30s`.
|
||||
|
||||
- `enable_redundancy_zones` `(bool: false)` - <EnterpriseAlert product="nomad" inline/> Controls whether
|
||||
- `enable_redundancy_zones` `(bool: false)` - <EnterpriseAlert inline/> Controls whether
|
||||
Autopilot separates servers into zones for redundancy, in conjunction with the
|
||||
[redundancy_zone](/nomad/docs/configuration/server#redundancy_zone) parameter.
|
||||
Only one server in each zone can be a voting member at one time.
|
||||
|
||||
- `disable_upgrade_migration` `(bool: false)` - <EnterpriseAlert product="nomad" inline/> Disables Autopilot's
|
||||
- `disable_upgrade_migration` `(bool: false)` - <EnterpriseAlert inline/> Disables Autopilot's
|
||||
upgrade migration strategy in Nomad Enterprise of waiting until enough
|
||||
newer-versioned servers have been added to the cluster before promoting any of
|
||||
them to voters.
|
||||
|
||||
- `enable_custom_upgrades` `(bool: false)` - <EnterpriseAlert product="nomad" inline/> Specifies whether to
|
||||
- `enable_custom_upgrades` `(bool: false)` - <EnterpriseAlert inline/> Specifies whether to
|
||||
enable using custom upgrade versions when performing migrations, in conjunction with
|
||||
the [upgrade_version](/nomad/docs/configuration/server#upgrade_version)
|
||||
parameter.
|
||||
|
||||
@@ -283,9 +283,6 @@ Nomad never attempts to embed the `alloc_dir` in the chroot as doing so would ca
|
||||
|
||||
### `options` Parameters
|
||||
|
||||
~> Note: In Nomad 0.9 client configuration options for drivers were deprecated.
|
||||
Refer to the [plugin block][plugin-block] documentation for more information.
|
||||
|
||||
The following is not an exhaustive list of options for only the Nomad
|
||||
client. To find the options supported by each individual Nomad driver,
|
||||
refer to the [drivers documentation](/nomad/docs/job-declare/task-driver).
|
||||
|
||||
@@ -8,11 +8,12 @@ description: >-
|
||||
# `reporting` Block in Agent Configuration
|
||||
|
||||
<Placement groups={['reporting']} />
|
||||
<EnterpriseAlert product="nomad"/>
|
||||
|
||||
This page provides reference information for enabling automated license
|
||||
utilization reporting in the `reporting` block of a Nomad agent configuration.
|
||||
|
||||
<EnterpriseAlert/>
|
||||
|
||||
Configuration applies to agents running with [server mode
|
||||
enabled][server_mode_enabled].
|
||||
|
||||
|
||||
@@ -8,13 +8,14 @@ description: >-
|
||||
# `sentinel` Block in Agent Configuration
|
||||
|
||||
<Placement groups={['sentinel']} />
|
||||
<EnterpriseAlert product="nomad"/>
|
||||
|
||||
This page provides reference information for configuring the Sentinel policy
|
||||
engine in the `sentinel` block of a Nomad agent configuration. Configure the
|
||||
path to the plugin that Nomad uses to import Sentinel policies and specify
|
||||
arguments to pass to that plugin on startup.
|
||||
|
||||
<EnterpriseAlert/>
|
||||
|
||||
```hcl
|
||||
sentinel {
|
||||
import "custom-plugin" {
|
||||
|
||||
@@ -137,12 +137,12 @@ Error querying jobs: Unexpected response code: 500 (No path to region)
|
||||
|
||||
- [Deployment Topology across Multiple Regions][multi-region]
|
||||
|
||||
[multi-region]: /nomad/tutorials/enterprise/production-reference-architecture-vm-with-consul#deployment-topology-across-multiple-regions
|
||||
[multi-region]: /nomad/docs/deploy/production/reference-architecture#deployment-topology-across-multiple-regions
|
||||
[multi-region-pic]: /img/clusters/nomad-multi-region.png
|
||||
[nomad-server-members]: /nomad/commands/server/members
|
||||
[nomad-status]: /nomad/commands/status
|
||||
[nomad-tf]: https://github.com/hashicorp/nomad/tree/master/terraform#provision-a-nomad-cluster-in-the-cloud
|
||||
[ports-used]: /nomad/docs/deploy/production/requirements#ports-used
|
||||
[reference-arch]: /nomad/tutorials/enterprise/production-reference-architecture-vm-with-consul
|
||||
[reference-arch]: /nomad/docs/deploy/production/reference-architecture
|
||||
[region-config]: /nomad/docs/configuration#region
|
||||
[server-join]: /nomad/commands/server/join
|
||||
|
||||
@@ -109,5 +109,5 @@ to be local to each region for low latency.
|
||||
|
||||
|
||||
[img_sentinel_overview]: /img/govern/sentinel.jpg
|
||||
[`sentinel-override` capability]: /nomad/tutorials/access-control#sentinel-override
|
||||
[`sentinel-override` capability]: /nomad/docs/secure/acl#sentinel-override
|
||||
[`server` stanza]: /nomad/docs/configuration/server
|
||||
|
||||
@@ -136,7 +136,7 @@ For specific details about working with namespaces, consult the [namespace
|
||||
commands] and [HTTP API] documentation.
|
||||
|
||||
|
||||
[acls]: /nomad/tutorials/access-control
|
||||
[acls]: /nomad/docs/secure/acl
|
||||
[http api]: /nomad/api-docs/namespaces
|
||||
[img_ui_ns_dropdown]: /img/govern/nomad-ui-namespace-dropdown.png
|
||||
[namespace commands]: /nomad/commands/namespace
|
||||
|
||||
@@ -197,9 +197,9 @@ For specific details about working with Sentinel, consult the [`nomad sentinel`
|
||||
and [HTTP API] documentation.
|
||||
|
||||
[`nomad sentinel` sub-commands]: /nomad/commands/sentinel
|
||||
[`sentinel-override` capability]: /nomad/tutorials/access-control#sentinel-override
|
||||
[`sentinel-override` capability]: /nomad/docs/secure/acl#sentinel-override
|
||||
[`server` stanza]: /nomad/docs/configuration/server
|
||||
[acls]: /nomad/tutorials/access-control
|
||||
[acls]: /nomad/docs/secure/acl
|
||||
[http api]: /nomad/api-docs/sentinel-policies
|
||||
[json job specification]: /nomad/api-docs/json-jobs
|
||||
[nomad enterprise]: https://www.hashicorp.com/products/nomad/
|
||||
|
||||
@@ -8,12 +8,13 @@ description: |-
|
||||
|
||||
# Configure multi-region deployments
|
||||
|
||||
Federated Nomad clusters enable users to submit jobs targeting any region
|
||||
from any server even if that server resides in a different region. As of Nomad 0.12
|
||||
Enterprise, you can also submit jobs that are deployed to multiple
|
||||
regions. This tutorial demonstrates multi-region deployments, including
|
||||
Federated Nomad clusters enable you to submit jobs targeting any region
|
||||
from any server even if that server resides in a different region. You may submit jobs that are deployed to multiple
|
||||
regions. This guide demonstrates multi-region deployments, including
|
||||
configurable rollout and rollback strategies.
|
||||
|
||||
<EnterpriseAlert/>
|
||||
|
||||
You can create a multi-region deployment job by adding a [`multiregion`]
|
||||
stanza to the job as shown below.
|
||||
|
||||
@@ -38,16 +39,6 @@ multiregion {
|
||||
}
|
||||
```
|
||||
|
||||
<Note>
|
||||
|
||||
The functionality described here is available only in [Nomad
|
||||
Enterprise](https://www.hashicorp.com/products/nomad/pricing/) with the
|
||||
Multi-Cluster & Efficiency module. To explore Nomad Enterprise features, you can
|
||||
sign up for a free 30-day trial from
|
||||
[here](https://www.hashicorp.com/products/nomad/trial).
|
||||
|
||||
</Note>
|
||||
|
||||
## Prerequisites
|
||||
|
||||
To perform the tasks described in this guide, you need to have two Nomad
|
||||
@@ -446,9 +437,9 @@ west f08122e5 successful
|
||||
[nomad-tf]: https://github.com/hashicorp/nomad/tree/master/terraform
|
||||
[server-join]: /nomad/commands/server/join
|
||||
[ports-used]: /nomad/docs/deploy/production/requirements#ports-used
|
||||
[reference-arch]: /nomad/tutorials/enterprise/production-reference-architecture-vm-with-consul
|
||||
[reference-arch]: /nomad/docs/deploy/production/reference-architecture
|
||||
[nomad-server-members]: /nomad/commands/server/members
|
||||
[acls-track]: /nomad/tutorials/access-control
|
||||
[acls-track]: /nomad/docs/secure/acl
|
||||
[updates-track]: /nomad/docs/job-declare/strategy/
|
||||
[update-auto-revert]: /nomad/docs/job-specification/update#auto_revert
|
||||
["task states"]: /nomad/docs/job-specification/update#health_check
|
||||
@@ -456,4 +447,4 @@ west f08122e5 successful
|
||||
[alloc-health-api]: /nomad/api-docs/deployments#set-allocation-health-in-deployment
|
||||
[`update` stanza]: /nomad/docs/job-specification/update
|
||||
[`nomad deployment unblock`]: /nomad/commands/deployment/unblock
|
||||
[multi-region-topology]: /nomad/tutorials/enterprise/production-reference-architecture-vm-with-consul#multi-region
|
||||
[multi-region-topology]:/nomad/docs/deploy/production/reference-architecture#multi-region
|
||||
|
||||
@@ -468,8 +468,7 @@ to specify Nomad's behavior when a value changes.
|
||||
## Next steps
|
||||
|
||||
Because Nomad Variables use functions in the template block to emit data to
|
||||
Nomad jobs, consider learning more about templates in Nomad with the [Templates
|
||||
collection](/nomad/tutorials/templates).
|
||||
Nomad jobs, consider learning more about templates in Nomad with [Nomad Pack](/nomad/tools/nomad-pack).
|
||||
|
||||
[Nomad Variables]: /nomad/docs/concepts/variables
|
||||
[Nomad Variables Access Control]: /nomad/tutorials/variables/variables-acls
|
||||
|
||||
@@ -49,7 +49,7 @@ Learn more about [Nomad's task dependencies][learn-taskdeps].
|
||||
lifecycle task is long-lived (`sidecar = true`) and terminates, it will be
|
||||
restarted as long as the allocation is running.
|
||||
|
||||
[learn-taskdeps]: /nomad/tutorials/task-deps
|
||||
[learn-taskdeps]: /nomad/docs/job-declare/task-dependencies
|
||||
[shutdown_delay]: /nomad/docs/job-specification/group#shutdown_delay
|
||||
[leader]: /nomad/docs/job-specification/task#leader
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ The `multiregion` block specifies that a job will be deployed to multiple
|
||||
one specified by the `region` field or the `-region` command line flag to
|
||||
`nomad job run`.
|
||||
|
||||
<EnterpriseAlert product="nomad"/>
|
||||
<EnterpriseAlert/>
|
||||
|
||||
Federated Nomad clusters are members of the same gossip cluster but not the
|
||||
same raft cluster; they don't share their data stores. Each region in a
|
||||
|
||||
@@ -269,7 +269,7 @@ group "two" {
|
||||
}
|
||||
```
|
||||
|
||||
[canary]: /nomad/docs/job-declare/strategy/blue-green-canary 'Nomad Canary Deployments'
|
||||
[canary]: /nomad/docs/job-declare/strategy/blue-green-canary
|
||||
[checks]: /nomad/docs/job-specification/service#check
|
||||
[rolling]: /nomad/docs/job-declare/strategy/rolling 'Nomad Rolling Upgrades'
|
||||
[strategies]: /nomad/tutorials/job-updates 'Nomad Update Strategies'
|
||||
[rolling]: /nomad/docs/job-declare/strategy/rolling
|
||||
[strategies]: /nomad/docs/job-declare/strategy
|
||||
|
||||
@@ -154,12 +154,7 @@ must be healthy and stable for a certain amount of time before being promoted to
|
||||
a full, voting member. This can be configured via the `ServerStabilizationTime`
|
||||
setting.
|
||||
|
||||
---
|
||||
|
||||
~> The following Autopilot features are available only in [Nomad Enterprise]
|
||||
version 0.8.0 and later.
|
||||
|
||||
## Server read and scheduling scaling
|
||||
## Server read and scheduling scaling <EnterpriseAlert inline />
|
||||
|
||||
With the [`non_voting_server`] option, a server can be explicitly marked as a
|
||||
non-voter and will never be promoted to a voting member. This can be useful when
|
||||
@@ -168,7 +163,7 @@ have data replicated to it, but it will not be part of the quorum that the
|
||||
leader must wait for before committing log entries. Non voting servers can also
|
||||
act as scheduling workers to increase scheduling throughput in large clusters.
|
||||
|
||||
## Redundancy zones
|
||||
## Redundancy zones <EnterpriseAlert inline />
|
||||
|
||||
Prior to Autopilot, it was difficult to deploy servers in a way that took
|
||||
advantage of isolated failure domains such as AWS Availability Zones; users
|
||||
@@ -196,7 +191,7 @@ Nomad will then use these values to partition the servers by redundancy zone,
|
||||
and will aim to keep one voting server per zone. Extra servers in each zone will
|
||||
stay as non-voters on standby to be promoted if the active voter leaves or dies.
|
||||
|
||||
## Upgrade migrations
|
||||
## Upgrade migrations <EnterpriseAlert inline />
|
||||
|
||||
Autopilot in Nomad Enterprise supports upgrade migrations by default. To disable
|
||||
this functionality, set `DisableUpgradeMigration` to true.
|
||||
|
||||
@@ -168,5 +168,5 @@ using the Nomad UI.
|
||||
[img-servers-list]: /img/monitor/guide-ui-img-servers-list.png
|
||||
[metadata]: /nomad/docs/configuration/client#meta
|
||||
[performed from the cli]: /nomad/docs/manage/migrate-workloads
|
||||
[securing the web ui with acls]: /nomad/tutorials/access-control
|
||||
[securing the web ui with acls]: /nomad/docs/secure/acl
|
||||
[typically three or five]: /nomad/docs/architecture/cluster/consensus#deployment-table
|
||||
|
||||
@@ -218,4 +218,4 @@ the Nomad UI, learn how to inspect the state of your cluster using the Nomad UI.
|
||||
[in the job definition to reschedule]: /nomad/docs/job-specification/reschedule
|
||||
[local restart attempts]: /nomad/docs/job-specification/restart
|
||||
[periodic force]: /nomad/commands/job/periodic-force
|
||||
[securing the web ui with acls]: /nomad/tutorials/access-control
|
||||
[securing the web ui with acls]: /nomad/docs/secure/acl
|
||||
|
||||
@@ -479,7 +479,7 @@ plugin {
|
||||
}
|
||||
```
|
||||
|
||||
[Secure Nomad with Access Control]: /nomad/tutorials/access-control
|
||||
[Secure Nomad with Access Control]: /nomad/docs/secure/acl
|
||||
[hcl]: https://github.com/hashicorp/hcl
|
||||
[hcl_syntax_spec]: https://github.com/hashicorp/hcl/blob/main/hclsyntax/spec.md
|
||||
[api_jobs]: /nomad/api-docs/jobs
|
||||
|
||||
@@ -64,12 +64,14 @@ details on `path` and `items` name restrictions.
|
||||
|
||||
## Resources
|
||||
|
||||
Visit the [Nomad Variables tutorial][tutorial] to learn how to create variables,
|
||||
configure access control for variables, and access variables from within job tasks.
|
||||
- [Create and update Nomad variables](/nomad/tutorials/variables/variables-create)
|
||||
- [Configure access control for Nomad
|
||||
variables](/nomad/tutorials/variables/variables-acls)
|
||||
- [Use Nomad variables in tasks](/nomad/docs/job-declare/nomad-variables)
|
||||
|
||||
[nv]: /nomad/docs/concepts/variables
|
||||
[var-init]: /nomad/commands/var/init
|
||||
[var-put]: /nomad/commands/var/put
|
||||
[jobspecs]: /nomad/docs/job-specification
|
||||
[var-restrict]: /nomad/commands/var/put#restrictions
|
||||
[tutorial]: /nomad/tutorials/variables
|
||||
|
||||
|
||||
@@ -24,8 +24,6 @@ We recommend these tutorials, which provision a Nomad cluster for you.
|
||||
- [Cluster Setup][]: Provision a Nomad cluster on AWS, Azure, or GCP. Enable
|
||||
Consul and access control lists (ACLs). This tutorial series has an associated
|
||||
code repository so you can review the Terraform provisioning scripts.
|
||||
- [Enable gossip encryption for Nomad][interactive]: Launch an interactive lab
|
||||
to use Nomad in your browser.
|
||||
|
||||
## Cloud installation
|
||||
|
||||
@@ -73,7 +71,6 @@ Use one of the following methods to run a local Nomad sandbox environment:
|
||||
[installing-binary]: /nomad/docs/deploy
|
||||
[Get Started]: /nomad/tutorials/get-started
|
||||
[Cluster Setup]: /nomad/tutorials/cluster-setup
|
||||
[interactive]: /nomad/tutorials/interactive/security-gossip-encryption
|
||||
[Provision a Nomad cluster on AWS]: https://github.com/hashicorp/nomad/blob/main/terraform/aws/README.md
|
||||
[Provision a Nomad cluster on Azure]:
|
||||
https://github.com/hashicorp/nomad/blob/main/terraform/azure/README.md
|
||||
|
||||
@@ -217,4 +217,4 @@ These links take you to the changelogs on the GitHub website.
|
||||
[pkce]: https://oauth.net/2/pkce/
|
||||
[oidc-concepts]: /nomad/docs/secure/authentication/oidc#client-assertions
|
||||
[oidc-trouble]: /nomad/docs/secure/authentication/oidc#oidc-configuration-troubleshooting
|
||||
[oidc-tutorial]: /nomad/tutorials/single-sign-on/sso-oidc-keycloak
|
||||
[oidc-tutorial]: /nomad/docs/secure/authentication/sso-pkce-jwt
|
||||
|
||||
@@ -17,11 +17,11 @@ make full use of your GPU investment. The device driver automatically detects
|
||||
MIGs. Refer to the [NVIDIA driver docs](/nomad/plugins/devices/nvidia) for
|
||||
details.
|
||||
|
||||
- **Quotas for device resources (Enterprise)**: This release extends quotas to
|
||||
- **Quotas for device resources <EnterpriseAlert inline/>**: This release extends quotas to
|
||||
allow limiting [device resources](/nomad/docs/v1.9.x/job-specification/device). Refer
|
||||
to [Resource quotas](/nomad/docs/v1.9.x/other-specifications/quota) for configuration details.
|
||||
|
||||
- **NUMA awareness for device resources (Enterprise)**: Nomad is able to
|
||||
- **NUMA awareness for device resources <EnterpriseAlert inline/>**: Nomad is able to
|
||||
correlate CPU cores with memory nodes and assign tasks to run on specific CPU
|
||||
cores so as to minimize any cross-memory node access patterns. With Nomad 1.9,
|
||||
we are expanding this functionality to also correlate
|
||||
|
||||
@@ -658,4 +658,4 @@ job’s lifecycle.
|
||||
[k8s-drivers]: https://kubernetes-csi.github.io/docs/drivers.html
|
||||
[nomad-tf]: https://github.com/hashicorp/nomad/tree/master/terraform#provision-a-nomad-cluster-in-the-cloud
|
||||
[password-security]: https://dev.mysql.com/doc/refman/8.0/en/password-security.html
|
||||
[reference-arch]: /nomad/tutorials/enterprise/production-reference-architecture-vm-with-consul#high-availability
|
||||
[reference-arch]: /nomad/docs/deploy/production/reference-architecture#high-availability
|
||||
|
||||
@@ -9,6 +9,6 @@ client CPU, memory, and storage between tasks. Resource isolation effectiveness
|
||||
depends upon individual task driver implementations and underlying client
|
||||
operating systems. Task drivers include various security-related controls but do
|
||||
not use the Nomad client-to-task interface as a security boundary. Refer to the
|
||||
[access control guide](/nomad/tutorials/access-control) for more information on
|
||||
[access control guide](/nomad/docs/secure/acl) for more information on
|
||||
how to protect Nomad cluster operations.
|
||||
|
||||
|
||||
@@ -51,8 +51,9 @@ namespace "default" {
|
||||
}
|
||||
```
|
||||
|
||||
If running Nomad Autoscaler Enterprise, the following ACL policy addition is
|
||||
needed to ensure it can read the Nomad Enterprise license.
|
||||
<Note>
|
||||
|
||||
If you are running Nomad Autoscaler Enterprise, add this ACL policy to ensure Nomad Autoscaler Enterprise is able to read the Nomad Enterprise license.
|
||||
|
||||
```hcl
|
||||
operator {
|
||||
@@ -60,6 +61,8 @@ operator {
|
||||
}
|
||||
```
|
||||
|
||||
</Note>
|
||||
|
||||
Other APM and target plugins may require additional ACLs; see the plugin documentation for more information.
|
||||
|
||||
## Load Order and Merging
|
||||
@@ -120,7 +123,7 @@ following actions.
|
||||
|
||||
[hcl_v2]: https://github.com/hashicorp/hcl/tree/hcl2
|
||||
[nomad_namespaces]: /nomad/docs/govern/namespaces
|
||||
[nomad_acls]: /nomad/tutorials/access-control
|
||||
[nomad_acls]: /nomad/docs/secure/acl
|
||||
[autoscaler_agent_nomad]: /nomad/tools/autoscaling/agent/nomad
|
||||
[autoscaler_cli_config]: /nomad/tools/autoscaling/cli#config
|
||||
[autoscaler_cli_policy_dir]: /nomad/tools/autoscaling/cli#policy-dir
|
||||
|
||||
@@ -12,7 +12,7 @@ description: >-
|
||||
|
||||
<EnterpriseAlert>
|
||||
This functionality only exists in Nomad Autoscaler Enterprise. This is not
|
||||
present in the open source version of Nomad Autoscaler.
|
||||
present in the Community Edition of Nomad Autoscaler.
|
||||
</EnterpriseAlert>
|
||||
|
||||
~> Note that currently Prometheus is the only APM available for Dynamic Application Sizing
|
||||
|
||||
@@ -94,8 +94,11 @@ passed in via CLI arguments. The `agent` command accepts the following arguments
|
||||
|
||||
- `-policy-eval-workers=<key:value>`: The number of workers to initialize for each
|
||||
queue, formatted as `<queue1>:<num>,<queue2>:<num>`. Nomad Autoscaler supports
|
||||
`cluster` and `horizontal` queues. Nomad Autoscaler Enterprise supports additional
|
||||
`vertical_mem` and `vertical_cpu` queues.
|
||||
the following queues:
|
||||
- `cluster`
|
||||
- `horizontal`
|
||||
- `vertical_mem` <EnterpriseAlert inline/>
|
||||
- `vertical_cpu` <EnterpriseAlert inline/>
|
||||
|
||||
- `-policy-source-disable-file`: Disable the sourcing of policies from disk.
|
||||
|
||||
|
||||
@@ -46,7 +46,7 @@ cluster.
|
||||
|
||||
<EnterpriseAlert>
|
||||
This functionality only exists in Nomad Autoscaler Enterprise. This is not
|
||||
present in the open source version of Nomad Autoscaler.
|
||||
present in the Community Edition of Nomad Autoscaler.
|
||||
</EnterpriseAlert>
|
||||
|
||||
Dynamic Application Sizing enables organizations to optimize the resource
|
||||
|
||||
@@ -6,16 +6,16 @@ description: The "app-sizing-nomad" target plugin scales a task resource.
|
||||
|
||||
# Dynamic Application Sizing Nomad Task Target
|
||||
|
||||
The `app-sizing-nomad` target plugin reports on the current task resource value
|
||||
as well as submits recommendations to Nomad via the [recommendations API endpoint][nomad_recommendations_api]
|
||||
based on the result of the Dynamic Application Sizing strategy calculations.
|
||||
|
||||
<EnterpriseAlert>
|
||||
This functionality only exists in Nomad Autoscaler Enterprise. This is not
|
||||
present in the open source version of Nomad Autoscaler.
|
||||
</EnterpriseAlert>
|
||||
|
||||
~> Note that currently Prometheus is the only APM available for Dynamic Application Sizing
|
||||
|
||||
The `app-sizing-nomad` target plugin reports on the current task resource value
|
||||
as well as submits recommendations to Nomad via the [recommendations API endpoint][nomad_recommendations_api]
|
||||
based on the result of the Dynamic Application Sizing strategy calculations.
|
||||
Note that currently Prometheus is the only APM available for dynamic application sizing.
|
||||
|
||||
## Agent Configuration Options
|
||||
|
||||
|
||||
@@ -183,11 +183,11 @@ scaling "azure_cluster_policy" {
|
||||
}
|
||||
```
|
||||
|
||||
## Task (DAS) `policy` Options
|
||||
## Task `policy` options for dynamic application sizing
|
||||
|
||||
<EnterpriseAlert>
|
||||
This functionality only exists in Nomad Autoscaler Enterprise. This is not
|
||||
present in the open source version of Nomad Autoscaler.
|
||||
present in the Community Edition of Nomad Autoscaler.
|
||||
</EnterpriseAlert>
|
||||
|
||||
The following options are available when using the Nomad Autoscaler Enterprise
|
||||
|
||||
@@ -119,6 +119,11 @@
|
||||
},
|
||||
{
|
||||
"title": "License",
|
||||
"badge": {
|
||||
"text": "ENT",
|
||||
"type": "outlined",
|
||||
"color": "neutral"
|
||||
},
|
||||
"path": "operator/license"
|
||||
},
|
||||
{
|
||||
@@ -139,6 +144,11 @@
|
||||
},
|
||||
{
|
||||
"title": "Utilization Reporting",
|
||||
"badge": {
|
||||
"text": "ENT",
|
||||
"type": "outlined",
|
||||
"color": "neutral"
|
||||
},
|
||||
"path": "operator/utilization"
|
||||
}
|
||||
]
|
||||
@@ -149,10 +159,20 @@
|
||||
},
|
||||
{
|
||||
"title": "Quotas",
|
||||
"badge": {
|
||||
"text": "ENT",
|
||||
"type": "outlined",
|
||||
"color": "neutral"
|
||||
},
|
||||
"path": "quotas"
|
||||
},
|
||||
{
|
||||
"title": "Recommendations",
|
||||
"badge": {
|
||||
"text": "ENT",
|
||||
"type": "outlined",
|
||||
"color": "neutral"
|
||||
},
|
||||
"path": "recommendations"
|
||||
},
|
||||
{
|
||||
@@ -169,6 +189,11 @@
|
||||
},
|
||||
{
|
||||
"title": "Sentinel Policies",
|
||||
"badge": {
|
||||
"text": "ENT",
|
||||
"type": "outlined",
|
||||
"color": "neutral"
|
||||
},
|
||||
"path": "sentinel-policies"
|
||||
},
|
||||
{
|
||||
|
||||
@@ -682,6 +682,11 @@
|
||||
},
|
||||
{
|
||||
"title": "utilization",
|
||||
"badge": {
|
||||
"text": "ENT",
|
||||
"type": "outlined",
|
||||
"color": "neutral"
|
||||
},
|
||||
"path": "operator/utilization"
|
||||
}
|
||||
]
|
||||
|
||||
@@ -720,6 +720,11 @@
|
||||
},
|
||||
{
|
||||
"title": "Configure multi-region deployments",
|
||||
"badge": {
|
||||
"text": "ENT",
|
||||
"type": "outlined",
|
||||
"color": "neutral"
|
||||
},
|
||||
"path": "job-declare/multiregion"
|
||||
},
|
||||
{
|
||||
@@ -920,6 +925,11 @@
|
||||
},
|
||||
{
|
||||
"title": "audit",
|
||||
"badge": {
|
||||
"text": "ENT",
|
||||
"type": "outlined",
|
||||
"color": "neutral"
|
||||
},
|
||||
"path": "configuration/audit"
|
||||
},
|
||||
{
|
||||
@@ -965,6 +975,11 @@
|
||||
},
|
||||
{
|
||||
"title": "reporting",
|
||||
"badge": {
|
||||
"text": "ENT",
|
||||
"type": "outlined",
|
||||
"color": "neutral"
|
||||
},
|
||||
"path": "configuration/reporting"
|
||||
},
|
||||
{
|
||||
@@ -977,6 +992,11 @@
|
||||
},
|
||||
{
|
||||
"title": "sentinel",
|
||||
"badge": {
|
||||
"text": "ENT",
|
||||
"type": "outlined",
|
||||
"color": "neutral"
|
||||
},
|
||||
"path": "configuration/sentinel"
|
||||
},
|
||||
{
|
||||
@@ -1110,6 +1130,11 @@
|
||||
},
|
||||
{
|
||||
"title": "multiregion",
|
||||
"badge": {
|
||||
"text": "ENT",
|
||||
"type": "outlined",
|
||||
"color": "neutral"
|
||||
},
|
||||
"path": "job-specification/multiregion"
|
||||
},
|
||||
{
|
||||
@@ -1118,6 +1143,11 @@
|
||||
},
|
||||
{
|
||||
"title": "numa",
|
||||
"badge": {
|
||||
"text": "ENT",
|
||||
"type": "outlined",
|
||||
"color": "neutral"
|
||||
},
|
||||
"path": "job-specification/numa"
|
||||
},
|
||||
{
|
||||
@@ -1150,6 +1180,11 @@
|
||||
},
|
||||
{
|
||||
"title": "schedule",
|
||||
"badge": {
|
||||
"text": "ENT",
|
||||
"type": "outlined",
|
||||
"color": "neutral"
|
||||
},
|
||||
"path": "job-specification/schedule"
|
||||
},
|
||||
{
|
||||
@@ -1227,6 +1262,11 @@
|
||||
},
|
||||
{
|
||||
"title": "Resource quota",
|
||||
"badge": {
|
||||
"text": "ENT",
|
||||
"type": "outlined",
|
||||
"color": "neutral"
|
||||
},
|
||||
"path": "other-specifications/quota"
|
||||
},
|
||||
{
|
||||
@@ -1281,6 +1321,11 @@
|
||||
},
|
||||
{
|
||||
"title": "Sentinel policy",
|
||||
"badge": {
|
||||
"text": "ENT",
|
||||
"type": "outlined",
|
||||
"color": "neutral"
|
||||
},
|
||||
"path": "reference/sentinel-policy"
|
||||
},
|
||||
{
|
||||
|
||||
@@ -74,6 +74,11 @@
|
||||
},
|
||||
{
|
||||
"title": "dynamic_application_sizing",
|
||||
"badge": {
|
||||
"text": "ENT",
|
||||
"type": "outlined",
|
||||
"color": "neutral"
|
||||
},
|
||||
"path": "autoscaling/agent/dynamic_application_sizing"
|
||||
},
|
||||
{
|
||||
@@ -163,14 +168,29 @@
|
||||
},
|
||||
{
|
||||
"title": "Dynamic Application Sizing Average",
|
||||
"badge": {
|
||||
"text": "ENT",
|
||||
"type": "outlined",
|
||||
"color": "neutral"
|
||||
},
|
||||
"path": "autoscaling/plugins/strategy/app-sizing-avg"
|
||||
},
|
||||
{
|
||||
"title": "Dynamic Application Sizing Max",
|
||||
"badge": {
|
||||
"text": "ENT",
|
||||
"type": "outlined",
|
||||
"color": "neutral"
|
||||
},
|
||||
"path": "autoscaling/plugins/strategy/app-sizing-max"
|
||||
},
|
||||
{
|
||||
"title": "Dynamic Application Sizing Percentile",
|
||||
"badge": {
|
||||
"text": "ENT",
|
||||
"type": "outlined",
|
||||
"color": "neutral"
|
||||
},
|
||||
"path": "autoscaling/plugins/strategy/app-sizing-percentile"
|
||||
},
|
||||
{
|
||||
@@ -208,6 +228,11 @@
|
||||
},
|
||||
{
|
||||
"title": "Dynamic Application Sizing",
|
||||
"badge": {
|
||||
"text": "ENT",
|
||||
"type": "outlined",
|
||||
"color": "neutral"
|
||||
},
|
||||
"path": "autoscaling/plugins/target/app-sizing-nomad"
|
||||
},
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user