package spec

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: Provider

• string secretKey = 1

• string accessKey = 2

Used in: DNS

• string hostname = 1

• string endpoint = 2

Used in: claudie.DetermineApiEndpointChangeRequest, UpdateState.LbEndpoint

• NoChange = 0

  NoChange represents the 1st case - no change is needed as the LB cluster is currently attached and the desired spec contains no changes.

• AttachingLoadBalancer = 1

  AttachingLoadBalancer represents 2nd case - the K8s cluster previously didn't have an LB cluster attached and the ports needed to communicate with the API server were exposed. After attaching an LB cluster to the existing K8s cluster the ports were closed and are no longer accessible, and thus we need to change the API endpoint.

• DetachingLoadBalancer = 2

  DetachingLoadBalancer represents 3rd. case - the K8s cluster had an existing LB cluster attached but the new state removed the LB cluster and thus the API endpoint needs to be changed back to one of the control nodes of the cluster.

• EndpointRenamed = 3

  EndpointRenamed represents the 4th. case - the K8s cluster has an existing LB cluster attached and also keeps it but the endpoint has changed in the desired state.

• MoveEndpoint = 4

  MoveEndpoint represents the 5th. case - the K8s cluster has an existing LB cluster attached, but it will be switched to a different LB cluster in the desired state.

Autoscaler configuration on per node pool basis.

Used in: DynamicNodePool

• int32 min = 1

  Minimum number of nodes in node pool.

• int32 max = 2

  Maximum number of nodes in node pool.

Used in: Provider

• string subscriptionID = 1

• string tenantID = 2

• string clientID = 3

• string clientSecret = 4

Used in: Provider

• string token = 1

ClusterInfo holds general information about the clusters.

Used in: K8scluster, LBcluster

• string name = 1

  Name of the cluster.

• string hash = 2

  Random hash of the cluster.

• repeated NodePool nodePools = 5

  Array of node pools this cluster is made of.

Used in: Config

• optional Clusters current = 1

• optional Clusters desired = 2

• optional Events events = 3

• optional Workflow state = 4

ClusterType specifies the type of the cluster.

• K8s = 0

  Kubernetes cluster.

• LB = 1

  Load balancer cluster.

Used in: claudie.NextTaskResponse, claudie.TaskCompleteRequest, ClusterState

• optional K8scluster k8s = 1

• optional LoadBalancers loadBalancers = 2

Config holds data for a single manifest.

Used in: claudie.GetConfigResponse, claudie.ListConfigResponse

• uint64 version = 1

  version of the config.

• string name = 2

  Config name - same as input manifest name.

• optional KubernetesContext k8sCtx = 3

  Information related within a k8s context.

• optional Manifest manifest = 4

  Client defined manifest.

• map<string, ClusterState> clusters = 5

  Clusters parsed from the supplied manifest.

Used in: Task

• optional K8scluster k8s = 1

• optional LoadBalancers lbs = 2

DNS holds general information about the DNS records.

Used in: LBcluster

• string dnsZone = 1

  DNS zone for the DNS records.

• string hostname = 2

  User specified hostname. (optional)

• optional Provider provider = 3

  Provider for the DNS records.

• string endpoint = 4

  The whole hostname of the DNS record.

• repeated AlternativeName alternativeNames = 5

  alternative names for which A records will be created in addition to the hostname.

Used in: Task

• optional DeleteState.K8s k8s = 1

• repeated DeleteState.LoadBalancer lbs = 2

Used in: DeleteState

• bool destroy = 1

  if set, the whole k8s cluster and all of its attached loadbalancers should be destroyed.

• map<string, DeletedNodes> nodepools = 2

  if 'destroy' is not set, the deletion process should look at the specifies nodepools and their nodes which should be deleted.

Used in: DeleteState

• string id = 1

  id of the loadbalancer.

• bool destroy = 2

  if set, the whole loadbalancer cluster will be destroyed.

• map<string, DeletedNodes> nodepools = 3

  if 'destroy' is not set, the deletion process should look at the specifies nodepools and their nodes which should be deleted.

Used in: claudie.DeleteNodesRequest, DeleteState.K8s, DeleteState.LoadBalancer

• repeated string nodes = 1

  nodes specifies which nodes should be deleted from the nodepool.

• bool keepNodePoolIfEmpty = 2

  keepNodePoolIfEmpty specifies if the nodepool should be deleted from the current state if its node count reaches zero. Currently this will only be used with autoscaled dynamic nodepools which can have a minimum of 0 nodes, other nodepool types will have this always set to false to indicate that after deletion of all nodes the nodepool should no longer be tracked in the current state.

DynamicNodePool represents dynamic node pool used in cluster.

Used in: NodePool

• string serverType = 1

  Machine type of the nodes.

• string image = 2

  OS image of the nodes.

• int32 storageDiskSize = 3

  Storage disk size of the nodes.

• string region = 4

  Geograhical region of the nodes.

• string zone = 5

  Datacentre zone for the nodes.

• int32 count = 6

  Number of the nodes in the node pool.

• optional Provider provider = 7

  Provider configuarion of the node pool.

• optional AutoscalerConf autoscalerConfig = 9

  Autoscaler configuration. (optional)

• optional MachineSpec machineSpec = 10

  MachineSpec configuration. (optional)

• string publicKey = 11

• string privateKey = 12

• string cidr = 14

  Cidr initially empty, will be set once the exising state is transferred.

Used in: TaskEvent

• UNKNOWN = 0

• CREATE = 1

• UPDATE = 2

• DELETE = 3

Used in: ClusterState

• repeated TaskEvent events = 1

• int32 ttl = 2

• bool autoscaled = 3

Used in: Provider

• string key = 1

• string project = 2

Used in: Provider

• string token = 1

Used in: Provider

• string token = 1

Used in: Provider

• string token = 1

InstallationProxy holds general information about a proxy used to build a K8s cluster.

Used in: K8scluster

• string mode = 1

  Proxy installation mode.

• string endpoint = 2

  Proxy endpoint used to access the proxy.

K8scluster represents a single kubernetes cluster specified in the manifest.

Used in: claudie.BuildClusterRequest, claudie.BuildClusterResponse, claudie.BuildInfrastructureRequest, claudie.BuildInfrastructureResponse.InfrastructureData, claudie.CiliumRolloutRestartRequest, claudie.DeleteClusterMetadataRequest, claudie.DeleteKubeconfigRequest, claudie.DeleteNodesRequest, claudie.DeleteNodesResponse, claudie.DestroyClusterAutoscalerRequest, claudie.DestroyClusterRequest, claudie.DestroyClusterResponse, claudie.DestroyInfrastructureRequest, claudie.DestroyInfrastructureResponse, claudie.DetermineApiEndpointChangeRequest, claudie.DetermineApiEndpointChangeResponse, claudie.InstallRequest, claudie.InstallResponse, claudie.PatchClusterInfoConfigMapRequest, claudie.PatchKubeProxyConfigMapRequest, claudie.PatchKubeadmConfigMapRequest, claudie.PatchNodesRequest, claudie.RemoveClaudieUtilitiesRequest, claudie.RemoveLBScrapeConfigRequest, claudie.SetUpClusterAutoscalerRequest, claudie.SetUpLBRequest, claudie.SetUpLBResponse, claudie.SetUpStorageRequest, claudie.SetUpStorageResponse, claudie.StoreClusterMetadataRequest, claudie.StoreKubeconfigRequest, claudie.StoreLBScrapeConfigRequest, claudie.UpdateAPIEndpointRequest, claudie.UpdateAPIEndpointResponse, claudie.UpdateProxyEnvsK8sServicesRequest, claudie.UpdateProxyEnvsOnNodesRequest, Clusters, CreateState, UpdateState

• optional ClusterInfo clusterInfo = 1

  General info about the cluster.

• string network = 2

  Network range for the VPN.

• string kubeconfig = 3

  Kubeconfig of the cluster.

• string kubernetes = 4

  Kubernetes version.

• optional InstallationProxy installationProxy = 5

  General information about a proxy used to build a K8s cluster.

Used in: claudie.UpsertManifestRequest, Config

• string name = 1

  name represents the input manifest resource name in Kubernetes

• string namespace = 2

  namespace represents the input manifest resource namespace in Kubernetes

LBcluster represents a single load balancer cluster specified in the manifest.

Used in: claudie.BuildInfrastructureRequest, claudie.BuildInfrastructureResponse.InfrastructureData, claudie.DestroyInfrastructureRequest, claudie.DestroyInfrastructureResponse, claudie.DetermineApiEndpointChangeRequest, claudie.DetermineApiEndpointChangeResponse, claudie.InstallRequest, claudie.InstallResponse, claudie.RemoveClaudieUtilitiesRequest, claudie.SetUpLBRequest, claudie.SetUpLBResponse, claudie.StoreClusterMetadataRequest, claudie.StoreLBScrapeConfigRequest, LoadBalancers

• optional ClusterInfo clusterInfo = 1

  General info about the cluster.

• repeated Role roles = 2

  Array of Load balancer roles.

• optional DNS dns = 3

  DNS information.

• string targetedK8s = 4

  Kubernetes cluster name of the cluster this load balancer is attached to.

• bool usedApiEndpoint = 5

  usedApiEndpoint signals which LB is actually used as the api endpoint. Claudie manifest validation does not allow for multiple API endpoints to be present, however. Internally claudie can deal with more loadbalancers that have the API role, this is due to the creation of intermediate representation which always add new infrastructure before making any further changes. To recognize which of them is actually used this field was added.

Used in: Clusters, CreateState, UpdateState

• repeated LBcluster clusters = 1

MachineSpec further specifies the requested server type.

Used in: DynamicNodePool

• int32 cpuCount = 1

• int32 memory = 2

Used in: claudie.UpsertManifestRequest, Config

• string raw = 1

• bytes checksum = 2

• bytes lastAppliedChecksum = 3

• Manifest.State state = 4

Used in: Manifest

• Pending = 0

• Scheduled = 1

• Done = 2

• Error = 3

Node represents a single node from the node pool.

Used in: NodePool

• string name = 1

  Name of the node.

• string private = 2

  Private IP of the node in the VPN.

• string public = 3

  Public IP of the node.

• NodeType nodeType = 4

  Type of the node.

• string username = 5

  Username of a user with root privileges. Also used in SSH connection

NodePool represents a single node pool used in cluster.

Used in: claudie.UpdateNodePoolRequest, ClusterInfo

• oneof Type

  Dynamic or Static node pool info.

  • DynamicNodePool dynamicNodePool = 1

  • StaticNodePool staticNodePool = 2

• string name = 3

  Name of static node pool.

• repeated Node nodes = 4

  Array of nodes in this node pool.

• bool isControl = 5

  Flag to differentiate between control and compute nodes.

• map<string, string> labels = 6

  User defined labels.

• repeated Taint taints = 7

  User defined taints.

• map<string, string> annotations = 8

  User definded annotations.

NodeType specifies the type of the node.

Used in: Node

• worker = 0

  Worker/Compute node.

• master = 1

  Master/Control node.

• apiEndpoint = 2

  Master node, which is also an API endpoint.

Used in: Provider

• string userOCID = 1

• string tenancyOCID = 2

• string keyFingerprint = 3

• string compartmentOCID = 4

• string privateKey = 5

Used in: DNS, DynamicNodePool

• string specName = 1

• string cloudProviderName = 2

• oneof ProviderType

  • GCPProvider gcp = 3

  • HetznerProvider hetzner = 4

  • HetznerDNSProvider hetznerdns = 5

  • OCIProvider oci = 6

  • AWSProvider aws = 7

  • AzureProvider azure = 8

  • CloudflareProvider cloudflare = 9

  • GenesisCloudProvider genesiscloud = 10

• optional TemplateRepository templates = 13

ProxyEnvs holds information about a need to update proxy envs, proxy endpoint, and no proxy list.

Used in: claudie.UpdateProxyEnvsK8sServicesRequest, claudie.UpdateProxyEnvsOnNodesRequest

• ProxyOp op = 1

  Signal a need to update proxy envs

• string httpProxyUrl = 2

  Holds a proxy endpoint.

• string noProxyList = 3

  Holds a list of IPs and hostnames that aren't routed through proxy.

Used in: ProxyEnvs

• NONE = 0

  None specifies that no change happened in the desired state of the Proxy settings compared to the current.

• MODIFIED = 1

  Modified indicates some change happened, either add, delete, modified, replaced etc.

• OFF = 2

  Off indicates that the Proxy envs should be turned off.

Used in: TaskEvent

• oneof Do

  • Retry.Repeat repeat = 3

  • Retry.Rollback rollback = 4

Used in: Retry

• Repeat.Kind kind = 1

• uint32 currentTick = 2

  currentTick specifies the current number of ticks. A tick is an regular interval at which manifests are being checked. to check the Tick timeout see: manager/internal/service/watchers.go

• uint32 stopAfter = 3

  stopAfter specifies the maximum number of ticks, after reaching this value the manifest will be rescheduled for the last time before giving up.

• uint32 retryAfter = 4

  retryAfter specifies the number of ticks to wait before rescheduling the manifest again. this value will be set to the value of currentTick after it is updated.

Used in: Repeat

• ENDLESS = 0

• EXPONENTIAL = 1

Used in: Retry

• repeated TaskEvent tasks = 1

Role represents a single loadbalancer role from the manifest.

Used in: LBcluster

• string name = 1

  Name of the role.

• string protocol = 2

  Protocol that load balancer uses to forward traffic. ["tcp", "udp"]

• int32 port = 3

  Port that load balancer will forward from.

• int32 targetPort = 4

  Port that load balancer will forward to.

• repeated string targetPools = 7

  Targeted nodes in Kubernetes clusters.

• RoleType roleType = 6

  Type of the role.

• optional Role.Settings settings = 8

  Additional settings for the role.

Used in: Role

• bool proxyProtocol = 1

• bool stickySessions = 2

RoleType specifies the type of the role.

Used in: Role

• ApiServer = 0

  API server load balancer.

• Ingress = 1

  Ingress load balancer.

StaticNodePool represents static node pool used in cluster.

Used in: NodePool

• map<string, string> nodeKeys = 1

  Map of keys for each static node in [<Node Endpoint>]<Key> form.

Enum used to replace data not present in static nodepools.

• STATIC_PROVIDER = 0

• STATIC_REGION = 1

• STATIC_ZONE = 2

Taint defines a custom defined taint for the node pools.

Used in: NodePool

• string key = 1

  Taint key.

• string value = 2

  Taint value.

• string effect = 3

  Taint effect.

Used in: TaskEvent

• optional CreateState createState = 1

• optional UpdateState updateState = 2

• optional DeleteState deleteState = 3

• uint64 options = 4

Used in: claudie.NextTaskResponse, Events, Retry.Rollback

• string id = 1

• optional google.protobuf.Timestamp timestamp = 2

• Event event = 3

• optional Task task = 4

• string description = 5

• optional Retry onError = 7

Used in: Provider

• string repository = 1

• optional string tag = 2

• string path = 3

• string commitHash = 4

Used in: Task

• optional K8scluster k8s = 1

• optional LoadBalancers lbs = 2

• oneof EndpointChange

  • UpdateState.K8sEndpoint newControlEndpoint = 3

  • UpdateState.LbEndpoint lbEndpointChange = 4

Used in: UpdateState

• string nodepool = 1

• string node = 2

Used in: UpdateState

• ApiEndpointChangeState state = 1

• string currentEndpointId = 2

• string desiredEndpointId = 3

Used in: claudie.NextTaskResponse, claudie.TaskCompleteRequest, claudie.TaskUpdateRequest, ClusterState

• Workflow.Stage stage = 1

• Workflow.Status status = 2

• string description = 3

  additional information describing the state and status.

Used in: Workflow

• NONE = 0

  NONE indicates that no stage is currently executing.

• TERRAFORMER = 1

  TERRAFORMER indicates that the cluster is currently being build in terraformer.

• ANSIBLER = 2

  ANSIBLER indicates that the cluster is currently being build in ansibler.

• KUBE_ELEVEN = 3

  KUBE_ELEVEN indicates that the cluster is currently being build in kube eleven.

• KUBER = 4

  KUBER indicates that the cluster is currently being build in kuber.

• DESTROY_TERRAFORMER = 7

  DESTROY_TERRAFORMER indicates that infra for a cluster is being deleted.

• DESTROY_KUBER = 8

  DESTROY_KUBER indicates that data for a cluster is being deleted.

• DELETE_NODES = 9

  DELETE_NODES indicates the nodes are being deleted for the cluster.

Used in: Workflow

• DONE = 0

  DONE indicates that the workflow has finished.

• ERROR = 1

  ERROR indicates that an error occurred while building the cluster.

• IN_PROGRESS = 2

  IN_PROGRESS indicates that the cluster is currently being build.