vitess.io/vitess@v0.16.2/doc/vtadmin/clusters.yaml (about)

     1  defaults:
     2    # Configuration options here provide default options for all clusters.
     3    # Specifying a different value for an individual cluster will override the
     4    # default setting for that cluster.
     5  
     6    # Discovery implementation to use by default.
     7    discovery: "{consul|staticfile}"
     8  
     9    # Each discovery implementation has its own options, which are named according
    10    # to the regex:
    11    #   ^discovery-(?P<impl>\w+)-(?P<flag>.+)$
    12    # The full set of options for each discovery implementation is defined in that
    13    # implementation's factory function, e.g. NewConsul in
    14    # go/vt/vtadmin/cluster/discovery/discovery_consul.go and NewStaticFile in
    15    # discovery_static_file.go in the same directory.
    16  
    17    # Service name to use when discovering vtctlds from consul.
    18    discovery-consul-vtctld-service-name: "vtctld"
    19    # Path to json file containing vtctld and vtgate hostnames when using staticfile.
    20    discovery-staticfile-path: "/path/to/static/discovery.json"
    21  
    22    tablet-fqdn-tmpl: ""
    23  
    24    # Similar to how discovery flags are forwarded to the particular discovery
    25    # implementation, the vtctld and vtgate proxy components for a cluster are
    26    # configurable, by the prefixes "vtctld-" (for vtctld proxy) and "vtsql-" (for vtgate proxy).
    27    # These flags are defined in code in the (*Config).Parse functions in packages
    28    # go/vt/vtadmin/{vtctldclient,vtsql}.
    29  
    30    # Go template to produce a path to a json file containing Username and Password
    31    # to make requests against vtctlds in this cluster.
    32    vtctld-credentials-path-tmpl: "/path/to/vtctld/credentials/{{ .Cluster.Id }}.json"
    33  
    34    # Same as vtctld-credentials-path-tmpl, except used to make requests against
    35    # vtgates in the cluster.
    36    vtsql-credentials-path-tmpl: "/path/to/vtgate/credentials/{{ .Cluster.Id }}.json"
    37    # Optional comma-separated list of tags to pass to a discovery implementation
    38    # when discovering a vtgate in the cluster to connect to. The semantics of
    39    # the tags depend on the discovery implementation used.
    40    vtsql-discovery-tags: "tag1,tag2"
    41    # Username to send queries on behalf of. See package callerid.
    42    vtsql-effective-user: "my-effective-user"
    43  
    44    # VTAdmin also provides different RPC pools to gate the number of concurrent
    45    # requests it will make against vtctlds/vtgates in a given cluster, to prevent
    46    # overwhelming those components.
    47  
    48    # The backup read pool is used to constrain the number of GetBackups calls
    49    # made to a cluster simultaneously.
    50    backup-read-pool-size: 10
    51    backup-read-pool-timeout: 10ms
    52  
    53    # Other pools have the same size/timeout options, and include:
    54    # - schema-read-pool => for GetSchema, GetSchemas, and FindSchema api methods
    55    # - topo-read-pool => for generic topo methods (e.g. GetKeyspace, FindAllShardsInKeyspace)
    56    # - workflow-read-pool => for GetWorkflow/GetWorkflows api methods.