mirror of
https://github.com/kemko/nomad.git
synced 2026-01-01 16:05:42 +03:00
Docs: Nomad IA (#26063)
* Move commands from docs to its own root-level directory * temporarily use modified dev-portal branch with nomad ia changes * explicitly clone nomad ia exp branch * retrigger build, fixed dev-portal broken build * architecture, concepts and get started individual pages * fix get started section destinations * reference section * update repo comment in website-build.sh to show branch * docs nav file update capitalization * update capitalization to force deploy * remove nomad-vs-kubernetes dir; move content to what is nomad pg * job section * Nomad operations category, deploy section * operations category, govern section * operations - manage * operations/scale; concepts scheduling fix * networking * monitor * secure section * remote auth-methods folder and move up pages to sso; linkcheck * Fix install2deploy redirects * fix architecture redirects * Job section: Add missing section index pages * Add section index pages so breadcrumbs build correctly * concepts/index fix front matter indentation * move task driver plugin config to new deploy section * Finish adding full URL to tutorials links in nav * change SSO to Authentication in nav and file system * Docs NomadIA: Move tutorials into NomadIA branch (#26132) * Move governance and policy from tutorials to docs * Move tutorials content to job-declare section * run jobs section * stateful workloads * advanced job scheduling * deploy section * manage section * monitor section * secure/acl and secure/authorization * fix example that contains an unseal key in real format * remove images from sso-vault * secure/traffic * secure/workload-identities * vault-acl change unseal key and root token in command output sample * remove lines from sample output * fix front matter * move nomad pack tutorials to tools * search/replace /nomad/tutorials links * update acl overview with content from deleted architecture/acl * fix spelling mistake * linkcheck - fix broken links * fix link to Nomad variables tutorial * fix link to Prometheus tutorial * move who uses Nomad to use cases page; move spec/config shortcuts add dividers * Move Consul out of Integrations; move namespaces to govern * move integrations/vault to secure/vault; delete integrations * move ref arch to docs; rename Deploy Nomad back to Install Nomad * address feedback * linkcheck fixes * Fixed raw_exec redirect * add info from /nomad/tutorials/manage-jobs/jobs * update page content with newer tutorial * link updates for architecture sub-folders * Add redirects for removed section index pages. Fix links. * fix broken links from linkcheck * Revert to use dev-portal main branch instead of nomadIA branch * build workaround: add intro-nav-data.json with single entry * fix content-check error * add intro directory to get around Vercel build error * workound for emtpry directory * remove mdx from /intro/ to fix content-check and git snafu * Add intro index.mdx so Vercel build should work --------- Co-authored-by: Tu Nguyen <im2nguyen@gmail.com>
This commit is contained in:
Aimee Ukasick
@@ -359,7 +359,7 @@ $ curl \
|
||||
```
|
||||
|
||||
[private key jwt]: https://oauth.net/private-key-jwt/
|
||||
[concepts-assertions]: /nomad/docs/concepts/acl/auth-methods/oidc#client-assertions
|
||||
[concepts-assertions]: /nomad/docs/secure/authentication/oidc#client-assertions
|
||||
[x5t]: https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.7
|
||||
[x5t#S256]: https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.8
|
||||
[pkce]: https://oauth.net/2/pkce/
|
||||
|
||||
@@ -16,7 +16,7 @@ An operator created token can be provided in the body of the request to bootstra
|
||||
if required. If no header is provided the cluster will return a generated management token.
|
||||
The provided token should be presented in a UUID format.
|
||||
This request is always forwarded to the authoritative region. It can only be invoked once
|
||||
until a [bootstrap reset](/nomad/tutorials/access-control/access-control-bootstrap#re-bootstrap-acl-system) is performed.
|
||||
until a [bootstrap reset](/nomad/docs/secure/acl/bootstrap#re-bootstrap-acl-system) is performed.
|
||||
|
||||
| Method | Path | Produces |
|
||||
| ------ | ------------------- | ------------------ |
|
||||
|
||||
@@ -444,4 +444,4 @@ $ curl \
|
||||
```
|
||||
|
||||
[update_scheduler_configuration]: /nomad/api-docs/operator/scheduler#update-scheduler-configuration
|
||||
[metrics reference]: /nomad/docs/operations/metrics-reference
|
||||
[metrics reference]: /nomad/docs/reference/metrics
|
||||
|
||||
@@ -727,5 +727,5 @@ specific response codes are returned but all clients should handle the following
|
||||
- 404 indicates an unknown resource.
|
||||
- 5xx means that the client should not expect the request to succeed if retried.
|
||||
|
||||
[cli_operator_api]: /nomad/docs/commands/operator/api
|
||||
[cli_operator_api_filter]: /nomad/docs/commands/operator/api#filter
|
||||
[cli_operator_api]: /nomad/commands/operator/api
|
||||
[cli_operator_api_filter]: /nomad/commands/operator/api#filter
|
||||
|
||||
@@ -33,10 +33,10 @@ The [`nomad job run -json`][job-run-json] flag submits a JSON formatted job:
|
||||
$ nomad job run -json example.json
|
||||
```
|
||||
|
||||
[job-inspect]: /nomad/docs/commands/job/inspect
|
||||
[job-output]: /nomad/docs/commands/job/run#output
|
||||
[job-inspect]: /nomad/commands/job/inspect
|
||||
[job-output]: /nomad/commands/job/run#output
|
||||
[job-parse]: /nomad/api-docs/jobs#parse-job
|
||||
[job-run-json]: /nomad/docs/commands/job/run#json
|
||||
[job-run-json]: /nomad/commands/job/run#json
|
||||
|
||||
## Syntax
|
||||
|
||||
@@ -307,7 +307,7 @@ The `Job` object supports the following keys:
|
||||
- `Type` - Specifies the job type and switches which scheduler
|
||||
is used. Nomad provides the `service`, `system` and `batch` schedulers,
|
||||
and defaults to `service`. To learn more about each scheduler type visit
|
||||
[here](/nomad/docs/schedulers)
|
||||
[here](/nomad/docs/concepts/scheduling/schedulers)
|
||||
|
||||
- `Update` - Specifies an update strategy to be applied to all task groups
|
||||
within the job. When specified both at the job level and the task group level,
|
||||
@@ -482,13 +482,13 @@ The `Task` object supports the following keys:
|
||||
to. The file is written relative to the task's local directory.
|
||||
|
||||
- `Driver` - Specifies the task driver that should be used to run the
|
||||
task. See the [driver documentation](/nomad/docs/drivers) for what
|
||||
task. See the [driver documentation](/nomad/docs/job-declare/task-driver) for what
|
||||
is available. Examples include `docker`, `qemu`, `java`, and `exec`.
|
||||
|
||||
- `Env` - A map of key-value representing environment variables that
|
||||
will be passed along to the running process. Nomad variables are
|
||||
interpreted when set in the environment variable values. See the table of
|
||||
interpreted variables [here](/nomad/docs/runtime/interpolation).
|
||||
interpreted variables [here](/nomad/docs/reference/runtime-variable-interpolation).
|
||||
|
||||
For example the below environment map will be reinterpreted:
|
||||
|
||||
@@ -540,7 +540,7 @@ The `Task` object supports the following keys:
|
||||
Consul for service discovery. A `Service` object represents a routable and
|
||||
discoverable service on the network. Nomad automatically registers when a task
|
||||
is started and de-registers it when the task transitions to the dead state.
|
||||
[Click here](/nomad/docs/integrations/consul-integration#service-discovery) to learn more about
|
||||
[Click here](/nomad/docs/networking/service-discovery) to learn more about
|
||||
services. Below is the fields in the `Service` object:
|
||||
|
||||
- `Name`: An explicit name for the Service. Nomad will replace `${JOB}`,
|
||||
@@ -887,7 +887,7 @@ An example `Update` block:
|
||||
The `Constraint` object supports the following keys:
|
||||
|
||||
- `LTarget` - Specifies the attribute to examine for the
|
||||
constraint. See the table of attributes [here](/nomad/docs/runtime/interpolation#interpreted_node_vars).
|
||||
constraint. See the table of attributes [here](/nomad/docs/reference/runtime-variable-interpolation#interpreted_node_vars).
|
||||
|
||||
- `RTarget` - Specifies the value to compare the attribute against.
|
||||
This can be a literal value, another attribute or a regular expression if
|
||||
@@ -937,7 +937,7 @@ are described in [affinities](/nomad/docs/job-specification/affinity)
|
||||
The `Affinity` object supports the following keys:
|
||||
|
||||
- `LTarget` - Specifies the attribute to examine for the
|
||||
affinity. See the table of attributes [here](/nomad/docs/runtime/interpolation#interpreted_node_vars).
|
||||
affinity. See the table of attributes [here](/nomad/docs/reference/runtime-variable-interpolation#interpreted_node_vars).
|
||||
|
||||
- `RTarget` - Specifies the value to compare the attribute against.
|
||||
This can be a literal value, another attribute or a regular expression if
|
||||
@@ -1205,7 +1205,7 @@ in [spread](/nomad/docs/job-specification/spread).
|
||||
The `Spread` object supports the following keys:
|
||||
|
||||
- `Attribute` - Specifies the attribute to examine for the
|
||||
spread. See the [table of attributes](/nomad/docs/runtime/interpolation#interpreted_node_vars) for examples.
|
||||
spread. See the [table of attributes](/nomad/docs/reference/runtime-variable-interpolation#interpreted_node_vars) for examples.
|
||||
|
||||
- `SpreadTarget` - Specifies a list of attribute values and percentages. This is an optional field, when
|
||||
left empty Nomad will evenly spread allocations across values of the attribute.
|
||||
@@ -1242,6 +1242,6 @@ The `Scaling` object supports the following keys:
|
||||
autoscaler (e.g., [nomad-autoscaler](https://github.com/hashicorp/nomad-autoscaler)).
|
||||
|
||||
[ct]: https://github.com/hashicorp/consul-template 'Consul Template by HashiCorp'
|
||||
[drain]: /nomad/docs/commands/node/drain
|
||||
[env]: /nomad/docs/runtime/environment 'Nomad Runtime Environment'
|
||||
[drain]: /nomad/commands/node/drain
|
||||
[env]: /nomad/docs/reference/runtime-environment-settings 'Nomad Runtime Environment'
|
||||
[Workload Identity]: /nomad/docs/concepts/workload-identity 'Nomad Workload Identity'
|
||||
|
||||
@@ -948,7 +948,7 @@ $ curl \
|
||||
This endpoint toggles the drain mode of the node. When draining is enabled, no
|
||||
further allocations will be assigned to this node, and existing allocations will
|
||||
be migrated to new nodes. See the [Workload Migration
|
||||
Guide](/nomad/tutorials/manage-clusters/node-drain) for suggested usage.
|
||||
Guide](/nomad/docs/manage/migrate-workloads) for suggested usage.
|
||||
|
||||
| Method | Path | Produces |
|
||||
| ------ | ------------------------- | ------------------ |
|
||||
|
||||
@@ -14,9 +14,9 @@ as interacting with the Raft subsystem, licensing, snapshots, autopilot and sche
|
||||
~> Use this interface with extreme caution, as improper use could lead to a
|
||||
Nomad outage and even loss of data.
|
||||
|
||||
See the [Outage Recovery](/nomad/tutorials/manage-clusters/outage-recovery) guide for some examples of how
|
||||
See the [Outage Recovery](/nomad/docs/manage/outage-recovery) guide for some examples of how
|
||||
these capabilities are used. For a CLI to perform these operations manually,
|
||||
please see the documentation for the
|
||||
[`nomad operator`](/nomad/docs/commands/operator) command.
|
||||
[`nomad operator`](/nomad/commands/operator) command.
|
||||
|
||||
Please choose a sub-section in the navigation for more information
|
||||
|
||||
@@ -256,8 +256,8 @@ $ curl \
|
||||
```
|
||||
|
||||
|
||||
[Key Management]: /nomad/docs/operations/key-management
|
||||
[`nomad operator root keyring`]: /nomad/docs/commands/operator/root/keyring-rotate
|
||||
[Key Management]: /nomad/docs/manage/key-management
|
||||
[`nomad operator root keyring`]: /nomad/commands/operator/root/keyring-rotate
|
||||
[blocking queries]: /nomad/api-docs#blocking-queries
|
||||
[oidc-disco]: https://openid.net/specs/openid-connect-discovery-1_0.html
|
||||
[oidc_issuer]: /nomad/docs/configuration/server#oidc_issuer
|
||||
|
||||
@@ -216,4 +216,4 @@ $ curl --request PUT \
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
[consensus protocol guide]: /nomad/docs/concepts/consensus
|
||||
[consensus protocol guide]: /nomad/docs/architecture/cluster/consensus
|
||||
|
||||
@@ -11,7 +11,7 @@ description: |-
|
||||
|
||||
This endpoint generates and returns an atomic, point-in-time snapshot of the
|
||||
Nomad server state for disaster recovery. Snapshots include all state managed by Nomad's
|
||||
Raft [consensus protocol](/nomad/docs/concepts/consensus).
|
||||
Raft [consensus protocol](/nomad/docs/architecture/cluster/consensus).
|
||||
|
||||
Snapshots are exposed as gzipped tar archives which internally contain the Raft
|
||||
metadata required to restore, as well as a binary serialized version of the
|
||||
|
||||
@@ -181,5 +181,5 @@ $ nomad operator api \
|
||||
|
||||
[`identity`]: /nomad/docs/job-specification/identity
|
||||
[`vault`]: /nomad/docs/job-specification/vault
|
||||
[nomad_acl_vault_wid]: /nomad/docs/integrations/vault/acl#nomad-workload-identities
|
||||
[nomad_acl_vault_wid]: /nomad/docs/secure/vault/acl#nomad-workload-identities
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ reporting bundles for Nomad Enterprise.
|
||||
|
||||
<EnterpriseAlert />
|
||||
|
||||
## Generate Nomad Enterprise Utilization Report Buindle
|
||||
## Generate Nomad Enterprise Utilization Report Bundle
|
||||
|
||||
This endpoint generates a utilization report. If Nomad did not record a
|
||||
utilization snapshot in the previous 24 hours, Nomad records a utilization
|
||||
@@ -56,4 +56,4 @@ API, decodes this to a human-readable file in the current working directory.
|
||||
|
||||
[blocking queries]: /nomad/api-docs#blocking-queries
|
||||
[required ACLs]: /nomad/api-docs#acls
|
||||
[`nomad operator utilization`]: /nomad/docs/command/operator/utilization
|
||||
[`nomad operator utilization`]: /nomad/commands/operator/utilization
|
||||
|
||||
@@ -9,7 +9,7 @@ description: >-
|
||||
# Sentinel Policies HTTP API
|
||||
|
||||
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/tutorials/governance-and-policy/sentinel).
|
||||
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).
|
||||
|
||||
|
||||
@@ -97,12 +97,12 @@ $ nomad node status -filter 'Meta.example == "Hello World!"'
|
||||
- Using the Task API Unix Domain Socket on Windows [requires][windows] Windows
|
||||
build 17063 or later.
|
||||
|
||||
[acl]: /nomad/docs/concepts/acl/
|
||||
[acl-tokens]: /nomad/docs/concepts/acl/#token
|
||||
[alloc-exec]: /nomad/docs/commands/alloc/exec
|
||||
[anon]: /nomad/tutorials/access-control/access-control#acl-policies
|
||||
[acl]: /nomad/docs/secure/acl/
|
||||
[acl-tokens]: /nomad/docs/secure/acl/#tokens
|
||||
[alloc-exec]: /nomad/commands/alloc/exec
|
||||
[anon]: /nomad/docs/secure/acl#policies
|
||||
[bind_addr]: /nomad/docs/configuration
|
||||
[mTLS]: /nomad/tutorials/transport-security/security-enable-tls
|
||||
[mTLS]: /nomad/docs/secure/traffic/tls
|
||||
[task-user]: /nomad/docs/job-specification/task#user
|
||||
[workload-id]: /nomad/docs/concepts/workload-identity
|
||||
[windows]: https://devblogs.microsoft.com/commandline/af_unix-comes-to-windows/
|
||||
|
||||
@@ -17,5 +17,5 @@ documentation for the [`nomad var`][] commands.
|
||||
|
||||
Please choose a sub-section in the navigation for more information
|
||||
|
||||
[`nomad var`]: /nomad/docs/commands/var
|
||||
[Variables]: /nomad/docs/concepts/variables
|
||||
[`nomad var`]: /nomad/commands/var
|
||||
[Variables]: /nomad/docs/concepts/variables
|
||||
|
||||
@@ -21,17 +21,17 @@ it through the use of a parameter defining the operation to be performed.
|
||||
|
||||
The lock operation parameter can be:
|
||||
|
||||
- `lock-acquire`: When used, the call will introduce a lock over the variable if
|
||||
it exists, or create a new one if it doesn't. The lock ID will be returned in the
|
||||
response and it must be provided to perform any other operation over the lock.
|
||||
- `lock-acquire`: When used, the call will introduce a lock over the variable if
|
||||
it exists, or create a new one if it doesn't. The lock ID will be returned in the
|
||||
response and it must be provided to perform any other operation over the lock.
|
||||
The variable items can be updated at any time using the lock ID, but the lock
|
||||
parameters are unmmutable, attempting to modify them while a lock is present will
|
||||
generate an error.
|
||||
generate an error.
|
||||
|
||||
In the case of attempting to acquire a variable that is already locked, a conflict
|
||||
response will be returned.
|
||||
response will be returned.
|
||||
|
||||
The lock-acquire operation will override the variable items if new values are
|
||||
The lock-acquire operation will override the variable items if new values are
|
||||
present.
|
||||
|
||||
|
||||
@@ -62,7 +62,7 @@ $ curl \
|
||||
|
||||
#### Sample Response
|
||||
|
||||
The response body returns the created or updated variable including the lock
|
||||
The response body returns the created or updated variable including the lock
|
||||
parameters and ID, along with metadata created by the server:
|
||||
|
||||
```json
|
||||
@@ -88,7 +88,7 @@ parameters and ID, along with metadata created by the server:
|
||||
- `lock-renew`: A valid call to lock renew needs to be placed before the lock's
|
||||
TTL is up in order to mantain the variable locked. A valid call must include the
|
||||
lock ID as part of the request body. If the lock TTL is up without a renewal or
|
||||
release calls, the variable will remain unlockable for at least the lock delay.
|
||||
release calls, the variable will remain unlockable for at least the lock delay.
|
||||
|
||||
#### Sample Request
|
||||
|
||||
@@ -132,8 +132,8 @@ parameters:
|
||||
```
|
||||
|
||||
- `lock-release`: A call to the endpoint with the `lock-release` operation will
|
||||
immediately remove the lock over the variable, making it modifiable without
|
||||
restrictions again.
|
||||
immediately remove the lock over the variable, making it modifiable without
|
||||
restrictions again.
|
||||
|
||||
The lock-release operation will not override the variable items, if the request
|
||||
body contains any item, it will generate a bad request response.
|
||||
@@ -197,15 +197,15 @@ will include only metadata and not the `Items` field:
|
||||
|
||||
## Restrictions
|
||||
|
||||
When creating a new variable using the lock-acquire operation, all the known
|
||||
[restrictions][] regarding the path and size of the content apply, but unlike
|
||||
When creating a new variable using the lock-acquire operation, all the known
|
||||
[restrictions][] regarding the path and size of the content apply, but unlike
|
||||
regular variables, locked variables can be created with or without any items.
|
||||
|
||||
The lock TTL and Delay must be values between 10 seconds and 24 hours.
|
||||
|
||||
[Variables]: /nomad/docs/concepts/variables
|
||||
[restrictions]: /nomad/api-docs/variables/variables#restrictions
|
||||
[`nomad var`]: /nomad/docs/commands/var
|
||||
[`nomad var`]: /nomad/commands/var
|
||||
[blocking queries]: /nomad/api-docs#blocking-queries
|
||||
[required ACLs]: /nomad/api-docs#acls
|
||||
[RFC3986]: https://www.rfc-editor.org/rfc/rfc3986#section-2
|
||||
|
||||
@@ -1219,6 +1219,6 @@ $ curl \
|
||||
[required ACLs]: /nomad/api-docs#acls
|
||||
[csi]: https://github.com/container-storage-interface/spec
|
||||
[csi_plugin]: /nomad/docs/job-specification/csi_plugin
|
||||
[csi_plugins_internals]: /nomad/docs/concepts/plugins/storage/csi
|
||||
[csi_plugins_internals]: /nomad/docs/architecture/storage/csi
|
||||
[Create CSI Volume]: #create-csi-volume
|
||||
[Volume Expansion]: /nomad/docs/other-specifications/volume/csi#volume-expansion
|
||||
|
||||
@@ -50,33 +50,33 @@ subcommands are available:
|
||||
- [`acl token self`][tokenself] - Get info on self ACL token
|
||||
- [`acl token update`][tokenupdate] - Update existing ACL token
|
||||
|
||||
[bootstrap]: /nomad/docs/commands/acl/bootstrap
|
||||
[authmethodcreate]: /nomad/docs/commands/acl/auth-method/create
|
||||
[authmethoddelete]: /nomad/docs/commands/acl/auth-method/delete
|
||||
[authmethodinfo]: /nomad/docs/commands/acl/auth-method/info
|
||||
[authmethodlist]: /nomad/docs/commands/acl/auth-method/list
|
||||
[authmethodupdate]: /nomad/docs/commands/acl/auth-method/update
|
||||
[bindingrulecreate]: /nomad/docs/commands/acl/binding-rule/create
|
||||
[bindingruledelete]: /nomad/docs/commands/acl/binding-rule/delete
|
||||
[bindingruleinfo]: /nomad/docs/commands/acl/binding-rule/info
|
||||
[bindingrulelist]: /nomad/docs/commands/acl/binding-rule/list
|
||||
[bindingruleupdate]: /nomad/docs/commands/acl/binding-rule/update
|
||||
[policyapply]: /nomad/docs/commands/acl/policy/apply
|
||||
[policydelete]: /nomad/docs/commands/acl/policy/delete
|
||||
[policyinfo]: /nomad/docs/commands/acl/policy/info
|
||||
[policylist]: /nomad/docs/commands/acl/policy/list
|
||||
[policyself]: /nomad/docs/commands/acl/policy/self
|
||||
[tokencreate]: /nomad/docs/commands/acl/token/create
|
||||
[tokenupdate]: /nomad/docs/commands/acl/token/update
|
||||
[tokendelete]: /nomad/docs/commands/acl/token/delete
|
||||
[tokeninfo]: /nomad/docs/commands/acl/token/info
|
||||
[tokenlist]: /nomad/docs/commands/acl/token/list
|
||||
[tokenself]: /nomad/docs/commands/acl/token/self
|
||||
[rolecreate]: /nomad/docs/commands/acl/role/create
|
||||
[roleupdate]: /nomad/docs/commands/acl/role/update
|
||||
[roledelete]: /nomad/docs/commands/acl/role/delete
|
||||
[roleinfo]: /nomad/docs/commands/acl/role/info
|
||||
[rolelist]: /nomad/docs/commands/acl/role/list
|
||||
[bootstrap]: /nomad/commands/acl/bootstrap
|
||||
[authmethodcreate]: /nomad/commands/acl/auth-method/create
|
||||
[authmethoddelete]: /nomad/commands/acl/auth-method/delete
|
||||
[authmethodinfo]: /nomad/commands/acl/auth-method/info
|
||||
[authmethodlist]: /nomad/commands/acl/auth-method/list
|
||||
[authmethodupdate]: /nomad/commands/acl/auth-method/update
|
||||
[bindingrulecreate]: /nomad/commands/acl/binding-rule/create
|
||||
[bindingruledelete]: /nomad/commands/acl/binding-rule/delete
|
||||
[bindingruleinfo]: /nomad/commands/acl/binding-rule/info
|
||||
[bindingrulelist]: /nomad/commands/acl/binding-rule/list
|
||||
[bindingruleupdate]: /nomad/commands/acl/binding-rule/update
|
||||
[policyapply]: /nomad/commands/acl/policy/apply
|
||||
[policydelete]: /nomad/commands/acl/policy/delete
|
||||
[policyinfo]: /nomad/commands/acl/policy/info
|
||||
[policylist]: /nomad/commands/acl/policy/list
|
||||
[policyself]: /nomad/commands/acl/policy/self
|
||||
[tokencreate]: /nomad/commands/acl/token/create
|
||||
[tokenupdate]: /nomad/commands/acl/token/update
|
||||
[tokendelete]: /nomad/commands/acl/token/delete
|
||||
[tokeninfo]: /nomad/commands/acl/token/info
|
||||
[tokenlist]: /nomad/commands/acl/token/list
|
||||
[tokenself]: /nomad/commands/acl/token/self
|
||||
[rolecreate]: /nomad/commands/acl/role/create
|
||||
[roleupdate]: /nomad/commands/acl/role/update
|
||||
[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/tutorials/manage-clusters/federation
|
||||
[federated]: //nomad/docs/deploy/clusters/federate-regions
|
||||
[`authoritative_region`]: /nomad/docs/configuration/server#authoritative_region
|
||||
@@ -230,7 +230,7 @@ You may, however, may pass the following configuration options as CLI arguments:
|
||||
[data_dir]: /nomad/docs/configuration#data_dir
|
||||
[datacenter]: /nomad/docs/configuration#datacenter
|
||||
[enabled]: /nomad/docs/configuration/acl#enabled
|
||||
[encryption overview]: /nomad/tutorials/transport-security/security-gossip-encryption
|
||||
[encryption overview]: /nomad/docs/secure/traffic/gossip-encryption
|
||||
[key_file]: /nomad/docs/configuration/consul#key_file
|
||||
[log_include_location]: /nomad/docs/configuration#log_include_location
|
||||
[log_json]: /nomad/docs/configuration#log_json
|
||||
@@ -240,7 +240,7 @@ You may, however, may pass the following configuration options as CLI arguments:
|
||||
[network_interface]: /nomad/docs/configuration/client#network_interface
|
||||
[node_class]: /nomad/docs/configuration/client#node_class
|
||||
[node_pool]: /nomad/docs/configuration/client#node_pool
|
||||
[Operating Nomad agents]: /nomad/docs/operations/nomad-agent
|
||||
[Operating Nomad agents]: /nomad/docs/deploy/nomad-agent
|
||||
[Nomad agent configuration]: /nomad/docs/configuration
|
||||
[plugin_dir]: /nomad/docs/configuration#plugin_dir
|
||||
[region]: /nomad/docs/configuration#region
|
||||
@@ -114,4 +114,4 @@ bam
|
||||
|
||||
@include 'general_options.mdx'
|
||||
|
||||
[allocation working directory]: /nomad/docs/runtime/environment#task-directories 'Task Directories'
|
||||
[allocation working directory]: /nomad/docs/reference/runtime-environment-settings#task-directories 'Task Directories'
|
||||
@@ -25,11 +25,11 @@ subcommands are available:
|
||||
- [`alloc status`][status] - Display allocation status information and metadata
|
||||
- [`alloc stop`][stop] - Stop and reschedule a running allocation
|
||||
|
||||
[checks]: /nomad/docs/commands/alloc/checks 'Outputs service health check status information'
|
||||
[exec]: /nomad/docs/commands/alloc/exec 'Run a command in a running allocation'
|
||||
[fs]: /nomad/docs/commands/alloc/fs 'Inspect the contents of an allocation directory'
|
||||
[logs]: /nomad/docs/commands/alloc/logs 'Streams the logs of a task'
|
||||
[restart]: /nomad/docs/commands/alloc/restart 'Restart a running allocation or task'
|
||||
[signal]: /nomad/docs/commands/alloc/signal 'Signal a running allocation'
|
||||
[status]: /nomad/docs/commands/alloc/status 'Display allocation status information and metadata'
|
||||
[stop]: /nomad/docs/commands/alloc/stop 'Stop and reschedule a running allocation'
|
||||
[checks]: /nomad/commands/alloc/checks 'Outputs service health check status information'
|
||||
[exec]: /nomad/commands/alloc/exec 'Run a command in a running allocation'
|
||||
[fs]: /nomad/commands/alloc/fs 'Inspect the contents of an allocation directory'
|
||||
[logs]: /nomad/commands/alloc/logs 'Streams the logs of a task'
|
||||
[restart]: /nomad/commands/alloc/restart 'Restart a running allocation or task'
|
||||
[signal]: /nomad/commands/alloc/signal 'Signal a running allocation'
|
||||
[status]: /nomad/commands/alloc/status 'Display allocation status information and metadata'
|
||||
[stop]: /nomad/commands/alloc/stop 'Stop and reschedule a running allocation'
|
||||
@@ -65,6 +65,6 @@ $ nomad alloc stop -detach eb17e557
|
||||
|
||||
@include 'general_options.mdx'
|
||||
|
||||
[eval status]: /nomad/docs/commands/eval/status
|
||||
[eval status]: /nomad/commands/eval/status
|
||||
[`shutdown_delay`]: /nomad/docs/job-specification/group#shutdown_delay
|
||||
[system allocs will not]: /nomad/docs/job-specification/reschedule
|
||||
@@ -18,4 +18,4 @@ following subcommands are available:
|
||||
|
||||
- [`config validate`][validate] - Validate configuration files
|
||||
|
||||
[validate]: /nomad/docs/commands/config/validate 'Validate configuration files'
|
||||
[validate]: /nomad/commands/config/validate 'Validate configuration files'
|
||||
@@ -62,4 +62,4 @@ cache 3 2 1 0
|
||||
|
||||
@include 'general_options.mdx'
|
||||
|
||||
[eval status]: /nomad/docs/commands/eval/status
|
||||
[eval status]: /nomad/commands/eval/status
|
||||
@@ -23,9 +23,9 @@ subcommands are available:
|
||||
- [`deployment resume`][resume] - Resume a paused deployment
|
||||
- [`deployment status`][status] - Display the status of a deployment
|
||||
|
||||
[fail]: /nomad/docs/commands/deployment/fail 'Manually fail a deployment'
|
||||
[list]: /nomad/docs/commands/deployment/list 'List all deployments'
|
||||
[pause]: /nomad/docs/commands/deployment/pause 'Pause a deployment'
|
||||
[promote]: /nomad/docs/commands/deployment/promote 'Promote canaries in a deployment'
|
||||
[resume]: /nomad/docs/commands/deployment/resume 'Resume a paused deployment'
|
||||
[status]: /nomad/docs/commands/deployment/status 'Display the status of a deployment'
|
||||
[fail]: /nomad/commands/deployment/fail 'Manually fail a deployment'
|
||||
[list]: /nomad/commands/deployment/list 'List all deployments'
|
||||
[pause]: /nomad/commands/deployment/pause 'Pause a deployment'
|
||||
[promote]: /nomad/commands/deployment/promote 'Promote canaries in a deployment'
|
||||
[resume]: /nomad/commands/deployment/resume 'Resume a paused deployment'
|
||||
[status]: /nomad/commands/deployment/status 'Display the status of a deployment'
|
||||
@@ -222,5 +222,5 @@ ee8f972e 6240eed6 web 0 run running 07/25/17 18:37:08 UT
|
||||
|
||||
@include 'general_options.mdx'
|
||||
|
||||
[`job revert`]: /nomad/docs/commands/job/revert
|
||||
[eval status]: /nomad/docs/commands/eval/status
|
||||
[`job revert`]: /nomad/commands/job/revert
|
||||
[eval status]: /nomad/commands/eval/status
|
||||
@@ -53,4 +53,4 @@ Deployment "c848972e-dcd3-7354-e0d2-39d86642cdb1" resumed
|
||||
|
||||
@include 'general_options.mdx'
|
||||
|
||||
[eval status]: /nomad/docs/commands/eval/status
|
||||
[eval status]: /nomad/commands/eval/status
|
||||
@@ -71,5 +71,5 @@ cache 3 2 1 0
|
||||
|
||||
@include 'general_options.mdx'
|
||||
|
||||
[eval status]: /nomad/docs/commands/eval/status
|
||||
[federated regions]: /nomad/tutorials/manage-clusters/federation
|
||||
[eval status]: /nomad/commands/eval/status
|
||||
[federated regions]: //nomad/docs/deploy/clusters/federate-regions
|
||||
@@ -69,5 +69,5 @@ Successfully deleted 23 evaluations
|
||||
|
||||
@include 'general_options.mdx'
|
||||
|
||||
[scheduler_get_config]: /nomad/docs/commands/operator/scheduler/get-config
|
||||
[scheduler_set_config]: /nomad/docs/commands/operator/scheduler/set-config
|
||||
[scheduler_get_config]: /nomad/commands/operator/scheduler/get-config
|
||||
[scheduler_set_config]: /nomad/commands/operator/scheduler/set-config
|
||||
@@ -19,6 +19,6 @@ subcommands are available:
|
||||
- [`eval list`][list] - List all evals
|
||||
- [`eval status`][status] - Display the status of a eval
|
||||
|
||||
[delete]: /nomad/docs/commands/eval/delete 'Delete evals'
|
||||
[list]: /nomad/docs/commands/eval/list 'List all evals'
|
||||
[status]: /nomad/docs/commands/eval/status 'Display the status of a eval'
|
||||
[delete]: /nomad/commands/eval/delete 'Delete evals'
|
||||
[list]: /nomad/commands/eval/list 'List all evals'
|
||||
[status]: /nomad/commands/eval/status 'Display the status of a eval'
|
||||
@@ -68,7 +68,7 @@ c2b4606d-1b02-0d8d-5fdd-031167cd4c91
|
||||
```
|
||||
|
||||
Refer to the [Format Nomad Command Output With
|
||||
Templates](/nomad/tutorials/templates/format-output-with-templates) tutorial for
|
||||
Templates](/nomad/docs/manage/format-cli-output) tutorial for
|
||||
more examples of using Go templates to format Nomad CLI output.
|
||||
|
||||
## General options
|
||||
@@ -167,8 +167,8 @@ Evaluation ID = 31199841
|
||||
|
||||
@include 'general_options.mdx'
|
||||
|
||||
[eval status]: /nomad/docs/commands/eval/status
|
||||
[eval status]: /nomad/commands/eval/status
|
||||
[parameterized job]: /nomad/docs/job-specification/parameterized 'Nomad parameterized Job Specification'
|
||||
[multiregion]: /nomad/docs/job-specification/multiregion#parameterized-dispatch
|
||||
[`job_max_priority`]: /nomad/docs/configuration/server#job_max_priority
|
||||
[job parameters]: /nomad/docs/job-specification/job#job-parameters
|
||||
[job parameters]: /nomad/docs/job-specification/job#parameters
|
||||
@@ -75,4 +75,4 @@ $ nomad job eval -force-reschedule job1
|
||||
|
||||
@include 'general_options.mdx'
|
||||
|
||||
[eval status]: /nomad/docs/commands/eval/status
|
||||
[eval status]: /nomad/commands/eval/status
|
||||
@@ -38,23 +38,23 @@ subcommands are available:
|
||||
- [`job validate`][validate] - Check a job specification for syntax errors
|
||||
|
||||
|
||||
[action]: /nomad/docs/commands/job/action 'Execute predefined actions'
|
||||
[allocs]: /nomad/docs/commands/job/allocs 'List allocations for a job'
|
||||
[deployments]: /nomad/docs/commands/job/deployments 'List deployments for a job'
|
||||
[dispatch]: /nomad/docs/commands/job/dispatch 'Dispatch an instance of a parameterized job'
|
||||
[eval]: /nomad/docs/commands/job/eval 'Force an evaluation for a job'
|
||||
[history]: /nomad/docs/commands/job/history 'Display all tracked versions of a job'
|
||||
[init]: /nomad/docs/commands/job/init 'Create an example job specification'
|
||||
[inspect]: /nomad/docs/commands/job/inspect 'Inspect the contents of a submitted job'
|
||||
[periodic force]: /nomad/docs/commands/job/periodic-force 'Force the evaluation of a periodic job'
|
||||
[plan]: /nomad/docs/commands/job/plan 'Schedule a dry run for a job'
|
||||
[restart]: /nomad/docs/commands/job/restart 'Restart or reschedule allocations for a job'
|
||||
[revert]: /nomad/docs/commands/job/revert 'Revert to a prior version of the job'
|
||||
[run]: /nomad/docs/commands/job/run 'Submit a new job'
|
||||
[status]: /nomad/docs/commands/job/status 'Display status information about a job'
|
||||
[scale]: /nomad/docs/commands/job/scale 'Update the number of allocations for a task group in a job'
|
||||
[scaling-events]: /nomad/docs/commands/job/scaling-events 'List the recent scaling events for a job'
|
||||
[stop]: /nomad/docs/commands/job/stop 'Stop a running job and cancel its allocations'
|
||||
[tag]: /nomad/docs/commands/job/tag 'Tag a job with a version'
|
||||
[validate]: /nomad/docs/commands/job/validate 'Check a job specification for syntax errors'
|
||||
[promote]: /nomad/docs/commands/job/promote
|
||||
[action]: /nomad/commands/job/action 'Execute predefined actions'
|
||||
[allocs]: /nomad/commands/job/allocs 'List allocations for a job'
|
||||
[deployments]: /nomad/commands/job/deployments 'List deployments for a job'
|
||||
[dispatch]: /nomad/commands/job/dispatch 'Dispatch an instance of a parameterized job'
|
||||
[eval]: /nomad/commands/job/eval 'Force an evaluation for a job'
|
||||
[history]: /nomad/commands/job/history 'Display all tracked versions of a job'
|
||||
[init]: /nomad/commands/job/init 'Create an example job specification'
|
||||
[inspect]: /nomad/commands/job/inspect 'Inspect the contents of a submitted job'
|
||||
[periodic force]: /nomad/commands/job/periodic-force 'Force the evaluation of a periodic job'
|
||||
[plan]: /nomad/commands/job/plan 'Schedule a dry run for a job'
|
||||
[restart]: /nomad/commands/job/restart 'Restart or reschedule allocations for a job'
|
||||
[revert]: /nomad/commands/job/revert 'Revert to a prior version of the job'
|
||||
[run]: /nomad/commands/job/run 'Submit a new job'
|
||||
[status]: /nomad/commands/job/status 'Display status information about a job'
|
||||
[scale]: /nomad/commands/job/scale 'Update the number of allocations for a task group in a job'
|
||||
[scaling-events]: /nomad/commands/job/scaling-events 'List the recent scaling events for a job'
|
||||
[stop]: /nomad/commands/job/stop 'Stop a running job and cancel its allocations'
|
||||
[tag]: /nomad/commands/job/tag 'Tag a job with a version'
|
||||
[validate]: /nomad/commands/job/validate 'Check a job specification for syntax errors'
|
||||
[promote]: /nomad/commands/job/promote
|
||||
@@ -42,4 +42,4 @@ Example job file written to example.nomad.hcl
|
||||
```
|
||||
|
||||
[jobspec]: /nomad/docs/job-specification 'Nomad Job Specification'
|
||||
[drivers]: /nomad/docs/drivers 'Nomad Task Drivers documentation'
|
||||
[drivers]: /nomad/docs/job-declare/task-driver 'Nomad Task Drivers documentation'
|
||||
@@ -66,6 +66,6 @@ Evaluation ID: 0865fbf3-30de-5f53-0811-821e73e63178
|
||||
|
||||
@include 'general_options.mdx'
|
||||
|
||||
[eval status]: /nomad/docs/commands/eval/status
|
||||
[eval status]: /nomad/commands/eval/status
|
||||
[force the evaluation]: /nomad/api-docs/jobs#force-new-periodic-instance
|
||||
[periodic job]: /nomad/docs/job-specification/periodic
|
||||
@@ -239,5 +239,5 @@ if a change is detected.
|
||||
[job specification]: /nomad/docs/job-specification
|
||||
[hcl job specification]: /nomad/docs/job-specification
|
||||
[`go-getter`]: https://github.com/hashicorp/go-getter
|
||||
[`nomad job run -check-index`]: /nomad/docs/commands/job/run#check-index
|
||||
[`nomad job run -check-index`]: /nomad/commands/job/run#check-index
|
||||
[`tee`]: https://man7.org/linux/man-pages/man1/tee.1.html
|
||||
@@ -224,5 +224,5 @@ ee8f972e 6240eed6 web 0 run running 07/25/17 18:37:08 UT
|
||||
|
||||
@include 'general_options.mdx'
|
||||
|
||||
[job revert]: /nomad/docs/commands/job/revert
|
||||
[eval status]: /nomad/docs/commands/eval/status
|
||||
[job revert]: /nomad/commands/job/revert
|
||||
[eval status]: /nomad/commands/eval/status
|
||||
@@ -101,6 +101,6 @@ Submit Date = 07/25/17 21:27:18 UTC
|
||||
|
||||
@include 'general_options.mdx'
|
||||
|
||||
[`job history`]: /nomad/docs/commands/job/history
|
||||
[eval status]: /nomad/docs/commands/eval/status
|
||||
[run]: /nomad/docs/commands/job/run
|
||||
[`job history`]: /nomad/commands/job/history
|
||||
[eval status]: /nomad/commands/eval/status
|
||||
[run]: /nomad/commands/job/run
|
||||
@@ -209,10 +209,10 @@ $ nomad job run example.nomad.hcl
|
||||
|
||||
@include 'general_options.mdx'
|
||||
|
||||
[`batch`]: /nomad/docs/schedulers#batch
|
||||
[eval status]: /nomad/docs/commands/eval/status
|
||||
[`batch`]: /nomad/docs/concepts/scheduling/schedulers#batch
|
||||
[eval status]: /nomad/commands/eval/status
|
||||
[`go-getter`]: https://github.com/hashicorp/go-getter
|
||||
[`job plan` command]: /nomad/docs/commands/job/plan
|
||||
[`job plan` command]: /nomad/commands/job/plan
|
||||
[job specification]: /nomad/docs/job-specification
|
||||
[JSON jobs]: /nomad/api-docs/json-jobs
|
||||
[`system`]: /nomad/docs/schedulers#system
|
||||
[`system`]: /nomad/docs/concepts/scheduling/schedulers#system
|
||||
@@ -101,4 +101,4 @@ $ nomad job scale job1 group1 8
|
||||
|
||||
@include 'general_options.mdx'
|
||||
|
||||
[eval status]: /nomad/docs/commands/eval/status
|
||||
[eval status]: /nomad/commands/eval/status
|
||||
@@ -56,6 +56,6 @@ $ nomad job start example
|
||||
|
||||
@include 'general_options.mdx'
|
||||
|
||||
[eval status]: /nomad/docs/commands/eval/status
|
||||
[run]: /nomad/docs/commands/job/run
|
||||
[eval status]: /nomad/commands/eval/status
|
||||
[run]: /nomad/commands/job/run
|
||||
[Job statuses]: /nomad/docs/concepts/job#job-statuses
|
||||
@@ -125,6 +125,6 @@ $ nomad job stop -detach job1
|
||||
|
||||
@include 'general_options.mdx'
|
||||
|
||||
[eval status]: /nomad/docs/commands/eval/status
|
||||
[eval status]: /nomad/commands/eval/status
|
||||
[multi-region]: /nomad/docs/job-specification/multiregion
|
||||
[`shutdown_delay`]: /nomad/docs/job-specification/group#shutdown_delay
|
||||
@@ -17,5 +17,5 @@ Usage: `nomad job tag <subcommand> [options] [args]`
|
||||
|
||||
`job tag` has the following subcommands:
|
||||
|
||||
- [`job tag apply`](/nomad/docs/commands/job/tag/apply): Save a job version tag.
|
||||
- [`job tag unset`](/nomad/docs/commands/job/tag/apply): Remove a tag from a job version.
|
||||
- [`job tag apply`](/nomad/commands/job/tag/apply): Save a job version tag.
|
||||
- [`job tag unset`](/nomad/commands/job/tag/apply): Remove a tag from a job version.
|
||||
@@ -22,5 +22,5 @@ subcommands are available:
|
||||
- [`license get`][get] - Get the current license from a server
|
||||
- [`license inspect`][inspect] - Inspect and validate a license
|
||||
|
||||
[get]: /nomad/docs/commands/license/get 'Get the current license from a server'
|
||||
[inspect]: /nomad/docs/commands/license/inspect 'Inspect and validate a license'
|
||||
[get]: /nomad/commands/license/get 'Get the current license from a server'
|
||||
[inspect]: /nomad/commands/license/inspect 'Inspect and validate a license'
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user