github.com/Ilhicas/nomad@v1.0.4-0.20210304152020-e86851182bc3/website/content/docs/autoscaling/plugins/index.mdx (about)

     1  ---
     2  layout: docs
     3  page_title: Plugins
     4  sidebar_title: Plugins
     5  description: Plugins are used to architect the Nomad Autoscaler into distinct areas.
     6  ---
     7  
     8  # Nomad Autoscaler Plugins
     9  
    10  Plugins are an essential part of the Nomad Autoscaler architecture. The Autoscaler
    11  uses the [go-plugin][go_plugin_github] library to implement an ecosystem of
    12  different types of plugins. Each plugin type is responsible for a specific task;
    13  APM plugins retrieve metrics about the workloads being monitored and Strategy
    14  plugins decide which actions Nomad should execute to keep the policy valid. The
    15  flexibility of plugins allows the Nomad Autoscaler to be extended to meet specific
    16  business requirements or technology use cases.
    17  
    18  The Nomad Autoscaler currently ships with a number of built-in plugins to ease
    19  the learning curve. Details of these can be found in the side menu, under the
    20  specific plugin type sections.
    21  
    22  # General Options
    23  
    24  All plugins which require Nomad API connectivity support the parameters detailed
    25  below. These plugins include Nomad APM, Nomad Target and all cluster scaling
    26  targets.
    27  
    28  - `nomad_config_inherit` `(bool: true)` - A boolean flag which indicates whether
    29    the plugin should inherit the agents Nomad configuration parameters. Plugins
    30    can override individual parameters and have their Nomad configuration merged
    31    with that of the agent.
    32  
    33  - `nomad_address` `(string: "")` - The address of the Nomad server in the form
    34    of `protocol://addr:port`.
    35  
    36  - `nomad_region` `(string: "")` - The region of the Nomad servers to connect with.
    37  
    38  - `nomad_namespace` `(string: "")` - The target namespace for queries and actions
    39    bound to a namespace.
    40  
    41  - `nomad_token` `(string: "")` - The SecretID of an ACL token to use to authenticate
    42    API requests with.
    43  
    44  - `nomad_http-auth` `(string: "")` - The authentication information to use when
    45    connecting to a Nomad API which is using HTTP authentication.
    46  
    47  - `nomad_ca-cert` `(string: "")` - Path to a PEM encoded CA cert file to use to
    48    verify the Nomad server SSL certificate.
    49  
    50  - `nomad_ca-path` `(string: "")` - Path to a directory of PEM encoded CA cert
    51    files to verify the Nomad server SSL certificate.
    52  
    53  - `nomad_client-cert` `(string: "")` - Path to a PEM encoded client certificate
    54    for TLS authentication to the Nomad server.
    55  
    56  - `nomad-client-key` `(string: "")` - Path to an unencrypted PEM encoded private
    57    key matching the client certificate.
    58  
    59  - `nomad_tls-server-name` `(string: "")` - The server name to use as the SNI
    60    host when connecting via TLS.
    61  
    62  - `nomad_skip-verify` `(string: "")` - Do not verify TLS certificates. This is
    63    strongly discouraged.
    64  
    65  [go_plugin_github]: https://github.com/hashicorp/go-plugin