framework.xds_flags Namespace Reference

Variables
	CLIENT_NAME
	CLIENT_PORT
	COMPUTE_API_VERSION
	ENSURE_FIREWALL
	FIREWALL_ALLOWED_PORTS
	FIREWALL_SOURCE_RANGE
	FORCE_CLEANUP
	NETWORK
	PROJECT
	RESOURCE_PREFIX
	RESOURCE_SUFFIX
	SERVER_MAINTENANCE_PORT
	SERVER_NAME
	SERVER_PORT
	SERVER_XDS_HOST
	SERVER_XDS_PORT
	TESTING_VERSION
	XDS_SERVER_URI

Variable Documentation

CLIENT_NAME

framework.xds_flags.CLIENT_NAME

Initial value:

=  flags.DEFINE_string(
    "client_name",
    default="psm-grpc-client",
    help="The name to use for test client deployments")

Definition at line 102 of file xds_flags.py.

CLIENT_PORT

framework.xds_flags.CLIENT_PORT

Initial value:

=  flags.DEFINE_integer(
    "client_port",
    default=8079,
    lower_bound=1,
    upper_bound=65535,
    help=(
        "The port test client uses to run gRPC services: Channelz, CSDS, "
        "XdsStats, XdsUpdateClientConfigure, and ProtoReflection (optional).\n"
        "Doesn't have to be within --firewall_allowed_ports."))

Definition at line 106 of file xds_flags.py.

COMPUTE_API_VERSION

framework.xds_flags.COMPUTE_API_VERSION

Initial value:

=  flags.DEFINE_string(
    "compute_api_version",
    default='v1',
    help="The version of the GCP Compute API, e.g., v1, v1alpha")

Definition at line 39 of file xds_flags.py.

ENSURE_FIREWALL

framework.xds_flags.ENSURE_FIREWALL

Initial value:

=  flags.DEFINE_bool(
    "ensure_firewall",
    default=False,
    help="Ensure the allow-health-check firewall exists before each test case")

Definition at line 48 of file xds_flags.py.

FIREWALL_ALLOWED_PORTS

framework.xds_flags.FIREWALL_ALLOWED_PORTS

Initial value:

=  flags.DEFINE_list(
    "firewall_allowed_ports",
    default=['8080-8100'],
    help="Update the allowed ports of the firewall rule.")

Definition at line 56 of file xds_flags.py.

FIREWALL_SOURCE_RANGE

framework.xds_flags.FIREWALL_SOURCE_RANGE

Initial value:

=  flags.DEFINE_list(
    "firewall_source_range",
    default=['35.191.0.0/16', '130.211.0.0/22'],
    help="Update the source range of the firewall rule.")

Definition at line 52 of file xds_flags.py.

FORCE_CLEANUP

framework.xds_flags.FORCE_CLEANUP

Initial value:

=  flags.DEFINE_bool(
    "force_cleanup",
    default=False,
    help="Force resource cleanup, even if not created by this test run")

Definition at line 122 of file xds_flags.py.

NETWORK

framework.xds_flags.NETWORK

Initial value:

=  flags.DEFINE_string("network",
                              default="default",
                              help="GCP Network ID")

Definition at line 36 of file xds_flags.py.

PROJECT

framework.xds_flags.PROJECT

Initial value:

=  flags.DEFINE_string("project",
                              default=None,
                              help="(required) GCP Project ID.")

Definition at line 19 of file xds_flags.py.

RESOURCE_PREFIX

framework.xds_flags.RESOURCE_PREFIX

Initial value:

=  flags.DEFINE_string(
    "resource_prefix",
    default=None,
    help=("(required) The prefix used to name GCP resources.\n"
          "Together with `resource_suffix` used to create unique "
          "resource names."))

Definition at line 22 of file xds_flags.py.

RESOURCE_SUFFIX

framework.xds_flags.RESOURCE_SUFFIX

Initial value:

=  flags.DEFINE_string(
    "resource_suffix",
    default=None,
    help=("The suffix used to name GCP resources.\n"
          "Together with `resource_prefix` used to create unique "
          "resource names.\n"
          "(default: test suite will generate a random suffix, based on suite "
          "resource management preferences)"))

Definition at line 28 of file xds_flags.py.

SERVER_MAINTENANCE_PORT

framework.xds_flags.SERVER_MAINTENANCE_PORT

Initial value:

=  flags.DEFINE_integer(
    "server_maintenance_port",
    default=None,
    lower_bound=1,
    upper_bound=65535,
    help=("Server port running maintenance services: Channelz, CSDS, Health, "
          "XdsUpdateHealth, and ProtoReflection (optional).\n"
          "Must be within --firewall_allowed_ports.\n"
          "(default: the port is chosen automatically based on "
          "the security configuration)"))

Definition at line 72 of file xds_flags.py.

SERVER_NAME

framework.xds_flags.SERVER_NAME

Initial value:

=  flags.DEFINE_string(
    "server_name",
    default="psm-grpc-server",
    help="The name to use for test server deployments.")

Definition at line 62 of file xds_flags.py.

SERVER_PORT

framework.xds_flags.SERVER_PORT

Initial value:

=  flags.DEFINE_integer(
    "server_port",
    default=8080,
    lower_bound=1,
    upper_bound=65535,
    help="Server test port.\nMust be within --firewall_allowed_ports.")

Definition at line 66 of file xds_flags.py.

SERVER_XDS_HOST

framework.xds_flags.SERVER_XDS_HOST

Initial value:

=  flags.DEFINE_string(
    "server_xds_host",
    default="xds-test-server",
    help=("The xDS hostname of the test server.\n"
          "Together with `server_xds_port` makes test server target URI, "
          "xds:///hostname:port"))

Definition at line 82 of file xds_flags.py.

SERVER_XDS_PORT

framework.xds_flags.SERVER_XDS_PORT

Initial value:

=  flags.DEFINE_integer(
    "server_xds_port",
    default=8080,
    lower_bound=0,
    upper_bound=65535,
    help=("The xDS port of the test server.\n"
          "Together with `server_xds_host` makes test server target URI, "
          "xds:///hostname:port\n"
          "Must be unique within a GCP project.\n"
          "Set to 0 to select any unused port."))

Definition at line 90 of file xds_flags.py.

TESTING_VERSION

framework.xds_flags.TESTING_VERSION

Initial value:

=  flags.DEFINE_string(
    "testing_version",
    default=None,
    help="The testing gRPC version branch name. Like master, v1.41.x, v1.37.x")

Definition at line 117 of file xds_flags.py.

XDS_SERVER_URI

framework.xds_flags.XDS_SERVER_URI

Initial value:

=  flags.DEFINE_string(
    "xds_server_uri",
    default=None,
    help="Override Traffic Director server URI.")

Definition at line 44 of file xds_flags.py.