Node

import type { Node } from "https://googleapis.deno.dev/v1/trafficdirector:v3.ts";

Identifies a specific Envoy instance. The node identifier is presented to the management server, which may use this identifier to distinguish per Envoy configuration for serving. [#next-free-field: 13]

interface Node {

clientFeatures?: string[];

cluster?: string;

dynamicParameters?: {

[key: string]: ContextParams;

};

extensions?: Extension[];

id?: string;

listeningAddresses?: Address[];

locality?: Locality;

metadata?: {

[key: string]: any;

};

userAgentBuildVersion?: BuildVersion;

userAgentName?: string;

userAgentVersion?: string;

}

§Properties

clientFeatures?: string[]

[src]

Client feature support list. These are well known features described in the Envoy API repository for a given major version of an API. Client features use reverse DNS naming scheme, for example com.acme.feature. See :ref:the list of features that xDS client may support.

cluster?: string

[src]

Defines the local service cluster name where Envoy is running. Though optional, it should be set if any of the following features are used: :ref:statsd , :ref:health check cluster verification , :ref:runtime override directory , :ref:user agent addition , :ref:HTTP global rate limiting , :ref:CDS , and :ref:HTTP tracing , either in this message or via :option:--service-cluster.

dynamicParameters?: {

[key: string]: ContextParams;

}

[src]

Map from xDS resource type URL to dynamic context parameters. These may vary at runtime (unlike other fields in this message). For example, the xDS client may have a shard identifier that changes during the lifetime of the xDS client. In Envoy, this would be achieved by updating the dynamic context on the Server::Instance's LocalInfo context provider. The shard ID dynamic parameter then appears in this field during future discovery requests.

extensions?: Extension[]

[src]

List of extensions and their versions supported by the node.

id?: string

[src]

An opaque node identifier for the Envoy node. This also provides the local service node name. It should be set if any of the following features are used: :ref:statsd , :ref:CDS , and :ref:HTTP tracing , either in this message or via :option:--service-node.

listeningAddresses?: Address[]

[src]

Known listening ports on the node as a generic hint to the management server for filtering :ref:listeners to be returned. For example, if there is a listener bound to port 80, the list can optionally contain the SocketAddress (0.0.0.0,80). The field is optional and just a hint.

locality?: Locality

[src]

Locality specifying where the Envoy instance is running.

metadata?: {

[key: string]: any;

}

[src]

Opaque metadata extending the node identifier. Envoy will pass this directly to the management server.

userAgentBuildVersion?: BuildVersion

[src]

Structured version of the entity requesting config.

userAgentName?: string

[src]

Free-form string that identifies the entity requesting config. E.g. "envoy" or "grpc"

userAgentVersion?: string

[src]

Free-form string that identifies the version of the entity requesting config. E.g. "1.12.2" or "abcd1234", or "SpecialEnvoyBuild"