From 3db97acf8a185b73711284c0c6c744cec01f6520 Mon Sep 17 00:00:00 2001 From: Mike Nomitch Date: Wed, 17 May 2023 13:58:11 -0700 Subject: [PATCH] docs: add documentation on ephemeral disk and logs (#15829) --- website/content/docs/job-specification/ephemeral_disk.mdx | 4 ++++ website/content/docs/job-specification/logs.mdx | 5 +++++ 2 files changed, 9 insertions(+) diff --git a/website/content/docs/job-specification/ephemeral_disk.mdx b/website/content/docs/job-specification/ephemeral_disk.mdx index fccc45d9a..8cf7b034b 100644 --- a/website/content/docs/job-specification/ephemeral_disk.mdx +++ b/website/content/docs/job-specification/ephemeral_disk.mdx @@ -30,6 +30,9 @@ job "docs" { The ephemeral disk can be referenced under `alloc/data/`. More information can be found in the [filesystem internals][]. +Each job's logs will be written to ephemeral disk space. See the [logs +documentation][] for more information. + ## `ephemeral_disk` Parameters - `migrate` `(bool: false)` - This specifies that the Nomad client should make a @@ -67,3 +70,4 @@ ephemeral_disk { [resources]: /nomad/docs/job-specification/resources 'Nomad resources Job Specification' [filesystem internals]: /nomad/docs/concepts/filesystem#templates-artifacts-and-dispatch-payloads 'Filesystem internals documentation' +[logs documentation]: /nomad/docs/job-specification/logs 'Nomad logs Job Specification' diff --git a/website/content/docs/job-specification/logs.mdx b/website/content/docs/job-specification/logs.mdx index 67984f07f..bb361fd49 100644 --- a/website/content/docs/job-specification/logs.mdx +++ b/website/content/docs/job-specification/logs.mdx @@ -38,6 +38,10 @@ job "docs" { } ``` +Each job's logs will be written to ephemeral disk space. If you increase the total +amount of logs on disk, you may want to increase ephemeral disk size as well. See +the [ephemeral disk documentation][] for more information. + For information on how to interact with logs after they have been configured, please see the [`nomad alloc logs`][logs-command] command. @@ -93,3 +97,4 @@ logs { [logs-command]: /nomad/docs/commands/alloc/logs 'Nomad logs command' [`disable_log_collection`]: /nomad/docs/drivers/docker#disable_log_collection +[ephemeral disk documentation]: /nomad/docs/job-specification/ephemeral_disk 'Nomad ephemeral disk Job Specification'