Default package

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: Vserver

• required string grantee = 1

  The user or group.

• required AccessGrant.Role role = 2

  The Role granted to the grantee.

• required AccessGrant.Type type = 3

  The Type of AccessGrant.

Used in: AccessGrant

• ADMIN = 1

• OPS = 2

Used in: AccessGrant

• USER = 1

• GROUP = 2

Used in: Cluster

• required string name = 1

  The name of the group.

• repeated string member = 2

  The members of the group.

Used in: Metadata

• required string name = 1

• required string value = 2

Used in: Vserver

• required Host host = 1

• optional int32 weight = 2

• required Host seesaw_vip = 1

• repeated Host node = 2

• optional string vmac = 3

• optional uint32 bgp_local_asn = 4

  The local ASN for BGP peering.

• optional uint32 bgp_remote_asn = 5

  The remote ASN for BGP peering. If unset, BGP will not be used.

• repeated Host bgp_peer = 6

  The BGP peers. If empty, BGP will not be used.

• repeated Vserver vserver = 7

  The service VIPs hosted by this cluster, excluding those that are misconfigured (see the misconfigured_vserver attribute).

• repeated Vlan vlan = 8

• repeated MisconfiguredVserver misconfigured_vserver = 9

  The list of vservers that have broken configurations.

• optional Metadata metadata = 10

  Metadata about this Cluster configuration.

• repeated string dedicated_vip_subnet = 11

  The dedicated VIP subnet(s) for this cluster, in CIDR notation.

• repeated AccessGroup access_groups = 12

  The access groups that are referenced by the vservers.

High-Availability states for a Seesaw Node.

• UNKNOWN = 0

  State of the node could not be determined.

• BACKUP = 1

  Node is in a ready but non-serving state.

• DISABLED = 2

  Node is disabled, will not serve traffic.

• ERROR = 3

  Node is in a failure state.

• LEADER = 4

  Node is in an active and serving state.

• SHUTDOWN = 5

  Node is in shutdown state and will stop serving requests.

TODO(angusc): Use different message types for the different healthcheck types.

Used in: Vserver, VserverEntry

• required Healthcheck.Type type = 1

• optional int32 interval = 2

  Healthcheck interval in seconds.

• optional int32 timeout = 3

  Healthcheck timeout in seconds.

• optional int32 port = 4

  Healthcheck port. For Vserver healthchecks, this field is required. For VserverEntry healthchecks, it is optional and uses the VserverEntry port by default.

• optional string send = 5

  String to send for UDP/TCP/HTTP(S) healthcheck.

• optional string receive = 6

  Expected response for UDP/TCP/HTTP(S) healthcheck.

• optional int32 code = 7

  Expected response code for healthcheck.

• optional Healthcheck.Mode mode = 8

  The Mode of this healthcheck.

• optional string method = 9

  The HTTP request method to use for an HTTP(S) healthcheck.

• optional bool proxy = 10

  Perform a healthcheck against an HTTP proxy.

• optional bool tls_verify = 11

  Do TLS verification.

• optional int32 retries = 12

  Number of retries before a healthcheck is considered to have failed.

Used in: Healthcheck

• PLAIN = 1

• DSR = 2

• TUN = 3

Used in: Healthcheck

• ICMP_PING = 1

• UDP = 2

• TCP = 3

• HTTP = 4

• HTTPS = 5

• DNS = 6

• TCP_TLS = 7

• RADIUS = 8

Used in: Backend, Cluster, Vlan, Vserver

• required string fqdn = 1

  Fully qualified hostname.

• optional string ipv4 = 2

  An IPv4 address and prefix length in CIDR format.

• optional string ipv6 = 3

  An IPv6 address and prefix length in CIDR format.

• optional Host.Status status = 4

  Host status.

Servicedb statuses

Used in: Host

• PRODUCTION = 1

• TESTING = 2

• BUILDING = 3

• STANDBY = 4

• FAILURE = 5

• DISABLED = 6

• PROPOSED = 7

Used in: Cluster

• required int64 last_updated = 1

  The UNIX timestamp at which the Cluster configuration was last updated.

• repeated Attribute attribute = 2

  Miscellaneous details about the Cluster configuration (info on upstream source data, etc) go here.

Used in: Cluster

• required string name = 1

• optional string error_message = 2

Used in: VserverEntry

• TCP = 1

• UDP = 2

Used in: Cluster

• required int32 vlan_id = 1

• required Host host = 2

Used in: Cluster

• required string name = 1

  The name of this vserver.

• required Host entry_address = 2

  VIP hostname and IP(s).

• required string rp = 3

  Contact info for Responsible Party.

• optional bool use_fwm = 4

  Use firewall mark instead of individual service configurations.

• repeated VserverEntry vserver_entry = 5

• repeated Healthcheck healthcheck = 7

  The healthchecks to perform on the backends, in addition to those that are VserverEntry specific.

• repeated AccessGrant access_grant = 8

  The access grants for this vserver.

• repeated string warning = 9

  Warning messages about this Vserver (such as misconfigured backends) to be displayed on operator consoles.

• repeated Backend backend = 10

  The list of backends for this vserver.

Used in: Vserver

• required Protocol protocol = 1

• required int32 port = 2

• optional VserverEntry.Scheduler scheduler = 5

• optional VserverEntry.Mode mode = 6

• optional int32 persistence = 7

  See --persisent in man ipvsadm(8).

• optional bool quiescent = 8

  Continue sending packets for existing connections to the same backend, even when that backend is failing healthchecks.

• optional float server_low_watermark = 9

  The minimum fraction of backends that must be healthy for the vserver to be active. If the number of backends falls below this watermark, the vserver is considered unhealthy. Valid values are 0.0 to 1.0. If unset, the value of server_high_watermark is used.

• optional float server_high_watermark = 10

  The minimum fraction of backends that must be healthy for vserver to become active. Default is 0.0 .

• optional int32 lthreshold = 11

  --l-threshold per man ipvsadm(8).

• optional int32 uthreshold = 12

  --u-threshold per man ipvsadm(8).

• repeated Healthcheck healthcheck = 13

  The healthchecks to perform on the backends.

• optional bool one_packet = 14

  Use "one packet" load balancing.

Used in: VserverEntry

• DSR = 1

  See --gatewaying in man ipvsadm(8).

• NAT = 2

  See --masquerding in man ipvsadm(8).

• TUN = 3

  See --ipip in man ipvsadm(8).

See --scheduler in man ipvsadm(8).

Used in: VserverEntry

• RR = 1

• WRR = 2

• LC = 3

• WLC = 4

• SH = 5

• MH = 6

  NOTE: MH scheduler option is available after Kernel 4.18. It is typically used without conntrack sync. Additional sysctl settings such as `net.ipv4.vs.sloppy_tcp` is required when operating in that mode to allow seamless failover. However, turning off conntrack sync could break other services on other scheduler settings. Ref: https://www.kernel.org/doc/Documentation/networking/ipvs-sysctl.txt