Merge pull request #8271 from hashicorp/f-comment-init-check-stanza

Comment out default Consul check; Update URLs
2026-01-04 09:25:46 +03:00 · 2020-06-26 08:30:30 -04:00
parent 0a9104c8cd f18849623b
commit 2f589c0e30
2 changed files with 104 additions and 75 deletions
--- a/command/agent/bindata_assetfs.go
+++ b/command/agent/bindata_assetfs.go
--- a/command/assets/example.nomad
+++ b/command/assets/example.nomad
@@ -9,7 +9,7 @@
 # For more information and examples on the "job" stanza, please see
 # the online documentation at:
 #
-#     https://www.nomadproject.io/docs/job-specification/job.html
+#     https://www.nomadproject.io/docs/job-specification/job
 #
 job "example" {
  # The "region" parameter specifies the region in which to execute the job.
@@ -27,7 +27,7 @@ job "example" {
  #
  # For more information, please see the online documentation at:
  #
-  #     https://www.nomadproject.io/docs/jobspec/schedulers.html
+  #     https://www.nomadproject.io/docs/schedulers
  #
  type = "service"

@@ -38,7 +38,7 @@ job "example" {
  # For more information and examples on the "constraint" stanza, please see
  # the online documentation at:
  #
-  #     https://www.nomadproject.io/docs/job-specification/constraint.html
+  #     https://www.nomadproject.io/docs/job-specification/constraint
  #
  # constraint {
  #   attribute = "${attr.kernel.name}"
@@ -55,7 +55,7 @@ job "example" {
  # For more information and examples on the "update" stanza, please see
  # the online documentation at:
  #
-  #     https://www.nomadproject.io/docs/job-specification/update.html
+  #     https://www.nomadproject.io/docs/job-specification/update
  #
  update {
    # The "max_parallel" parameter specifies the maximum number of updates to
@@ -105,7 +105,7 @@ job "example" {
  # For more information on the "migrate" stanza, please see
  # the online documentation at:
  #
-  #     https://www.nomadproject.io/docs/job-specification/migrate.html
+  #     https://www.nomadproject.io/docs/job-specification/migrate
  #
  migrate {
    # Specifies the number of task groups that can be migrated at the same
@@ -134,7 +134,7 @@ job "example" {
  # For more information and examples on the "group" stanza, please see
  # the online documentation at:
  #
-  #     https://www.nomadproject.io/docs/job-specification/group.html
+  #     https://www.nomadproject.io/docs/job-specification/group
  #
  group "cache" {
    # The "count" parameter specifies the number of the task groups that should
@@ -148,7 +148,7 @@ job "example" {
    # For more information and examples on the "restart" stanza, please see
    # the online documentation at:
    #
-    #     https://www.nomadproject.io/docs/job-specification/restart.html
+    #     https://www.nomadproject.io/docs/job-specification/restart
    #
    restart {
      # The number of attempts to run the job within the specified interval.
@@ -174,7 +174,7 @@ job "example" {
    # For more information and examples on the "ephemeral_disk" stanza, please
    # see the online documentation at:
    #
-    #     https://www.nomadproject.io/docs/job-specification/ephemeral_disk.html
+    #     https://www.nomadproject.io/docs/job-specification/ephemeral_disk
    #
    ephemeral_disk {
      # When sticky is true and the task group is updated, the scheduler
@@ -198,7 +198,7 @@ job "example" {
    # For more information and examples on the "affinity" stanza, please
    # see the online documentation at:
    #
-    #     https://www.nomadproject.io/docs/job-specification/affinity.html
+    #     https://www.nomadproject.io/docs/job-specification/affinity
    #
    # affinity {
    # attribute specifies the name of a node attribute or metadata
@@ -223,7 +223,7 @@ job "example" {
    # For more information and examples on the "spread" stanza, please
    # see the online documentation at:
    #
-    #     https://www.nomadproject.io/docs/job-specification/spread.html
+    #     https://www.nomadproject.io/docs/job-specification/spread
    #
    # spread {
    # attribute specifies the name of a node attribute or metadata
@@ -247,7 +247,7 @@ job "example" {
    # For more information and examples on the "task" stanza, please see
    # the online documentation at:
    #
-    #     https://www.nomadproject.io/docs/job-specification/task.html
+    #     https://www.nomadproject.io/docs/job-specification/task
    #
    task "redis" {
      # The "driver" parameter specifies the task driver that should be used to
@@ -275,7 +275,7 @@ job "example" {
      # For more information and examples on the "artifact" stanza, please see
      # the online documentation at:
      #
-      #     https://www.nomadproject.io/docs/job-specification/artifact.html
+      #     https://www.nomadproject.io/docs/job-specification/artifact
      #
      # artifact {
      #   source = "http://foo.com/artifact.tar.gz"
@@ -293,7 +293,7 @@ job "example" {
      # For more information and examples on the "logs" stanza, please see
      # the online documentation at:
      #
-      #     https://www.nomadproject.io/docs/job-specification/logs.html
+      #     https://www.nomadproject.io/docs/job-specification/logs
      #
      # logs {
      #   max_files     = 10
@@ -308,7 +308,7 @@ job "example" {
      # For more information and examples on the "resources" stanza, please see
      # the online documentation at:
      #
-      #     https://www.nomadproject.io/docs/job-specification/resources.html
+      #     https://www.nomadproject.io/docs/job-specification/resources
      #
      resources {
        cpu    = 500 # 500 MHz
@@ -327,19 +327,25 @@ job "example" {
      # For more information and examples on the "service" stanza, please see
      # the online documentation at:
      #
-      #     https://www.nomadproject.io/docs/job-specification/service.html
+      #     https://www.nomadproject.io/docs/job-specification/service
      #
      service {
        name = "redis-cache"
        tags = ["global", "cache"]
        port = "db"

-        check {
-          name     = "alive"
-          type     = "tcp"
-          interval = "10s"
-          timeout  = "2s"
-        }
+        # The "check" stanza instructs Nomad to create a Consul health check for
+        # this service. A sample check is provided here for your convenience;
+        # uncomment it to enable it. The "check" stanza is documented in the
+        # "service" stanza documentation.
+
+        # check {
+        #   name     = "alive"
+        #   type     = "tcp"
+        #   interval = "10s"
+        #   timeout  = "2s"
+        # }
+
      }

      # The "template" stanza instructs Nomad to manage a template, such as
@@ -349,7 +355,7 @@ job "example" {
      # For more information and examples on the "template" stanza, please see
      # the online documentation at:
      #
-      #     https://www.nomadproject.io/docs/job-specification/template.html
+      #     https://www.nomadproject.io/docs/job-specification/template
      #
      # template {
      #   data          = "---\nkey: {{ key \"service/my-key\" }}"
@@ -378,7 +384,7 @@ job "example" {
      # For more information and examples on the "vault" stanza, please see
      # the online documentation at:
      #
-      #     https://www.nomadproject.io/docs/job-specification/vault.html
+      #     https://www.nomadproject.io/docs/job-specification/vault
      #
      # vault {
      #   policies      = ["cdn", "frontend"]