package api.v1.cluster

Get desktop application:
View/edit binary Protocol Buffers messages

The service to your cluster running Rig.

• rpc List (ListRequest, ListResponse)

  service.proto:12

  message ListRequest

  service.proto:67

  Request for listing available clusters.

  • optional model.Pagination pagination = 1

    Pagination options.

  message ListResponse

  service.proto:73

  Response for listing available clusters.

  • repeated Cluster clusters = 1

    List of clusters.

• rpc GetConfig (GetConfigRequest, GetConfigResponse)

  service.proto:14

  GetConfig returns the config for the cluster.

  message GetConfigRequest

  service.proto:23

  request for getting cluster config for an environment.

  • string environment_id = 1

    The environment to get cluster config for.

• rpc GetConfigs (GetConfigsRequest, GetConfigsResponse)

  service.proto:16

  GetConfigs returns the configs for all clusters.

  message GetConfigsRequest

  service.proto:44

  Empty Request for getting the configs of all clusters.

  (message has no fields)

  message GetConfigsResponse

  service.proto:47

  Empty Response for getting the configs of all clusters.

  • repeated GetConfigResponse clusters = 1

• rpc ListNodes (ListNodesRequest, ListNodesResponse)

  service.proto:18

  message ListNodesRequest

  service.proto:78

  • string cluster_id = 1

  message ListNodesResponse

  service.proto:82

  • repeated operator.cluster.Node nodes = 1

• rpc ListNodePods (ListNodePodsRequest, ListNodePodsResponse)

  service.proto:19

  message ListNodePodsRequest

  service.proto:86

  • string cluster_name = 1

  • string node_name = 2

  message ListNodePodsResponse

  service.proto:91

  • repeated Pod pods = 1

Cluster model.

Used in: ListResponse

• string cluster_id = 1

  ID of the cluster.

• optional config.v1alpha1.OperatorConfig operator_config = 2

• string operator_version = 3

• string k8s_version = 4

• optional model.Resources allocateable = 5

• optional model.Resources usage = 6

• optional model.Resources utilization = 7

Cluster type - Docker or kubernetes.

Used in: GetConfigResponse

• CLUSTER_TYPE_UNSPECIFIED = 0

• CLUSTER_TYPE_DOCKER = 1

• CLUSTER_TYPE_KUBERNETES = 2

Docker daemon dev registry

Used in: GetConfigResponse

(message has no fields)

response for getting cluster config for an environment.

Used as response type in: Service.GetConfig

Used as field type in: GetConfigsResponse

• ClusterType cluster_type = 1

  Type of the cluster.

• oneof dev_registry

  dev registry of the cluster. This is either a Docker daemon or a registry.

  • DockerDaemon docker = 2

    Docker.

  • Registry registry = 3

    Registry.

• bool ingress = 4

  if true, the cluster has an ingress controller.

Used in: ListNodePodsResponse

• string pod_name = 1

• string namespace = 2

• string project_name = 3

• string environment_name = 4

• string capsule_name = 5

Registry dev registry

Used in: GetConfigResponse

• string host = 1