package topo

Get desktop application:
View/edit binary Protocol Buffers messages

BoundedInteger to capture the range of max or min for a particular constraint.

Used in: KernelParam

• int64 max_value = 1

• int64 min_value = 2

Used in: Config

• oneof config

  • SelfSignedCertCfg self_signed = 1

    self_signed will generate local certificates on the node.

    Additional options will be for loading pregenerated certs. Also support for CSR and generation workflow.

Config is the k8s pod specific configuration for a node.

Used in: Node

• repeated string command = 1

  Command to pass into pod.

• repeated string args = 2

  Command args to pass into the pod.

• string image = 3

  Docker image to use with pod.

• map<string, string> env = 4

  Map of environment variables to pass into the pod.

• string entry_command = 5

  Specific entry point command for accessing the pod.

• string config_path = 6

  Mount point for configuration inside the pod.

• string config_file = 7

  Default configuration file name for the pod.

• uint32 sleep = 8

  Sleeptime before starting the pod.

• optional CertificateCfg cert = 9

  Certificate configuration

• oneof config_data

  • bytes data = 101

    Byte data for the startup configuration file.

  • string file = 102

    File is always relative to the topology configuration file.

• string init_image = 10

  Docker image to use as an init container for the pod.

• optional google.protobuf.Any vendor_data = 11

  Vendor-specific data

HostConstraint is a constraint on the host where the node is running.

Used in: Node

• oneof constraint

  • KernelParam kernel_constraint = 1

    Includes the required kernel parameters that need to be configured.

Interface keys must be the same as the links a,z int.

Used in: Node

• string name = 1

  Name of the interface provided by Node implementation. This will be used to map the int_name into a vendor specific interface name. Vendor operators should provide the name mapping from the node interface key to this vendor specific name.

• string int_name = 2

  Internal device name. This name matches the key in the Node interface map. It will be returned by the operator. Assigned by KNE.

• uint32 mtu = 3

  Desired MTU for the interface.

• string peer_name = 4

  Peer node name. Assigned by KNE.

• string peer_int_name = 5

  Peer interface name. Assigned by KNE.

• int64 uid = 6

  Uid is the internal link identifier used by Meshnet.

• string group = 7

  Name of group to which this interface belongs

• Interface.InterfaceType type = 8

  Type of the interface - Loopback, Management , Data etc.

• string ip_address = 9

  ip_address associated with the interface.

Used in: Interface

• UNKNOWN = 0

• LOOPBACK = 1

• MANAGEMENT = 2

• DATA = 3

KernelParam is a parameter on the host kernel.

Used in: HostConstraint

• string name = 1

  MIB style name of the kernel state to constrain.

• oneof ConstraintType

  • BoundedInteger bounded_integer = 2

Link is single link between nodes in the topology. Interfaces must start eth1 - eth0 is the default k8s interface.

Used in: Topology

• string a_node = 1

• string a_int = 2

• string z_node = 3

• string z_int = 4

Node is a single container inside the topology

Used in: Topology

• string name = 1

  Name of the node in the topology. Must be unique.

• Node.Type type = 2

• map<string, string> labels = 4

  Metadata labels describing the node.

• optional Config config = 5

  Pod specific configuration of the node.

• map<uint32, Service> services = 6

  Map of services to enable on the node. The key is the external load balancer port to be used by the service. Multiple external services can be mapped to a single internal service port by reusing the inside_port in the service definition.

• map<string, string> constraints = 7

  Any k8s constraints required by node.

• Vendor vendor = 8

  Vendor enum replaces type.

• string model = 9

  Model of the node.

• string version = 10

  Version string used to identify a software release.

• string os = 11

  Operating system type.

• map<string, Interface> interfaces = 12

  Interfaces is a map of container interfaces used by the node. If interfaces is empty the interfaces defined in the links portion of the topology will be populated into the node.

• repeated HostConstraint host_constraints = 13

  Any host constraints required by the node. These may not be required by a vendor, but it can be used to provide requirements for the node.

• string pod_ip = 14

  Assigned by KNE. Cluster-internal IP assigned by Kubernetes for the pod. This IP comes from the worker node's IP pool.

Used in: Node

• UNKNOWN = 0

• HOST = 1

• ARISTA_CEOS = 2

• JUNIPER_CEVO = 3

• CISCO_CXR = 4

• QUAGGA = 5

• FRR = 6

• JUNIPER_VMX = 7

• CISCO_CSR = 8

• NOKIA_SRL = 9

• IXIA_TG = 10

• GOBGP = 11

• CISCO_XRD = 12

• CISCO_E8000 = 13

• LEMMING = 14

Used in: CertificateCfg

• string cert_name = 1

  Certificate name on the node.

• string key_name = 2

  Key name on the node.

• uint32 key_size = 3

  RSA keysize to use for key generation.

• string common_name = 4

  Common name to set in the cert.

Service is k8s Service to exposed to the cluster. The initial input can be provided by the user for which services they would like exposed. Once the service is created KNE will fill in the outside information for the user to access the services. The user should specify inside port for this is the port the container will listen on.

Used in: Node

• string name = 1

  Name of the service (optional)

• uint32 inside = 2

  Inside port to map Node (container listening port)

• uint32 outside = 3

  Assigned by KNE.

  Outside port used by service. (same a service key)

• string outside_ip = 5

  External IP assigned by cluster load balancer.

• string inside_ip = 4

  Used internally by KNE.

  Cluster IP for the service.

• uint32 node_port = 6

  Port on the K8s worker node used by the cluster.

• repeated string names = 7

  List of service names to be mapped to the port (optional). If only one field out of "name" or "names" is provided in the input topo, the unspecified field is ignored. If both are provided, names in both fields are considered excluding any duplicate values.

Topology message defines what nodes and links will be created inside the mesh.

Used in: controller.CreateTopologyRequest, controller.CreateTopologyResponse, controller.ShowTopologyResponse

• string name = 1

  Name of the topology - will be linked to the cluster name

• repeated Node nodes = 2

  List of nodes in the topology

• repeated Link links = 3

  connections between Nodes.

Vendor of the node. Topology manager uses this enum to dispatch the node to the correct controller.

Used in: event.Node, Node

• UNKNOWN = 0

• HOST = 1

• ARISTA = 2

• CISCO = 3

• JUNIPER = 4

• KEYSIGHT = 5

• FRR = 6

• QUAGGA = 7

• GOBGP = 8

• NOKIA = 9

• OPENCONFIG = 10

• ALPINE = 11

• DRIVENETS = 12

• FORWARD = 13