Skip to content

Commit

Permalink
docs: add node_pool autoscaler node selector (#19548)
Browse files Browse the repository at this point in the history
Document the `node_pool` node selector configuration.
  • Loading branch information
lgfa29 authored Jan 2, 2024
1 parent bb3d222 commit 0973144
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 26 deletions.
11 changes: 4 additions & 7 deletions website/content/tools/autoscaling/plugins/target/aws-asg.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
15 changes: 4 additions & 11 deletions website/content/tools/autoscaling/plugins/target/azure-vmss.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
12 changes: 4 additions & 8 deletions website/content/tools/autoscaling/plugins/target/gce-mig.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

0 comments on commit 0973144

Please sign in to comment.