From 09731442e4db2418a7d44391cb6633fda825e461 Mon Sep 17 00:00:00 2001 From: Luiz Aoqui Date: Tue, 2 Jan 2024 10:19:58 -0500 Subject: [PATCH] docs: add `node_pool` autoscaler node selector (#19548) Document the `node_pool` node selector configuration. --- .../tools/autoscaling/plugins/target/aws-asg.mdx | 11 ++++------- .../autoscaling/plugins/target/azure-vmss.mdx | 15 ++++----------- .../tools/autoscaling/plugins/target/gce-mig.mdx | 12 ++++-------- 3 files changed, 12 insertions(+), 26 deletions(-) diff --git a/website/content/tools/autoscaling/plugins/target/aws-asg.mdx b/website/content/tools/autoscaling/plugins/target/aws-asg.mdx index a702f00bde9..ebf2437ceb5 100644 --- a/website/content/tools/autoscaling/plugins/target/aws-asg.mdx +++ b/website/content/tools/autoscaling/plugins/target/aws-asg.mdx @@ -110,6 +110,9 @@ check "hashistack-allocated-cpu" { - `node_class` `(string: "")` - The Nomad [client node class][nomad_node_class] identifier used to group nodes into a pool of resource. +- `node_pool` `(string: "")` - The Nomad [client node pool][nomad_node_pool] + identifier used to group nodes into a pool of resource. + - `node_drain_deadline` `(duration: "15m")` The Nomad [drain deadline][nomad_node_drain_deadline] to use when performing node draining actions. **Note that the default value for this setting differs from Nomad's @@ -128,17 +131,11 @@ check "hashistack-allocated-cpu" { strategy][node_selector_strategy] documentation for more information. [aws_autoscaling]: https://aws.amazon.com/autoscaling/ - [aws_region]: https://aws.amazon.com/about-aws/global-infrastructure/regions_az/ - [nomad_datacenter]: /nomad/docs/configuration#datacenter - [nomad_node_class]: /nomad/docs/configuration/client#node_class - +[nomad_node_pool]: /nomad/docs/configuration/client#node_pool [nomad_node_drain_deadline]: /nomad/api-docs/nodes#deadline - [nomad_node_purge]: /nomad/api-docs/nodes#purge-node - [node_selector_strategy]: /nomad/tools/autoscaling/internals/node-selector-strategy - [vault_aws_backend]: /vault/docs/secrets/aws diff --git a/website/content/tools/autoscaling/plugins/target/azure-vmss.mdx b/website/content/tools/autoscaling/plugins/target/azure-vmss.mdx index 7bf2dbc6d7a..8d4d5f158eb 100644 --- a/website/content/tools/autoscaling/plugins/target/azure-vmss.mdx +++ b/website/content/tools/autoscaling/plugins/target/azure-vmss.mdx @@ -106,6 +106,9 @@ check "clients-azure-vmss" { - `node_class` `(string: "")` - The Nomad [client node class][nomad_node_class] identifier used to group nodes into a pool of resource. +- `node_pool` `(string: "")` - The Nomad [client node pool][nomad_node_pool] + identifier used to group nodes into a pool of resource. + - `node_drain_deadline` `(duration: "15m")` The Nomad [drain deadline][nomad_node_drain_deadline] to use when performing node draining actions. **Note that the default value for this setting differs from Nomad's @@ -132,25 +135,15 @@ This can be retrieved programatically via the [Azure Instance Metadata service][azure_instance_metadata]. [azure_instance_metadata]: https://docs.microsoft.com/en-us/azure/virtual-machines/windows/instance-metadata-service - [azure_resource_group]: https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal#what-is-a-resource-group - [azure_virtual_machine_scale_sets]: https://docs.microsoft.com/en-us/azure/virtual-machine-scale-sets/overview - [azure_vm_identity]: https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/ - [client_meta_tag]: #client-meta-tag - [node_selector_strategy]: /nomad/tools/autoscaling/internals/node-selector-strategy - [nomad_datacenter]: /nomad/docs/configuration#datacenter - [nomad_client_meta_tag]: /nomad/docs/configuration/client#meta - [nomad_node_class]: /nomad/docs/configuration/client#node_class - +[nomad_node_pool]: /nomad/docs/configuration/client#node_pool [nomad_node_drain_deadline]: /nomad/api-docs/nodes#deadline - [nomad_node_purge]: /nomad/api-docs/nodes#purge-node - [vault_azure_backend]: /vault/docs/secrets/azure diff --git a/website/content/tools/autoscaling/plugins/target/gce-mig.mdx b/website/content/tools/autoscaling/plugins/target/gce-mig.mdx index f7df5bd0e7a..0d4f1061250 100644 --- a/website/content/tools/autoscaling/plugins/target/gce-mig.mdx +++ b/website/content/tools/autoscaling/plugins/target/gce-mig.mdx @@ -82,6 +82,9 @@ check "hashistack-allocated-cpu" { - `node_class` `(string: "")` - The Nomad [client node class][nomad_node_class] identifier used to group nodes into a pool of resource. +- `node_pool` `(string: "")` - The Nomad [client node pool][nomad_node_pool] + identifier used to group nodes into a pool of resource. + - `node_drain_deadline` `(duration: "15m")` The Nomad [drain deadline][nomad_node_drain_deadline] to use when performing node draining actions. **Note that the default value for this setting differs from Nomad's @@ -100,19 +103,12 @@ check "hashistack-allocated-cpu" { strategy][node_selector_strategy] documentation for more information. [gcp_credentials]: https://cloud.google.com/docs/authentication/production#providing_credentials_to_your_application - [gcp_projects]: https://cloud.google.com/resource-manager/docs/creating-managing-projects - [gce_migs]: https://cloud.google.com/compute/docs/instance-groups/ - [nomad_datacenter]: /nomad/docs/configuration#datacenter - [nomad_node_class]: /nomad/docs/configuration/client#node_class - +[nomad_node_pool]: /nomad/docs/configuration/client#node_pool [nomad_node_drain_deadline]: /nomad/api-docs/nodes#deadline - [nomad_node_purge]: /nomad/api-docs/nodes#purge-node - [node_selector_strategy]: /nomad/tools/autoscaling/internals/node-selector-strategy - [vault_gcp_backend]: /vault/docs/secrets/gcp