package controller

Get desktop application:
View/edit binary Protocol Buffers messages

Topology manager service definition.

• rpc CreateTopology (CreateTopologyRequest, CreateTopologyResponse)

  controller.proto:25

  Creates a topology with and responds with topology name and state.

  message CreateTopologyRequest

  controller.proto:222

  Request message to create a topology.

  • optional topo.Topology topology = 1

  • string kubecfg = 2

  message CreateTopologyResponse

  controller.proto:228

  Returns create topology response.

  • string topology_name = 1

  • TopologyState state = 2

  • optional topo.Topology topology = 3

    topology will return the resolved topology and service mappings.

• rpc DeleteTopology (DeleteTopologyRequest, DeleteTopologyResponse)

  controller.proto:27

  Deletes a topology.

  message DeleteTopologyRequest

  controller.proto:236

  Request message to delete a topology.

  • string topology_name = 1

  message DeleteTopologyResponse

  controller.proto:241

  Returns delete topology response.

  (message has no fields)

• rpc ShowTopology (ShowTopologyRequest, ShowTopologyResponse)

  controller.proto:29

  Shows the topology info and responds with the current topology state.

  message ShowTopologyRequest

  controller.proto:245

  Request message to view topology info.

  • string topology_name = 1

  message ShowTopologyResponse

  controller.proto:250

  Returns topology view response.

  • TopologyState state = 1

  • optional topo.Topology topology = 2

• rpc CreateCluster (CreateClusterRequest, CreateClusterResponse)

  controller.proto:31

  Creates kind cluster and responds with cluster name and state.

  message CreateClusterRequest

  controller.proto:161

  Request message to create a cluster.

  • oneof cluster_spec

    • KindSpec kind = 1

    • ExternalSpec external = 5

    • KubeadmSpec kubeadm = 6

  • oneof ingress_spec

    • MetallbSpec metallb = 2

  • oneof cni_spec

    • MeshnetSpec meshnet = 3

  • repeated ControllerSpec controller_specs = 4

  message CreateClusterResponse

  controller.proto:184

  Returns create cluster response.

  • string name = 1

  • ClusterState state = 2

• rpc DeleteCluster (DeleteClusterRequest, DeleteClusterResponse)

  controller.proto:33

  Deletes a kind cluster by cluster name.

  message DeleteClusterRequest

  controller.proto:190

  Request message to delete a cluster.

  • string name = 1

  message DeleteClusterResponse

  controller.proto:195

  Returns delete cluster response.

  (message has no fields)

• rpc ShowCluster (ShowClusterRequest, ShowClusterResponse)

  controller.proto:35

  Shows cluster state and topologies deployed in the cluster.

  message ShowClusterRequest

  controller.proto:199

  Request message to show cluster by name.

  • string name = 1

  message ShowClusterResponse

  controller.proto:204

  Returns show cluster response.

  • ClusterState state = 1

  • repeated string topology_names = 2

  • string api_server_endpoint = 3

    The following fields are only populated for Kubeadm clusters.

  • string token = 4

  • string discovery_token_ca_cert_hash = 5

  • string cri_socket = 6

• rpc PushConfig (PushConfigRequest, PushConfigResponse)

  controller.proto:37

  Pushes config to a device in a topology.

  message PushConfigRequest

  controller.proto:256

  Request message to push config.

  • string topology_name = 1

  • string device_name = 2

  • bytes config = 3

  message PushConfigResponse

  controller.proto:263

  Returns push config response.

  (message has no fields)

• rpc ResetConfig (ResetConfigRequest, ResetConfigResponse)

  controller.proto:39

  Resets config of a device in a topology.

  message ResetConfigRequest

  controller.proto:267

  Request message to reset config.

  • string topology_name = 1

  • string device_name = 2

  message ResetConfigResponse

  controller.proto:273

  Returns reset config response.

  (message has no fields)

• rpc ApplyCluster (ApplyClusterRequest, ApplyClusterResponse)

  controller.proto:41

  Applies kubeyaml to a running cluster.

  message ApplyClusterRequest

  controller.proto:277

  Request message to apply kubeyaml to a cluster.

  • string name = 1

  • bytes config = 2

  message ApplyClusterResponse

  controller.proto:283

  Returns apply cluster response.

  (message has no fields)

• rpc JoinCluster (JoinClusterRequest, JoinClusterResponse)

  controller.proto:43

  Joins host into an existing Kubeadm cluster.

  message JoinClusterRequest

  controller.proto:287

  Request message to join in to a Kubeadm cluster.

  • string api_server_endpoint = 1

  • string token = 2

  • string discovery_token_ca_cert_hash = 3

  • string cri_socket = 4

  • string credential_provider_config = 5

  message JoinClusterResponse

  controller.proto:296

  Returns join cluster response.

  (message has no fields)

CEOSLab specifications

Used in: ControllerSpec

• string manifest_dir = 1

• optional Manifest operator = 2

CdnosSpec specifications

Used in: ControllerSpec

• optional Manifest operator = 1

Used in: CreateClusterResponse, ShowClusterResponse

• CLUSTER_STATE_UNSPECIFIED = 0

• CLUSTER_STATE_CREATING = 1

• CLUSTER_STATE_RUNNING = 2

• CLUSTER_STATE_ERROR = 3

Controller specifications

Used in: CreateClusterRequest

• oneof spec

  • IxiaTGSpec ixiatg = 1

  • SRLinuxSpec srlinux = 2

  • CEOSLabSpec ceoslab = 3

  • LemmingSpec lemming = 4

  • CdnosSpec cdnos = 5

External cluster specifications

Used in: CreateClusterRequest

• string network = 1

  name of the docker network to use for ingress

IxiaTG config map values

Used in: IxiaTGSpec

• string release = 1

• repeated IxiaTGImage images = 2

IxiaTG image identifier

Used in: IxiaTGConfigMap

• string name = 1

• string path = 2

• string tag = 3

IxiaTG specifications

Used in: ControllerSpec

• string manifest_dir = 1

• optional IxiaTGConfigMap config_map = 2

• optional Manifest operator = 3

• optional Manifest cfg_map = 4

Kind cluster specifications

Used in: CreateClusterRequest

• string name = 1

• bool recycle = 2

• string version = 3

• string image = 4

• bool retain = 5

• string kubecfg = 6

• repeated string google_artifact_registries = 7

• map<string, string> container_images = 8

  container_images is a map of source images to target images for containers to load in the kind cluster. For example: container_images = { "us-west1-docker.pkg.dev/pkg/a:ga": "pkg/a:latest", "us-west1-docker.pkg.dev/pkg/b:v0.8.0": "pkg/b:v0.8.0", } Would load images "pkg/a:latest" and "pkg/b:v0.8.0" into the cluster after fetching their source images from "us-west1-docker.pkg.dev".

• string config = 9

• repeated string additional_manifests = 10

Used in: CreateClusterRequest

• string cri_socket = 1

• string pod_network_cidr = 2

• optional Manifest pod_network_add_on_manifest = 3

• string token_ttl = 4

• string network = 5

  name of the docker network to use for ingress

• bool allow_control_plane_scheduling = 6

• string credential_provider_config = 7

LemmingSpec specifications

Used in: ControllerSpec

• string manifest_dir = 1

• optional Manifest operator = 2

Used in: CEOSLabSpec, CdnosSpec, IxiaTGSpec, KubeadmSpec, LemmingSpec, MeshnetSpec, MetallbSpec, SRLinuxSpec

• oneof manifest_data

  • bytes data = 101

    Byte data for the manifest.

  • string file = 102

    File is an absolute path to the local manifest file.

Meshnet specifications

Used in: CreateClusterRequest

• string manifest_dir = 1

• optional Manifest manifest = 2

Metallb specifications

Used in: CreateClusterRequest

• string manifest_dir = 1

• int32 ip_count = 2

• optional Manifest manifest = 3

SRLinux specifications

Used in: ControllerSpec

• string manifest_dir = 1

• optional Manifest operator = 2

Used in: CreateTopologyResponse, ShowTopologyResponse

• TOPOLOGY_STATE_UNSPECIFIED = 0

• TOPOLOGY_STATE_CREATING = 1

• TOPOLOGY_STATE_RUNNING = 2

• TOPOLOGY_STATE_ERROR = 3