github.com/anth0d/nomad@v0.0.0-20221214183521-ae3a0a2cad06/website/content/docs/enterprise/license/index.mdx (about)

     1  ---
     2  layout: docs
     3  page_title: Nomad Enterprise Licensing
     4  description: >-
     5    Learn about how Nomad Enterprise licensing works.
     6  ---
     7  
     8  ## Nomad Enterprise Licensing
     9  
    10  Licensing capabilities were added to Nomad Enterprise v0.12.0. Each server in
    11  the cluster must have its own license. Nomad Enterprise can be downloaded from
    12  the [releases site].
    13  
    14  Click [here](https://www.hashicorp.com/go/nomad-enterprise) to set up a demo of Nomad Enterprise
    15  or [here](https://www.hashicorp.com/products/nomad/trial) to get a trial license.
    16  
    17  ~> **Note:** A Nomad Enterprise cluster cannot be downgraded to the open
    18  source version of Nomad. Servers running the open source version of Nomad will
    19  panic if they are joined to a Nomad Enterprise cluster. See issue [gh-9958]
    20  for more details.
    21  
    22  ## Expiring Licenses
    23  
    24  Nomad Enterprise license have an expiration time. You can read the license on
    25  a server with the `nomad license get` command:
    26  
    27  ```
    28  $ nomad license get
    29  Product        = nomad
    30  License Status = valid
    31  License ID     = eaaecbd5-b598-4fa4-b649-bb234bf49fa3
    32  Customer ID    = ae94bdd0-39bf-4c58-bf80-8a9468b0467c
    33  Issued At      = 2021-03-29 14:47:29.024191 -0400 EDT
    34  Expires At     = 2021-03-29 20:47:29.024191 -0400 EDT
    35  Datacenter     = *
    36  Modules:
    37          governance-policy
    38          multicluster-and-efficiency
    39  Licensed Features:
    40          Automated Upgrades
    41          Enhanced Read Scalability
    42          Redundancy Zones
    43          Namespaces
    44          Resource Quotas
    45          Audit Logging
    46          Sentinel Policies
    47          Multiregion Deployments
    48          Automated Backups
    49          Multi-Vault Namespaces
    50          Dynamic Application Sizing
    51  ```
    52  
    53  As a Nomad Enterprise license approaches its expiration time, Nomad servers
    54  will periodically log a warning message about the approaching
    55  expiration. Below shows log excerpts of the warnings.
    56  
    57  ```
    58      2021-03-29T15:02:28.100-0400 [WARN]  nomad.licensing: license expiring: time_left=5m0s
    59      2021-03-29T15:03:28.103-0400 [WARN]  nomad.licensing: license expiring: time_left=4m0s
    60      2021-03-29T15:04:28.106-0400 [WARN]  nomad.licensing: license expiring: time_left=3m0s
    61      2021-03-29T15:05:28.109-0400 [WARN]  nomad.licensing: license expiring: time_left=2m0s
    62      2021-03-29T15:06:28.112-0400 [WARN]  nomad.licensing: license expiring: time_left=1m0s
    63      2021-03-29T15:07:28.114-0400 [WARN]  nomad.licensing: license expiring: time_left=0s
    64      2021-03-29T15:07:58.104-0400 [ERROR] nomad.licensing: license expired, please update license: error="invalid license or license is expired"
    65  ```
    66  
    67  When the license expires, enterprise functionality will become limited. Only
    68  read operations on enterprise endpoints will be supported, and write
    69  operations will return an error.
    70  
    71  Note that if the server is restarted with an expired license, it will
    72  immediately stop.
    73  
    74  ## Configuring the License
    75  
    76  See the server [license configuration] reference documentation on all the
    77  options to set an enterprise license. Nomad will load the license file from
    78  disk or environment when it starts.
    79  
    80  ~> **Note:** An Enterprise license [tutorial](https://learn.hashicorp.com/tutorials/nomad/hashicorp-enterprise-license?in=nomad/enterprise) is available to help you install the license on the server.
    81  
    82  In order to immediately alert operators of a bad configuration setting, if a
    83  license configuration option is an invalid or expired license, the Nomad server
    84  will exit with an error.
    85  
    86  ```
    87  NOMAD_LICENSE=misconfigured nomad agent -dev
    88  ==> No configuration files loaded
    89  ==> Starting Nomad agent...
    90  ==> Error starting agent: server setup failed: failed to initialize enterprise licensing: a file license was configured but the license is invalid: error decoding version: expected integer
    91  ```
    92  
    93  See the [License commands](/docs/commands/license) for more information on
    94  interacting with the Enterprise License.
    95  
    96  [gh-9958]: https://github.com/hashicorp/nomad/issues/9958
    97  [releases site]: https://releases.hashicorp.com/nomad
    98  [license configuration]: /docs/configuration/server#license_path
    99  [license endpoint]: /api-docs/operator/license#updating-the-nomad-enterprise-license