From 55a13b9e61c902d325e123cd7782d2749abab039 Mon Sep 17 00:00:00 2001 From: Drew Bailey <2614075+drewbailey@users.noreply.github.com> Date: Wed, 6 May 2020 14:15:14 -0400 Subject: [PATCH] license cli documentation license docs backout doc change more docs --- website/data/docs-navigation.js | 4 ++ website/pages/docs/commands/license/get.mdx | 51 ++++++++++++++++++ website/pages/docs/commands/license/index.mdx | 29 ++++++++++ website/pages/docs/commands/license/put.mdx | 54 +++++++++++++++++++ website/pages/docs/enterprise/index.mdx | 8 +++ 5 files changed, 146 insertions(+) create mode 100644 website/pages/docs/commands/license/get.mdx create mode 100644 website/pages/docs/commands/license/index.mdx create mode 100644 website/pages/docs/commands/license/put.mdx diff --git a/website/data/docs-navigation.js b/website/data/docs-navigation.js index e09adfe2d541..79c115fb35cc 100644 --- a/website/data/docs-navigation.js +++ b/website/data/docs-navigation.js @@ -108,6 +108,10 @@ export default [ 'validate' ] }, + { + category: 'license', + content: ['get', 'put'] + }, 'monitor', { category: 'namespace', diff --git a/website/pages/docs/commands/license/get.mdx b/website/pages/docs/commands/license/get.mdx new file mode 100644 index 000000000000..6c96eb91dcc4 --- /dev/null +++ b/website/pages/docs/commands/license/get.mdx @@ -0,0 +1,51 @@ +--- +layout: docs +page_title: 'Commands: license get' +sidebar_title: get +description: | + The license get command is used to get the current license. +--- + +# Command: license get + +The `license get` command is used to retrieve the current Nomad Enterprise license. + +~> License commands are new in Nomad 0.12.0 and are only available with Nomad +Enterprise. + +## Usage + +```plaintext +nomad license get [options] +``` + +## General Options + +@include 'general_options.mdx' + +## Examples + +```shell-session +$ nomad license get + +Product = nomad +License Status = valid +License ID = e23f63b1-00ec-4e67-e926-c22e7937ceec +Customer ID = 350356e5-8aec-bdf4-8510-b205079ccad2 +Expires At = 2020-05-09 00:00:00 +0000 UTC +License ID = e23f63b1-00ec-4e67-e926-c22e7937ceec +Customer ID = 350356e5-8aec-bdf4-8510-b205079ccad2 +Terminates At = 2020-05-10 00:00:00 +0000 UTC +Datacenter = * +Modules: + governance-policy +Licensed Features: + Automated Upgrades + Enhanced Read Scalability + Redundancy Zones + Namespaces + Resource Quotas + Preemption + Audit Logging + Setinel Policies +``` diff --git a/website/pages/docs/commands/license/index.mdx b/website/pages/docs/commands/license/index.mdx new file mode 100644 index 000000000000..3a986b0e78ca --- /dev/null +++ b/website/pages/docs/commands/license/index.mdx @@ -0,0 +1,29 @@ +--- +layout: docs +page_title: 'Commands: license' +sidebar_title: license +description: | + The license command is used to interact with an enterprise license. +--- + +# Command: license + +~> License commands are new in Nomad 0.12.0 and are only available with Nomad Enterprise. + +The `license` command provides cluster level management of the Nomad Enterprise license. + +If ACLs are enabled then a token with operator privileges may be required in order to use +this command. + +## Usage + +Usage: `nomad license [options]` + +Run `nomad license -h` for help on that subcommand. The following +subcommands are available: + +- [`license get`][get] - Get the current license +- [`license put`][put] - Set the current license + +[get]: /docs/commands/license/get `Get the current license` +[put]: /docs/commands/license/put `Set the current license` diff --git a/website/pages/docs/commands/license/put.mdx b/website/pages/docs/commands/license/put.mdx new file mode 100644 index 000000000000..e1e61d9bf6f1 --- /dev/null +++ b/website/pages/docs/commands/license/put.mdx @@ -0,0 +1,54 @@ +--- +layout: docs +page_title: 'Commands: license put' +sidebar_title: put +description: | + The license put command is used to set the Nomad Enterprise license. +--- + +# Command: license put + +The `license set` command is used to set the Nomad Enterprise license. + +~> License commands are new in Nomad 0.12.0 and are only available with Nomad +Enterprise. + +## Usage + +```plaintext +nomad license put +``` + +## General Options + +@include 'general_options.mdx' + +## Put Options + +```plaintext +Install a new license from a file: + + $ nomad license put + +Install a new license from stdin: + + $ nomad license put - +``` + +## Examples + +Set a license using a path + +```shell-session +$ nomad license put /path/to/my/license.txt +``` + +Set a license using a path + +```shell-session +$ nomad license put - + +02MV4UU43BK5HGYYTOJZWFQMTMNNEWU33JLJKES6S2NJMXUWLKIV2E2RCCNRMXSMBQLJKFSM2MK5KTKTLKLF2FS6SJPFNFIYZVJV5GI2S2K5LGUSLJO5UVSM2WPJSEOOLULJMEUZTBK5IWST3JJF5E4VCBPJHFIWTMJZJTANCZK5LGUTCXJJVVU2SRORHUIVLYJVBTC2KNNJATCTKEMM2VSMSONBNEISLJJRBUU4DCNZHDAWKXPBZVSWCSOBRDENLGMFLVC2KPNFEXCSLJO5UWCWCOPJSFOVTGMRDWY5C2KNETMSLKJF3U22SBORGUIVLUJVCGQVKNKRITMTLKJU3E26TDOVHHURJRJVVEC52NPJATGV3JJFZUS3SOGBMVQSRQLAZVE4DCK5KWST3JJF4U2RCJO5GFIQJRJRKECNCWIRAXOT3KIF3U62SBO5LWSSLTJFWVMNDDI5WHSWKYKJYGEMRVMZSEO3DULJJUSNSJNJEXOTLKIF2E2RCVORGUI3CVJVCECNSNIRATMTKEIJQUS2LXNFSEOVTZMJLWY5KZLBJHAYRSGVTGIR3MORNFGSJWJFVES52NNJAXITKEKV2E2VCCKVGUIQJWJVCECNSNIRBGCSLJO5UWGSCKOZNEQVTKMRBUSNSJNU2XMYSXIZVUS2LXNFNG26DILIZU22KPNZZWSYSXHFVWIV3YNRRXSSJWK54UU3TCGNNGYY3NGVUGE3KONRGFQQ + + +``` diff --git a/website/pages/docs/enterprise/index.mdx b/website/pages/docs/enterprise/index.mdx index ae0120db93ca..8cf96255c168 100644 --- a/website/pages/docs/enterprise/index.mdx +++ b/website/pages/docs/enterprise/index.mdx @@ -16,6 +16,14 @@ Nomad Enterprise adds collaboration, operational, and governance capabilities to Please navigate the sub-sections for more information about each package and its features in detail. +## Nomad Enterprise Licensing + +Nomad Enterprise requires a license to run. When a Enterprise server first starts it will be set with a temporary license that includes all features. This will be valid for 6 hours and allows users to test enterprise features and provide enough time for operators to apply their enterprise license. + +If a server is never given a valid license and the temporary license expires, the server will shutdown. If a valid (non-temporary) license expires, the cluster will continue to function, but write operations to enterprise features will be disabled. + +See the [License commands](/docs/commands/license) for more information on interacting with the Enterprise License. + ## Nomad Enterprise Platform Nomad Enterprise Platform enables operators to easily upgrade Nomad as well as enhances performance and availability through Advanced Autopilot features such as Automated Upgrades, Enhanced Read Scalability, and Redundancy Zones.