From b5afca3ce1bb2e5cb23cd36ee4dcc150cac399a5 Mon Sep 17 00:00:00 2001 From: gunadhya <6939749+gunadhya@users.noreply.github.com> Date: Wed, 23 Dec 2020 19:33:16 +0530 Subject: [PATCH] Added Enterprise Badges in Docs --- website/pages/api-docs/quotas.mdx | 4 +++- website/pages/api-docs/recommendations.mdx | 4 +++- website/pages/api-docs/sentinel-policies.mdx | 4 +++- website/pages/docs/autoscaling/index.mdx | 4 +++- website/pages/docs/autoscaling/plugins/strategy.mdx | 12 +++++++++--- website/pages/docs/autoscaling/plugins/target.mdx | 4 +++- website/pages/docs/autoscaling/policy.mdx | 4 +++- .../pages/docs/integrations/vault-integration.mdx | 1 + website/pages/docs/job-specification/multiregion.mdx | 3 +-- 9 files changed, 29 insertions(+), 11 deletions(-) diff --git a/website/pages/api-docs/quotas.mdx b/website/pages/api-docs/quotas.mdx index a9e2febd42bd..ea690e144c73 100644 --- a/website/pages/api-docs/quotas.mdx +++ b/website/pages/api-docs/quotas.mdx @@ -9,8 +9,10 @@ description: The /quota endpoints are used to query for and interact with quotas The `/quota` endpoints are used to query for and interact with quotas. -~> **Enterprise Only!** This API endpoint and functionality only exists in + +This API endpoint and functionality only exists in Nomad Enterprise. This is not present in the open source version of Nomad. + ## List Quota Specifications diff --git a/website/pages/api-docs/recommendations.mdx b/website/pages/api-docs/recommendations.mdx index 20393f1033a6..5fb85d536c7b 100644 --- a/website/pages/api-docs/recommendations.mdx +++ b/website/pages/api-docs/recommendations.mdx @@ -12,8 +12,10 @@ description: >- The `/recommendation` endpoints are used to query and interact with Dynamic Application Sizing recommendations. -~> **Enterprise Only!** This API endpoint and functionality only exists in + +This API endpoint and functionality only exists in Nomad Enterprise. This is not present in the open source version of Nomad. + ## List Recommendations diff --git a/website/pages/api-docs/sentinel-policies.mdx b/website/pages/api-docs/sentinel-policies.mdx index bfca634f078b..b60db7b8d3f5 100644 --- a/website/pages/api-docs/sentinel-policies.mdx +++ b/website/pages/api-docs/sentinel-policies.mdx @@ -14,8 +14,10 @@ For more details about Sentinel policies, please see the [Sentinel Policy Guide] Sentinel endpoints are only available when ACLs are enabled. For more details about ACLs, please see the [ACL Guide](https://learn.hashicorp.com/collections/nomad/access-control). -~> **Enterprise Only!** This API endpoint and functionality only exists in + +This API endpoint and functionality only exists in Nomad Enterprise. This is not present in the open source version of Nomad. + ## List Policies diff --git a/website/pages/docs/autoscaling/index.mdx b/website/pages/docs/autoscaling/index.mdx index a0a2ad866f20..c5a37ac18e1f 100644 --- a/website/pages/docs/autoscaling/index.mdx +++ b/website/pages/docs/autoscaling/index.mdx @@ -40,8 +40,10 @@ cluster. ## Dynamic Application Sizing -~> **Enterprise Only!** This functionality only exists in Nomad Autoscaler + +This functionality only exists in Nomad Autoscaler Enterprise. This is not present in the open source version of Nomad Autoscaler. + Dynamic Application Sizing enables organizations to optimize the resource consumption of applications using sizing recommendations from Nomad. It evaluates, diff --git a/website/pages/docs/autoscaling/plugins/strategy.mdx b/website/pages/docs/autoscaling/plugins/strategy.mdx index 2ab2a51b8359..59807006798b 100644 --- a/website/pages/docs/autoscaling/plugins/strategy.mdx +++ b/website/pages/docs/autoscaling/plugins/strategy.mdx @@ -47,8 +47,10 @@ check { ## Dynamic Application Sizing Average Strategy Plugin -~> **Enterprise Only!** This functionality only exists in Nomad Autoscaler + +This functionality only exists in Nomad Autoscaler Enterprise. This is not present in the open source version of Nomad Autoscaler. + The `app-sizing-avg` plugin calculates the average value seen across the dataset. The plugin applies an exponential weight decay to data, in order to give @@ -78,8 +80,10 @@ check "avg" { ## Dynamic Application Sizing Max Strategy Plugin -~> **Enterprise Only!** This functionality only exists in Nomad Autoscaler + +This functionality only exists in Nomad Autoscaler Enterprise. This is not present in the open source version of Nomad Autoscaler. + The `app-sizing-max` plugin calculates the maximum value seen for the target resource within the available dataset. This plugin is ideally suited for memory @@ -107,8 +111,10 @@ check "max" { ## Dynamic Application Sizing Percentile Strategy Plugin -~> **Enterprise Only!** This functionality only exists in Nomad Autoscaler + +This functionality only exists in Nomad Autoscaler Enterprise. This is not present in the open source version of Nomad Autoscaler. + The `app-sizing-percentile` plugin calculates its result based on a desired percentile value from the dataset. diff --git a/website/pages/docs/autoscaling/plugins/target.mdx b/website/pages/docs/autoscaling/plugins/target.mdx index 9cb4b4de8cba..31def6d50eff 100644 --- a/website/pages/docs/autoscaling/plugins/target.mdx +++ b/website/pages/docs/autoscaling/plugins/target.mdx @@ -62,8 +62,10 @@ check "example-check" { ## Dynamic Application Sizing Nomad Task Target -~> **Enterprise Only!** This functionality only exists in Nomad Autoscaler + +This functionality only exists in Nomad Autoscaler Enterprise. This is not present in the open source version of Nomad Autoscaler. + The `app-sizing-nomad` target plugin reports on the current task resource value as well as submits recommendations to Nomad via the [recommendations API endpoint][nomad_recommendations_api] diff --git a/website/pages/docs/autoscaling/policy.mdx b/website/pages/docs/autoscaling/policy.mdx index 44b827eee658..5754bcc3ba14 100644 --- a/website/pages/docs/autoscaling/policy.mdx +++ b/website/pages/docs/autoscaling/policy.mdx @@ -98,8 +98,10 @@ policy { ## Task (DAS) `policy` Options -~> **Enterprise Only!** This functionality only exists in Nomad Autoscaler + +This functionality only exists in Nomad Autoscaler Enterprise. This is not present in the open source version of Nomad Autoscaler. + The following options are available when using the Nomad Autoscaler Enterprise to perform Dynamic Application Sizing recommendations for task resources. When diff --git a/website/pages/docs/integrations/vault-integration.mdx b/website/pages/docs/integrations/vault-integration.mdx index 77ac4bc4d605..1575181eb604 100644 --- a/website/pages/docs/integrations/vault-integration.mdx +++ b/website/pages/docs/integrations/vault-integration.mdx @@ -343,6 +343,7 @@ You can see examples of `v1` and `v2` syntax in the [template documentation][vault-kv-templates]. ## Enterprise Configuration + Nomad Enterprise 0.12.2 introduced the ability for jobs to use multiple Vault Namespaces. There are a few configuration settings to consider when using this functionality. diff --git a/website/pages/docs/job-specification/multiregion.mdx b/website/pages/docs/job-specification/multiregion.mdx index 4ff20b922582..535b251e5331 100644 --- a/website/pages/docs/job-specification/multiregion.mdx +++ b/website/pages/docs/job-specification/multiregion.mdx @@ -11,8 +11,7 @@ description: |- -~> **Enterprise Only!** This functionality only exists in Nomad -Enterprise. This is not present in the open source version of Nomad. + The `multiregion` stanza specifies that a job will be deployed to multiple [federated regions]. If omitted, the job will be deployed to a single region