mirrors/talos
1
0
Fork 0
mirror of https://github.com/siderolabs/talos.git synced 2025-10-06 05:01:19 +02:00
Code Issues Packages Projects Releases Wiki Activity
talos/website/content/v1.4/reference/api.md
Andrey Smirnov aa14993539
feat: introduce network probes 
Network probes are configured with the specs, and provide their output
as a status.

At the moment only platform code can configure network probes.

If any network probes are configured, they affect network.Status
'Connectivity' flag.

Example, create the probe:

```
talosctl -n 172.20.0.3 meta write 0xa '{"probes": [{"interval": "1s", "tcp": {"endpoint": "google.com:80", "timeout": "10s"}}]}'
```

Watch probe status:

```
$ talosctl -n 172.20.0.3 get probe
NODE         NAMESPACE   TYPE          ID                  VERSION   SUCCESS
172.20.0.3   network     ProbeStatus   tcp:google.com:80   5         true
```

With failing probes:

```
$ talosctl -n 172.20.0.3 get probe
NODE         NAMESPACE   TYPE          ID                  VERSION   SUCCESS
172.20.0.3   network     ProbeStatus   tcp:google.com:80   4         true
172.20.0.3   network     ProbeStatus   tcp:google.com:81   1         false
$ talosctl -n 172.20.0.3 get networkstatus
NODE         NAMESPACE   TYPE            ID       VERSION   ADDRESS   CONNECTIVITY   HOSTNAME   ETC
172.20.0.3   network     NetworkStatus   status   5         true      true           true       true

```

Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
2023-03-31 15:20:21 +04:00

177 KiB
Raw Blame History

title, description
title description
API Talos gRPC API reference.

Table of Contents

Top

common/common.proto

Data

Field Type Label Description
metadata Metadata
bytes bytes

DataResponse

Field Type Label Description
messages Data repeated

Empty

Field Type Label Description
metadata Metadata

EmptyResponse

Field Type Label Description
messages Empty repeated

Error

Field Type Label Description
code Code
message string
details google.protobuf.Any repeated

Metadata

Common metadata message nested in all reply message types

Field Type Label Description
hostname string hostname of the server response comes from (injected by proxy)
error string error is set if request failed to the upstream (rest of response is undefined)
status google.rpc.Status error as gRPC Status

NetIP

Field Type Label Description
ip bytes

NetIPPort

Field Type Label Description
ip bytes
port int32

NetIPPrefix

Field Type Label Description
ip bytes
prefix_length int32

PEMEncodedCertificateAndKey

Field Type Label Description
crt bytes
key bytes

PEMEncodedKey

Field Type Label Description
key bytes

URL

Field Type Label Description
full_path string

Code

Name Number Description
FATAL 0
LOCKED 1
CANCELED 2

ContainerDriver

Name Number Description
CONTAINERD 0
CRI 1

File-level Extensions

Extension Type Base Number Description
remove_deprecated_enum string .google.protobuf.EnumOptions 93117 Indicates the Talos version when this deprecated enum will be removed from API.
remove_deprecated_enum_value string .google.protobuf.EnumValueOptions 93117 Indicates the Talos version when this deprecated enum value will be removed from API.
remove_deprecated_field string .google.protobuf.FieldOptions 93117 Indicates the Talos version when this deprecated filed will be removed from API.
remove_deprecated_message string .google.protobuf.MessageOptions 93117 Indicates the Talos version when this deprecated message will be removed from API.
remove_deprecated_method string .google.protobuf.MethodOptions 93117 Indicates the Talos version when this deprecated method will be removed from API.
remove_deprecated_service string .google.protobuf.ServiceOptions 93117 Indicates the Talos version when this deprecated service will be removed from API.

Top

resource/definitions/cluster/cluster.proto

AffiliateSpec

AffiliateSpec describes Affiliate state.

Field Type Label Description
node_id string
addresses common.NetIP repeated
hostname string
nodename string
operating_system string
machine_type talos.resource.definitions.enums.MachineType
kube_span KubeSpanAffiliateSpec

ConfigSpec

ConfigSpec describes KubeSpan configuration.

Field Type Label Description
discovery_enabled bool
registry_kubernetes_enabled bool
registry_service_enabled bool
service_endpoint string
service_endpoint_insecure bool
service_encryption_key bytes
service_cluster_id string

IdentitySpec

IdentitySpec describes status of rendered secrets.

Note: IdentitySpec is persisted on disk in the STATE partition, so YAML serialization should be kept backwards compatible.

Field Type Label Description
node_id string

InfoSpec

InfoSpec describes cluster information.

Field Type Label Description
cluster_id string
cluster_name string

KubeSpanAffiliateSpec

KubeSpanAffiliateSpec describes additional information specific for the KubeSpan.

Field Type Label Description
public_key string
address common.NetIP
additional_addresses common.NetIPPrefix repeated
endpoints common.NetIPPort repeated

MemberSpec

MemberSpec describes Member state.

Field Type Label Description
node_id string
addresses common.NetIP repeated
hostname string
machine_type talos.resource.definitions.enums.MachineType
operating_system string

Top

resource/definitions/cri/cri.proto

SeccompProfileSpec

SeccompProfileSpec represents the SeccompProfile.

Field Type Label Description
name string
value google.protobuf.Struct

Top

resource/definitions/enums/enums.proto

KubespanPeerState

KubespanPeerState is KubeSpan peer current state.

Name Number Description
PEER_STATE_UNKNOWN 0
PEER_STATE_UP 1
PEER_STATE_DOWN 2

MachineType

MachineType represents a machine type.

Name Number Description
TYPE_UNKNOWN 0 TypeUnknown represents undefined node type, when there is no machine configuration yet.
TYPE_INIT 1 TypeInit type designates the first control plane node to come up. You can think of it like a bootstrap node. This node will perform the initial steps to bootstrap the cluster -- generation of TLS assets, starting of the control plane, etc.
TYPE_CONTROL_PLANE 2 TypeControlPlane designates the node as a control plane member. This means it will host etcd along with the Kubernetes controlplane components such as API Server, Controller Manager, Scheduler.
TYPE_WORKER 3 TypeWorker designates the node as a worker node. This means it will be an available compute node for scheduling workloads.

NethelpersADSelect

NethelpersADSelect is ADSelect.

Name Number Description
AD_SELECT_STABLE 0
AD_SELECT_BANDWIDTH 1
AD_SELECT_COUNT 2

NethelpersARPAllTargets

NethelpersARPAllTargets is an ARP targets mode.

Name Number Description
ARP_ALL_TARGETS_ANY 0
ARP_ALL_TARGETS_ALL 1

NethelpersARPValidate

NethelpersARPValidate is an ARP Validation mode.

Name Number Description
ARP_VALIDATE_NONE 0
ARP_VALIDATE_ACTIVE 1
ARP_VALIDATE_BACKUP 2
ARP_VALIDATE_ALL 3

NethelpersAddressFlag

NethelpersAddressFlag wraps IFF_* constants.

Name Number Description
NETHELPERS_ADDRESSFLAG_UNSPECIFIED 0
ADDRESS_TEMPORARY 1
ADDRESS_NO_DAD 2
ADDRESS_OPTIMISTIC 4
ADDRESS_DAD_FAILED 8
ADDRESS_HOME 16
ADDRESS_DEPRECATED 32
ADDRESS_TENTATIVE 64
ADDRESS_PERMANENT 128
ADDRESS_MANAGEMENT_TEMP 256
ADDRESS_NO_PREFIX_ROUTE 512
ADDRESS_MC_AUTO_JOIN 1024
ADDRESS_STABLE_PRIVACY 2048

NethelpersBondMode

NethelpersBondMode is a bond mode.

Name Number Description
BOND_MODE_ROUNDROBIN 0
BOND_MODE_ACTIVE_BACKUP 1
BOND_MODE_XOR 2
BOND_MODE_BROADCAST 3
BOND_MODE8023_AD 4
BOND_MODE_TLB 5
BOND_MODE_ALB 6

NethelpersBondXmitHashPolicy

NethelpersBondXmitHashPolicy is a bond hash policy.

Name Number Description
BOND_XMIT_POLICY_LAYER2 0
BOND_XMIT_POLICY_LAYER34 1
BOND_XMIT_POLICY_LAYER23 2
BOND_XMIT_POLICY_ENCAP23 3
BOND_XMIT_POLICY_ENCAP34 4

NethelpersDuplex

NethelpersDuplex wraps ethtool.Duplex for YAML marshaling.

Name Number Description
HALF 0
FULL 1
UNKNOWN 255

NethelpersFailOverMAC

NethelpersFailOverMAC is a MAC failover mode.

Name Number Description
FAIL_OVER_MAC_NONE 0
FAIL_OVER_MAC_ACTIVE 1
FAIL_OVER_MAC_FOLLOW 2

NethelpersFamily

NethelpersFamily is a network family.

Name Number Description
NETHELPERS_FAMILY_UNSPECIFIED 0
FAMILY_INET4 2
FAMILY_INET6 10

NethelpersLACPRate

NethelpersLACPRate is a LACP rate.

Name Number Description
LACP_RATE_SLOW 0
LACP_RATE_FAST 1

NethelpersLinkType

NethelpersLinkType is a link type.

Name Number Description
LINK_NETROM 0
LINK_ETHER 1
LINK_EETHER 2
LINK_AX25 3
LINK_PRONET 4
LINK_CHAOS 5
LINK_IEE802 6
LINK_ARCNET 7
LINK_ATALK 8
LINK_DLCI 15
LINK_ATM 19
LINK_METRICOM 23
LINK_IEEE1394 24
LINK_EUI64 27
LINK_INFINIBAND 32
LINK_SLIP 256
LINK_CSLIP 257
LINK_SLIP6 258
LINK_CSLIP6 259
LINK_RSRVD 260
LINK_ADAPT 264
LINK_ROSE 270
LINK_X25 271
LINK_HWX25 272
LINK_CAN 280
LINK_PPP 512
LINK_CISCO 513
LINK_HDLC 513
LINK_LAPB 516
LINK_DDCMP 517
LINK_RAWHDLC 518
LINK_TUNNEL 768
LINK_TUNNEL6 769
LINK_FRAD 770
LINK_SKIP 771
LINK_LOOPBCK 772
LINK_LOCALTLK 773
LINK_FDDI 774
LINK_BIF 775
LINK_SIT 776
LINK_IPDDP 777
LINK_IPGRE 778
LINK_PIMREG 779
LINK_HIPPI 780
LINK_ASH 781
LINK_ECONET 782
LINK_IRDA 783
LINK_FCPP 784
LINK_FCAL 785
LINK_FCPL 786
LINK_FCFABRIC 787
LINK_FCFABRIC1 788
LINK_FCFABRIC2 789
LINK_FCFABRIC3 790
LINK_FCFABRIC4 791
LINK_FCFABRIC5 792
LINK_FCFABRIC6 793
LINK_FCFABRIC7 794
LINK_FCFABRIC8 795
LINK_FCFABRIC9 796
LINK_FCFABRIC10 797
LINK_FCFABRIC11 798
LINK_FCFABRIC12 799
LINK_IEE802TR 800
LINK_IEE80211 801
LINK_IEE80211PRISM 802
LINK_IEE80211_RADIOTAP 803
LINK_IEE8021154 804
LINK_IEE8021154MONITOR 805
LINK_PHONET 820
LINK_PHONETPIPE 821
LINK_CAIF 822
LINK_IP6GRE 823
LINK_NETLINK 824
LINK6_LOWPAN 825
LINK_VOID 65535
LINK_NONE 65534

NethelpersOperationalState

NethelpersOperationalState wraps rtnetlink.OperationalState for YAML marshaling.

Name Number Description
OPER_STATE_UNKNOWN 0
OPER_STATE_NOT_PRESENT 1
OPER_STATE_DOWN 2
OPER_STATE_LOWER_LAYER_DOWN 3
OPER_STATE_TESTING 4
OPER_STATE_DORMANT 5
OPER_STATE_UP 6

NethelpersPort

NethelpersPort wraps ethtool.Port for YAML marshaling.

Name Number Description
TWISTED_PAIR 0
AUI 1
MII 2
FIBRE 3
BNC 4
DIRECT_ATTACH 5
NONE 239
OTHER 255

NethelpersPrimaryReselect

NethelpersPrimaryReselect is an ARP targets mode.

Name Number Description
PRIMARY_RESELECT_ALWAYS 0
PRIMARY_RESELECT_BETTER 1
PRIMARY_RESELECT_FAILURE 2

NethelpersRouteFlag

NethelpersRouteFlag wraps RTM_F_* constants.

Name Number Description
NETHELPERS_ROUTEFLAG_UNSPECIFIED 0
ROUTE_NOTIFY 256
ROUTE_CLONED 512
ROUTE_EQUALIZE 1024
ROUTE_PREFIX 2048
ROUTE_LOOKUP_TABLE 4096
ROUTE_FIB_MATCH 8192
ROUTE_OFFLOAD 16384
ROUTE_TRAP 32768

NethelpersRouteProtocol

NethelpersRouteProtocol is a routing protocol.

Name Number Description
PROTOCOL_UNSPEC 0
PROTOCOL_REDIRECT 1
PROTOCOL_KERNEL 2
PROTOCOL_BOOT 3
PROTOCOL_STATIC 4
PROTOCOL_RA 9
PROTOCOL_MRT 10
PROTOCOL_ZEBRA 11
PROTOCOL_BIRD 12
PROTOCOL_DNROUTED 13
PROTOCOL_XORP 14
PROTOCOL_NTK 15
PROTOCOL_DHCP 16
PROTOCOL_MRTD 17
PROTOCOL_KEEPALIVED 18
PROTOCOL_BABEL 42
PROTOCOL_OPENR 99
PROTOCOL_BGP 186
PROTOCOL_ISIS 187
PROTOCOL_OSPF 188
PROTOCOL_RIP 189
PROTOCOL_EIGRP 192

NethelpersRouteType

NethelpersRouteType is a route type.

Name Number Description
TYPE_UNSPEC 0
TYPE_UNICAST 1
TYPE_LOCAL 2
TYPE_BROADCAST 3
TYPE_ANYCAST 4
TYPE_MULTICAST 5
TYPE_BLACKHOLE 6
TYPE_UNREACHABLE 7
TYPE_PROHIBIT 8
TYPE_THROW 9
TYPE_NAT 10
TYPE_X_RESOLVE 11

NethelpersRoutingTable

NethelpersRoutingTable is a routing table ID.

Name Number Description
TABLE_UNSPEC 0
TABLE_DEFAULT 253
TABLE_MAIN 254
TABLE_LOCAL 255

NethelpersScope

NethelpersScope is an address scope.

Name Number Description
SCOPE_GLOBAL 0
SCOPE_SITE 200
SCOPE_LINK 253
SCOPE_HOST 254
SCOPE_NOWHERE 255

NethelpersVLANProtocol

NethelpersVLANProtocol is a VLAN protocol.

Name Number Description
NETHELPERS_VLANPROTOCOL_UNSPECIFIED 0
VLAN_PROTOCOL8021_Q 33024
VLAN_PROTOCOL8021_AD 34984

NetworkConfigLayer

NetworkConfigLayer describes network configuration layers, with lowest priority first.

Name Number Description
CONFIG_DEFAULT 0
CONFIG_CMDLINE 1
CONFIG_PLATFORM 2
CONFIG_OPERATOR 3
CONFIG_MACHINE_CONFIGURATION 4

NetworkOperator

NetworkOperator enumerates Talos network operators.

Name Number Description
OPERATOR_DHCP4 0
OPERATOR_DHCP6 1
OPERATOR_VIP 2

RuntimeMachineStage

RuntimeMachineStage describes the stage of the machine boot/run process.

Name Number Description
MACHINE_STAGE_UNKNOWN 0
MACHINE_STAGE_BOOTING 1
MACHINE_STAGE_INSTALLING 2
MACHINE_STAGE_MAINTENANCE 3
MACHINE_STAGE_RUNNING 4
MACHINE_STAGE_REBOOTING 5
MACHINE_STAGE_SHUTTING_DOWN 6
MACHINE_STAGE_RESETTING 7
MACHINE_STAGE_UPGRADING 8

Top

resource/definitions/etcd/etcd.proto

ConfigSpec

ConfigSpec describes (some) configuration settings of etcd.

Field Type Label Description
advertise_valid_subnets string repeated
advertise_exclude_subnets string repeated
image string
extra_args ConfigSpec.ExtraArgsEntry repeated
listen_valid_subnets string repeated
listen_exclude_subnets string repeated

ConfigSpec.ExtraArgsEntry

Field Type Label Description
key string
value string

MemberSpec

MemberSpec holds information about an etcd member.

Field Type Label Description
member_id string

PKIStatusSpec

PKIStatusSpec describes status of rendered secrets.

Field Type Label Description
ready bool
version string

SpecSpec

SpecSpec describes (some) Specuration settings of etcd.

Field Type Label Description
name string
advertised_addresses common.NetIP repeated
image string
extra_args SpecSpec.ExtraArgsEntry repeated
listen_peer_addresses common.NetIP repeated
listen_client_addresses common.NetIP repeated

SpecSpec.ExtraArgsEntry

Field Type Label Description
key string
value string

Top

resource/definitions/extensions/extensions.proto

Compatibility

Compatibility describes extension compatibility.

Field Type Label Description
talos Constraint

Constraint

Constraint describes compatibility constraint.

Field Type Label Description
version string

Layer

Layer defines overlay mount layer.

Field Type Label Description
image string
metadata Metadata

Metadata

Metadata describes base extension metadata.

Field Type Label Description
name string
version string
author string
description string
compatibility Compatibility

Top

resource/definitions/files/files.proto

EtcFileSpecSpec

EtcFileSpecSpec describes status of rendered secrets.

Field Type Label Description
contents bytes
mode uint32

EtcFileStatusSpec

EtcFileStatusSpec describes status of rendered secrets.

Field Type Label Description
spec_version string

Top

resource/definitions/hardware/hardware.proto

MemoryModuleSpec

MemoryModuleSpec represents a single Memory.

Field Type Label Description
size uint32
device_locator string
bank_locator string
speed uint32
manufacturer string
serial_number string
asset_tag string
product_name string

ProcessorSpec

ProcessorSpec represents a single processor.

Field Type Label Description
socket string
manufacturer string
product_name string
max_speed uint32
boot_speed uint32
status uint32
serial_number string
asset_tag string
part_number string
core_count uint32
core_enabled uint32
thread_count uint32

SystemInformationSpec

SystemInformationSpec represents the system information obtained from smbios.

Field Type Label Description
manufacturer string
product_name string
version string
serial_number string
uuid string
wake_up_type string
sku_number string

Top

resource/definitions/k8s/k8s.proto

APIServerConfigSpec

APIServerConfigSpec is configuration for kube-apiserver.

Field Type Label Description
image string
cloud_provider string
control_plane_endpoint string
etcd_servers string repeated
local_port int64
service_cid_rs string repeated
extra_args APIServerConfigSpec.ExtraArgsEntry repeated
extra_volumes ExtraVolume repeated
environment_variables APIServerConfigSpec.EnvironmentVariablesEntry repeated
pod_security_policy_enabled bool
advertised_address string

APIServerConfigSpec.EnvironmentVariablesEntry

Field Type Label Description
key string
value string

APIServerConfigSpec.ExtraArgsEntry

Field Type Label Description
key string
value string

AdmissionControlConfigSpec

AdmissionControlConfigSpec is configuration for kube-apiserver.

Field Type Label Description
config AdmissionPluginSpec repeated

AdmissionPluginSpec

AdmissionPluginSpec is a single admission plugin configuration Admission Control plugins.

Field Type Label Description
name string
configuration google.protobuf.Struct

AuditPolicyConfigSpec

AuditPolicyConfigSpec is audit policy configuration for kube-apiserver.

Field Type Label Description
config google.protobuf.Struct

BootstrapManifestsConfigSpec

BootstrapManifestsConfigSpec is configuration for bootstrap manifests.

Field Type Label Description
server string
cluster_domain string
pod_cid_rs string repeated
proxy_enabled bool
proxy_image string
proxy_args string repeated
core_dns_enabled bool
core_dns_image string
dns_service_ip string
dns_service_i_pv6 string
flannel_enabled bool
flannel_image string
flannel_cni_image string
pod_security_policy_enabled bool
talos_api_service_enabled bool

ConfigStatusSpec

ConfigStatusSpec describes status of rendered secrets.

Field Type Label Description
ready bool
version string

ControllerManagerConfigSpec

ControllerManagerConfigSpec is configuration for kube-controller-manager.

Field Type Label Description
enabled bool
image string
cloud_provider string
pod_cid_rs string repeated
service_cid_rs string repeated
extra_args ControllerManagerConfigSpec.ExtraArgsEntry repeated
extra_volumes ExtraVolume repeated
environment_variables ControllerManagerConfigSpec.EnvironmentVariablesEntry repeated

ControllerManagerConfigSpec.EnvironmentVariablesEntry

Field Type Label Description
key string
value string

ControllerManagerConfigSpec.ExtraArgsEntry

Field Type Label Description
key string
value string

EndpointSpec

EndpointSpec describes status of rendered secrets.

Field Type Label Description
addresses common.NetIP repeated

ExtraManifest

ExtraManifest defines a single extra manifest to download.

Field Type Label Description
name string
url string
priority string
extra_headers ExtraManifest.ExtraHeadersEntry repeated
inline_manifest string

ExtraManifest.ExtraHeadersEntry

Field Type Label Description
key string
value string

ExtraManifestsConfigSpec

ExtraManifestsConfigSpec is configuration for extra bootstrap manifests.

Field Type Label Description
extra_manifests ExtraManifest repeated

ExtraVolume

ExtraVolume is a configuration of extra volume.

Field Type Label Description
name string
host_path string
mount_path string
read_only bool

KubeletConfigSpec

KubeletConfigSpec holds the source of kubelet configuration.

Field Type Label Description
image string
cluster_dns string repeated
cluster_domain string
extra_args KubeletConfigSpec.ExtraArgsEntry repeated
extra_mounts talos.resource.definitions.proto.Mount repeated
extra_config google.protobuf.Struct
cloud_provider_external bool
default_runtime_seccomp_enabled bool
skip_node_registration bool
static_pod_list_url string
disable_manifests_directory bool

KubeletConfigSpec.ExtraArgsEntry

Field Type Label Description
key string
value string

KubeletSpecSpec

KubeletSpecSpec holds the source of kubelet configuration.

Field Type Label Description
image string
args string repeated
extra_mounts talos.resource.definitions.proto.Mount repeated
expected_nodename string
config google.protobuf.Struct

ManifestSpec

ManifestSpec holds the Kubernetes resources spec.

Field Type Label Description
items SingleManifest repeated

ManifestStatusSpec

ManifestStatusSpec describes manifest application status.

Field Type Label Description
manifests_applied string repeated

NodeIPConfigSpec

NodeIPConfigSpec holds the Node IP specification.

Field Type Label Description
valid_subnets string repeated
exclude_subnets string repeated

NodeIPSpec

NodeIPSpec holds the Node IP specification.

Field Type Label Description
addresses common.NetIP repeated

NodeLabelSpecSpec

NodeLabelSpecSpec represents a label that's attached to a Talos node.

Field Type Label Description
key string
value string

NodenameSpec

NodenameSpec describes Kubernetes nodename.

Field Type Label Description
nodename string
hostname_version string

SchedulerConfigSpec

SchedulerConfigSpec is configuration for kube-scheduler.

Field Type Label Description
enabled bool
image string
extra_args SchedulerConfigSpec.ExtraArgsEntry repeated
extra_volumes ExtraVolume repeated
environment_variables SchedulerConfigSpec.EnvironmentVariablesEntry repeated

SchedulerConfigSpec.EnvironmentVariablesEntry

Field Type Label Description
key string
value string

SchedulerConfigSpec.ExtraArgsEntry

Field Type Label Description
key string
value string

SecretsStatusSpec

SecretsStatusSpec describes status of rendered secrets.

Field Type Label Description
ready bool
version string

SingleManifest

SingleManifest is a single manifest.

Field Type Label Description
object google.protobuf.Struct

StaticPodServerStatusSpec

StaticPodServerStatusSpec describes static pod spec, it contains marshaled *v1.Pod spec.

Field Type Label Description
url string

StaticPodSpec

StaticPodSpec describes static pod spec, it contains marshaled *v1.Pod spec.

Field Type Label Description
pod google.protobuf.Struct

StaticPodStatusSpec

StaticPodStatusSpec describes kubelet static pod status.

Field Type Label Description
pod_status google.protobuf.Struct

Top

resource/definitions/kubeaccess/kubeaccess.proto

ConfigSpec

ConfigSpec describes KubeSpan configuration..

Field Type Label Description
enabled bool
allowed_api_roles string repeated
allowed_kubernetes_namespaces string repeated

Top

resource/definitions/kubespan/kubespan.proto

ConfigSpec

ConfigSpec describes KubeSpan configuration..

Field Type Label Description
enabled bool
cluster_id string
shared_secret string
force_routing bool
advertise_kubernetes_networks bool
mtu uint32
endpoint_filters string repeated

EndpointSpec

EndpointSpec describes Endpoint state.

Field Type Label Description
affiliate_id string
endpoint common.NetIPPort

IdentitySpec

IdentitySpec describes KubeSpan keys and address.

Note: IdentitySpec is persisted on disk in the STATE partition, so YAML serialization should be kept backwards compatible.

Field Type Label Description
address common.NetIPPrefix
subnet common.NetIPPrefix
private_key string
public_key string

PeerSpecSpec

PeerSpecSpec describes PeerSpec state.

Field Type Label Description
address common.NetIP
allowed_ips common.NetIPPrefix repeated
endpoints common.NetIPPort repeated
label string

PeerStatusSpec

PeerStatusSpec describes PeerStatus state.

Field Type Label Description
endpoint common.NetIPPort
label string
state talos.resource.definitions.enums.KubespanPeerState
receive_bytes int64
transmit_bytes int64
last_handshake_time google.protobuf.Timestamp
last_used_endpoint common.NetIPPort
last_endpoint_change google.protobuf.Timestamp

Top

resource/definitions/network/network.proto

AddressSpecSpec

AddressSpecSpec describes status of rendered secrets.

Field Type Label Description
address common.NetIPPrefix
link_name string
family talos.resource.definitions.enums.NethelpersFamily
scope talos.resource.definitions.enums.NethelpersScope
flags uint32
announce_with_arp bool
config_layer talos.resource.definitions.enums.NetworkConfigLayer

AddressStatusSpec

AddressStatusSpec describes status of rendered secrets.

Field Type Label Description
address common.NetIPPrefix
local common.NetIP
broadcast common.NetIP
anycast common.NetIP
multicast common.NetIP
link_index uint32
link_name string
family talos.resource.definitions.enums.NethelpersFamily
scope talos.resource.definitions.enums.NethelpersScope
flags uint32

BondMasterSpec

BondMasterSpec describes bond settings if Kind == "bond".

Field Type Label Description
mode talos.resource.definitions.enums.NethelpersBondMode
hash_policy talos.resource.definitions.enums.NethelpersBondXmitHashPolicy
lacp_rate talos.resource.definitions.enums.NethelpersLACPRate
arp_validate talos.resource.definitions.enums.NethelpersARPValidate
arp_all_targets talos.resource.definitions.enums.NethelpersARPAllTargets
primary_index uint32
primary_reselect talos.resource.definitions.enums.NethelpersPrimaryReselect
fail_over_mac talos.resource.definitions.enums.NethelpersFailOverMAC
ad_select talos.resource.definitions.enums.NethelpersADSelect
mii_mon uint32
up_delay uint32
down_delay uint32
arp_interval uint32
resend_igmp uint32
min_links uint32
lp_interval uint32
packets_per_slave uint32
num_peer_notif fixed32
tlb_dynamic_lb fixed32
all_slaves_active fixed32
use_carrier bool
ad_actor_sys_prio fixed32
ad_user_port_key fixed32
peer_notify_delay uint32

BondSlave

BondSlave contains a bond's master name and slave index.

Field Type Label Description
master_name string
slave_index int64

BridgeMasterSpec

BridgeMasterSpec describes bridge settings if Kind == "bridge".

Field Type Label Description
stp STPSpec

BridgeSlave

BridgeSlave contains a bond's master name and slave index.

Field Type Label Description
master_name string

DHCP4OperatorSpec

DHCP4OperatorSpec describes DHCP4 operator options.

Field Type Label Description
route_metric uint32
skip_hostname_request bool

DHCP6OperatorSpec

DHCP6OperatorSpec describes DHCP6 operator options.

Field Type Label Description
duid string
route_metric uint32
skip_hostname_request bool

HardwareAddrSpec

HardwareAddrSpec describes spec for the link.

Field Type Label Description
name string
hardware_addr bytes

HostnameSpecSpec

HostnameSpecSpec describes node hostname.

Field Type Label Description
hostname string
domainname string
config_layer talos.resource.definitions.enums.NetworkConfigLayer

HostnameStatusSpec

HostnameStatusSpec describes node hostname.

Field Type Label Description
hostname string
domainname string

LinkRefreshSpec

LinkRefreshSpec describes status of rendered secrets.

Field Type Label Description
generation int64

LinkSpecSpec

LinkSpecSpec describes spec for the link.

Field Type Label Description
name string
logical bool
up bool
mtu uint32
kind string
type talos.resource.definitions.enums.NethelpersLinkType
parent_name string
bond_slave BondSlave
bridge_slave BridgeSlave
vlan VLANSpec
bond_master BondMasterSpec
bridge_master BridgeMasterSpec
wireguard WireguardSpec
config_layer talos.resource.definitions.enums.NetworkConfigLayer

LinkStatusSpec

LinkStatusSpec describes status of rendered secrets.

Field Type Label Description
index uint32
type talos.resource.definitions.enums.NethelpersLinkType
link_index uint32
flags uint32
hardware_addr bytes
broadcast_addr bytes
mtu uint32
queue_disc string
master_index uint32
operational_state talos.resource.definitions.enums.NethelpersOperationalState
kind string
slave_kind string
bus_path string
pciid string
driver string
driver_version string
firmware_version string
product_id string
vendor_id string
product string
vendor string
link_state bool
speed_megabits int64
port talos.resource.definitions.enums.NethelpersPort
duplex talos.resource.definitions.enums.NethelpersDuplex
vlan VLANSpec
bridge_master BridgeMasterSpec
bond_master BondMasterSpec
wireguard WireguardSpec
permanent_addr bytes

NodeAddressFilterSpec

NodeAddressFilterSpec describes a filter for NodeAddresses.

Field Type Label Description
include_subnets common.NetIPPrefix repeated
exclude_subnets common.NetIPPrefix repeated

NodeAddressSpec

NodeAddressSpec describes a set of node addresses.

Field Type Label Description
addresses common.NetIPPrefix repeated

OperatorSpecSpec

OperatorSpecSpec describes DNS resolvers.

Field Type Label Description
operator talos.resource.definitions.enums.NetworkOperator
link_name string
require_up bool
dhcp4 DHCP4OperatorSpec
dhcp6 DHCP6OperatorSpec
vip VIPOperatorSpec
config_layer talos.resource.definitions.enums.NetworkConfigLayer

ProbeSpecSpec

ProbeSpecSpec describes the Probe.

Field Type Label Description
interval google.protobuf.Duration
failure_threshold int64
tcp TCPProbeSpec
config_layer talos.resource.definitions.enums.NetworkConfigLayer

ProbeStatusSpec

ProbeStatusSpec describes the Probe.

Field Type Label Description
success bool
last_error string

ResolverSpecSpec

ResolverSpecSpec describes DNS resolvers.

Field Type Label Description
dns_servers common.NetIP repeated
config_layer talos.resource.definitions.enums.NetworkConfigLayer

ResolverStatusSpec

ResolverStatusSpec describes DNS resolvers.

Field Type Label Description
dns_servers common.NetIP repeated

RouteSpecSpec

RouteSpecSpec describes the route.

Field Type Label Description
family talos.resource.definitions.enums.NethelpersFamily
destination common.NetIPPrefix
source common.NetIP
gateway common.NetIP
out_link_name string
table talos.resource.definitions.enums.NethelpersRoutingTable
priority uint32
scope talos.resource.definitions.enums.NethelpersScope
type talos.resource.definitions.enums.NethelpersRouteType
flags uint32
protocol talos.resource.definitions.enums.NethelpersRouteProtocol
config_layer talos.resource.definitions.enums.NetworkConfigLayer
mtu uint32

RouteStatusSpec

RouteStatusSpec describes status of rendered secrets.

Field Type Label Description
family talos.resource.definitions.enums.NethelpersFamily
destination common.NetIPPrefix
source common.NetIP
gateway common.NetIP
out_link_index uint32
out_link_name string
table talos.resource.definitions.enums.NethelpersRoutingTable
priority uint32
scope talos.resource.definitions.enums.NethelpersScope
type talos.resource.definitions.enums.NethelpersRouteType
flags uint32
protocol talos.resource.definitions.enums.NethelpersRouteProtocol
mtu uint32

STPSpec

STPSpec describes Spanning Tree Protocol (STP) settings of a bridge.

Field Type Label Description
enabled bool

StatusSpec

StatusSpec describes network state.

Field Type Label Description
address_ready bool
connectivity_ready bool
hostname_ready bool
etc_files_ready bool

TCPProbeSpec

TCPProbeSpec describes the TCP Probe.

Field Type Label Description
endpoint string
timeout google.protobuf.Duration

TimeServerSpecSpec

TimeServerSpecSpec describes NTP servers.

Field Type Label Description
ntp_servers string repeated
config_layer talos.resource.definitions.enums.NetworkConfigLayer

TimeServerStatusSpec

TimeServerStatusSpec describes NTP servers.

Field Type Label Description
ntp_servers string repeated

VIPEquinixMetalSpec

VIPEquinixMetalSpec describes virtual (elastic) IP settings for Equinix Metal.

Field Type Label Description
project_id string
device_id string
api_token string

VIPHCloudSpec

VIPHCloudSpec describes virtual (elastic) IP settings for Hetzner Cloud.

Field Type Label Description
device_id int64
network_id int64
api_token string

VIPOperatorSpec

VIPOperatorSpec describes virtual IP operator options.

Field Type Label Description
ip common.NetIP
gratuitous_arp bool
equinix_metal VIPEquinixMetalSpec
h_cloud VIPHCloudSpec

VLANSpec

VLANSpec describes VLAN settings if Kind == "vlan".

Field Type Label Description
vid fixed32
protocol talos.resource.definitions.enums.NethelpersVLANProtocol

WireguardPeer

WireguardPeer describes a single peer.

Field Type Label Description
public_key string
preshared_key string
endpoint string
persistent_keepalive_interval google.protobuf.Duration
allowed_ips common.NetIPPrefix repeated

WireguardSpec

WireguardSpec describes Wireguard settings if Kind == "wireguard".

Field Type Label Description
private_key string
public_key string
listen_port int64
firewall_mark int64
peers WireguardPeer repeated

Top

resource/definitions/perf/perf.proto

CPUSpec

CPUSpec represents the last CPU stats snapshot.

Field Type Label Description
cpu CPUStat repeated
cpu_total CPUStat
irq_total uint64
context_switches uint64
process_created uint64
process_running uint64
process_blocked uint64
soft_irq_total uint64

CPUStat

CPUStat represents a single cpu stat.

Field Type Label Description
user double
nice double
system double
idle double
iowait double
irq double
soft_irq double
steal double
guest double
guest_nice double

MemorySpec

MemorySpec represents the last Memory stats snapshot.

Field Type Label Description
mem_total uint64
mem_used uint64
mem_available uint64
buffers uint64
cached uint64
swap_cached uint64
active uint64
inactive uint64
active_anon uint64
inactive_anon uint64
active_file uint64
inactive_file uint64
unevictable uint64
mlocked uint64
swap_total uint64
swap_free uint64
dirty uint64
writeback uint64
anon_pages uint64
mapped uint64
shmem uint64
slab uint64
s_reclaimable uint64
s_unreclaim uint64
kernel_stack uint64
page_tables uint64
nf_sunstable uint64
bounce uint64
writeback_tmp uint64
commit_limit uint64
committed_as uint64
vmalloc_total uint64
vmalloc_used uint64
vmalloc_chunk uint64
hardware_corrupted uint64
anon_huge_pages uint64
shmem_huge_pages uint64
shmem_pmd_mapped uint64
cma_total uint64
cma_free uint64
huge_pages_total uint64
huge_pages_free uint64
huge_pages_rsvd uint64
huge_pages_surp uint64
hugepagesize uint64
direct_map4k uint64
direct_map2m uint64
direct_map1g uint64

Top

resource/definitions/proto/proto.proto

Mount

Mount specifies a mount for a container.

Field Type Label Description
destination string
type string
source string
options string repeated

Top

resource/definitions/runtime/runtime.proto

KernelModuleSpecSpec

KernelModuleSpecSpec describes Linux kernel module to load.

Field Type Label Description
name string
parameters string repeated

KernelParamSpecSpec

KernelParamSpecSpec describes status of the defined sysctls.

Field Type Label Description
value string
ignore_errors bool

KernelParamStatusSpec

KernelParamStatusSpec describes status of the defined sysctls.

Field Type Label Description
current string
default string
unsupported bool

MachineStatusSpec

MachineStatusSpec describes status of the defined sysctls.

Field Type Label Description
stage talos.resource.definitions.enums.RuntimeMachineStage
status MachineStatusStatus

MachineStatusStatus

MachineStatusStatus describes machine current status at the stage.

Field Type Label Description
ready bool
unmet_conditions UnmetCondition repeated

MetaKeySpec

MetaKeySpec describes status of the defined sysctls.

Field Type Label Description
value string

MountStatusSpec

MountStatusSpec describes status of the defined sysctls.

Field Type Label Description
source string
target string
filesystem_type string
options string repeated

PlatformMetadataSpec

PlatformMetadataSpec describes platform metadata properties.

Field Type Label Description
platform string
hostname string
region string
zone string
instance_type string
instance_id string
provider_id string
spot bool

UnmetCondition

UnmetCondition is a failure which prevents machine from being ready at the stage.

Field Type Label Description
name string
reason string

Top

resource/definitions/secrets/secrets.proto

APICertsSpec

APICertsSpec describes etcd certs secrets.

Field Type Label Description
ca common.PEMEncodedCertificateAndKey
client common.PEMEncodedCertificateAndKey
server common.PEMEncodedCertificateAndKey

CertSANSpec

CertSANSpec describes fields of the cert SANs.

Field Type Label Description
i_ps common.NetIP repeated
dns_names string repeated
fqdn string

EtcdCertsSpec

EtcdCertsSpec describes etcd certs secrets.

Field Type Label Description
etcd common.PEMEncodedCertificateAndKey
etcd_peer common.PEMEncodedCertificateAndKey
etcd_admin common.PEMEncodedCertificateAndKey
etcd_api_server common.PEMEncodedCertificateAndKey

EtcdRootSpec

EtcdRootSpec describes etcd CA secrets.

Field Type Label Description
etcd_ca common.PEMEncodedCertificateAndKey

KubeletSpec

KubeletSpec describes root Kubernetes secrets.

Field Type Label Description
endpoint common.URL
ca common.PEMEncodedCertificateAndKey
bootstrap_token_id string
bootstrap_token_secret string

KubernetesCertsSpec

KubernetesCertsSpec describes generated Kubernetes certificates.

Field Type Label Description
api_server common.PEMEncodedCertificateAndKey
api_server_kubelet_client common.PEMEncodedCertificateAndKey
front_proxy common.PEMEncodedCertificateAndKey
scheduler_kubeconfig string
controller_manager_kubeconfig string
localhost_admin_kubeconfig string
admin_kubeconfig string

KubernetesRootSpec

KubernetesRootSpec describes root Kubernetes secrets.

Field Type Label Description
name string
endpoint common.URL
local_endpoint common.URL
cert_sa_ns string repeated
dns_domain string
ca common.PEMEncodedCertificateAndKey
service_account common.PEMEncodedKey
aggregator_ca common.PEMEncodedCertificateAndKey
aescbc_encryption_secret string
bootstrap_token_id string
bootstrap_token_secret string
secretbox_encryption_secret string
api_server_ips common.NetIP repeated

OSRootSpec

OSRootSpec describes operating system CA.

Field Type Label Description
ca common.PEMEncodedCertificateAndKey
cert_sani_ps common.NetIP repeated
cert_sandns_names string repeated
token string

TrustdCertsSpec

TrustdCertsSpec describes etcd certs secrets.

Field Type Label Description
ca common.PEMEncodedCertificateAndKey
server common.PEMEncodedCertificateAndKey

Top

resource/definitions/time/time.proto

StatusSpec

StatusSpec describes time sync state.

Field Type Label Description
synced bool
epoch int64
sync_disabled bool

Top

resource/definitions/v1alpha1/v1alpha1.proto

ServiceSpec

ServiceSpec describe service state.

Field Type Label Description
running bool
healthy bool
unknown bool

Top

inspect/inspect.proto

ControllerDependencyEdge

Field Type Label Description
controller_name string
edge_type DependencyEdgeType
resource_namespace string
resource_type string
resource_id string

ControllerRuntimeDependenciesResponse

Field Type Label Description
messages ControllerRuntimeDependency repeated

ControllerRuntimeDependency

The ControllerRuntimeDependency message contains the graph of controller-resource dependencies.

Field Type Label Description
metadata common.Metadata
edges ControllerDependencyEdge repeated

DependencyEdgeType

Name Number Description
OUTPUT_EXCLUSIVE 0
OUTPUT_SHARED 3
INPUT_STRONG 1
INPUT_WEAK 2
INPUT_DESTROY_READY 4

InspectService

The inspect service definition.

InspectService provides auxiliary API to inspect OS internals.

Method Name Request Type Response Type Description
ControllerRuntimeDependencies .google.protobuf.Empty ControllerRuntimeDependenciesResponse

Top

machine/machine.proto

AddressEvent

AddressEvent reports node endpoints aggregated from k8s.Endpoints and network.Hostname.

Field Type Label Description
hostname string
addresses string repeated

ApplyConfiguration

ApplyConfigurationResponse describes the response to a configuration request.

Field Type Label Description
metadata common.Metadata
warnings string repeated Configuration validation warnings.
mode ApplyConfigurationRequest.Mode States which mode was actually chosen.
mode_details string Human-readable message explaining the result of the apply configuration call.

ApplyConfigurationRequest

rpc applyConfiguration ApplyConfiguration describes a request to assert a new configuration upon a node.

Field Type Label Description
data bytes
mode ApplyConfigurationRequest.Mode
dry_run bool
try_mode_timeout google.protobuf.Duration

ApplyConfigurationResponse

Field Type Label Description
messages ApplyConfiguration repeated

BPFInstruction

Field Type Label Description
op uint32
jt uint32
jf uint32
k uint32

Bootstrap

The bootstrap message containing the bootstrap status.

Field Type Label Description
metadata common.Metadata

BootstrapRequest

rpc Bootstrap

Field Type Label Description
recover_etcd bool Enable etcd recovery from the snapshot.

Snapshot should be uploaded before this call via EtcdRecover RPC. | | recover_skip_hash_check | bool | | Skip hash check on the snapshot (etcd).

Enable this when recovering from data directory copy to skip integrity check. |

BootstrapResponse

Field Type Label Description
messages Bootstrap repeated

CNIConfig

Field Type Label Description
name string
urls string repeated

CPUInfo

Field Type Label Description
processor uint32
vendor_id string
cpu_family string
model string
model_name string
stepping string
microcode string
cpu_mhz double
cache_size string
physical_id string
siblings uint32
core_id string
cpu_cores uint32
apic_id string
initial_apic_id string
fpu string
fpu_exception string
cpu_id_level uint32
wp string
flags string repeated
bugs string repeated
bogo_mips double
cl_flush_size uint32
cache_alignment uint32
address_sizes string
power_management string

CPUInfoResponse

Field Type Label Description
messages CPUsInfo repeated

CPUStat

Field Type Label Description
user double
nice double
system double
idle double
iowait double
irq double
soft_irq double
steal double
guest double
guest_nice double

CPUsInfo

Field Type Label Description
metadata common.Metadata
cpu_info CPUInfo repeated

ClusterConfig

Field Type Label Description
name string
control_plane ControlPlaneConfig
cluster_network ClusterNetworkConfig
allow_scheduling_on_control_planes bool

ClusterNetworkConfig

Field Type Label Description
dns_domain string
cni_config CNIConfig

ConfigLoadErrorEvent

ConfigLoadErrorEvent is reported when the config loading has failed.

Field Type Label Description
error string

ConfigValidationErrorEvent

ConfigValidationErrorEvent is reported when config validation has failed.

Field Type Label Description
error string

ConnectRecord

Field Type Label Description
l4proto string
localip string
localport uint32
remoteip string
remoteport uint32
state ConnectRecord.State
txqueue uint64
rxqueue uint64
tr ConnectRecord.TimerActive
timerwhen uint64
retrnsmt uint64
uid uint32
timeout uint64
inode uint64
ref uint64
pointer uint64
process ConnectRecord.Process
netns string

ConnectRecord.Process

Field Type Label Description
pid uint32
name string

Container

The messages message containing the requested containers.

Field Type Label Description
metadata common.Metadata
containers ContainerInfo repeated

ContainerInfo

The messages message containing the requested containers.

Field Type Label Description
namespace string
id string
image string
pid uint32
status string
pod_id string
name string
network_namespace string

ContainersRequest

Field Type Label Description
namespace string
driver common.ContainerDriver driver might be default "containerd" or "cri"

ContainersResponse

Field Type Label Description
messages Container repeated

ControlPlaneConfig

Field Type Label Description
endpoint string

CopyRequest

CopyRequest describes a request to copy data out of Talos node

Copy produces .tar.gz archive which is streamed back to the caller

Field Type Label Description
root_path string Root path to start copying data out, it might be either a file or directory

DHCPOptionsConfig

Field Type Label Description
route_metric uint32

DiskStat

Field Type Label Description
name string
read_completed uint64
read_merged uint64
read_sectors uint64
read_time_ms uint64
write_completed uint64
write_merged uint64
write_sectors uint64
write_time_ms uint64
io_in_progress uint64
io_time_ms uint64
io_time_weighted_ms uint64
discard_completed uint64
discard_merged uint64
discard_sectors uint64
discard_time_ms uint64

DiskStats

Field Type Label Description
metadata common.Metadata
total DiskStat
devices DiskStat repeated

DiskStatsResponse

Field Type Label Description
messages DiskStats repeated

DiskUsageInfo

DiskUsageInfo describes a file or directory's information for du command

Field Type Label Description
metadata common.Metadata
name string Name is the name (including prefixed path) of the file or directory
size int64 Size indicates the number of bytes contained within the file
error string Error describes any error encountered while trying to read the file information.
relative_name string RelativeName is the name of the file or directory relative to the RootPath

DiskUsageRequest

DiskUsageRequest describes a request to list disk usage of directories and regular files

Field Type Label Description
recursion_depth int32 RecursionDepth indicates how many levels of subdirectories should be recursed. The default (0) indicates that no limit should be enforced.
all bool All write sizes for all files, not just directories.
threshold int64 Threshold exclude entries smaller than SIZE if positive, or entries greater than SIZE if negative.
paths string repeated DiskUsagePaths is the list of directories to calculate disk usage for.

DmesgRequest

dmesg

Field Type Label Description
follow bool
tail bool

EtcdAlarm

Field Type Label Description
metadata common.Metadata
member_alarms EtcdMemberAlarm repeated

EtcdAlarmDisarm

Field Type Label Description
metadata common.Metadata
member_alarms EtcdMemberAlarm repeated

EtcdAlarmDisarmResponse

Field Type Label Description
messages EtcdAlarmDisarm repeated

EtcdAlarmListResponse

Field Type Label Description
messages EtcdAlarm repeated

EtcdDefragment

Field Type Label Description
metadata common.Metadata

EtcdDefragmentResponse

Field Type Label Description
messages EtcdDefragment repeated

EtcdForfeitLeadership

Field Type Label Description
metadata common.Metadata
member string

EtcdForfeitLeadershipRequest

EtcdForfeitLeadershipResponse

Field Type Label Description
messages EtcdForfeitLeadership repeated

EtcdLeaveCluster

Field Type Label Description
metadata common.Metadata

EtcdLeaveClusterRequest

EtcdLeaveClusterResponse

Field Type Label Description
messages EtcdLeaveCluster repeated

EtcdMember

EtcdMember describes a single etcd member.

Field Type Label Description
id uint64 member ID.
hostname string human-readable name of the member.
peer_urls string repeated the list of URLs the member exposes to clients for communication.
client_urls string repeated the list of URLs the member exposes to the cluster for communication.
is_learner bool learner flag

EtcdMemberAlarm

Field Type Label Description
member_id uint64
alarm EtcdMemberAlarm.AlarmType

EtcdMemberListRequest

Field Type Label Description
query_local bool

EtcdMemberListResponse

Field Type Label Description
messages EtcdMembers repeated

EtcdMemberStatus

Field Type Label Description
member_id uint64
protocol_version string
db_size int64
db_size_in_use int64
leader uint64
raft_index uint64
raft_term uint64
raft_applied_index uint64
errors string repeated
is_learner bool

EtcdMembers

EtcdMembers contains the list of members registered on the host.

Field Type Label Description
metadata common.Metadata
legacy_members string repeated list of member hostnames.
members EtcdMember repeated the list of etcd members registered on the node.

EtcdRecover

Field Type Label Description
metadata common.Metadata

EtcdRecoverResponse

Field Type Label Description
messages EtcdRecover repeated

EtcdRemoveMember

Field Type Label Description
metadata common.Metadata

EtcdRemoveMemberByID

Field Type Label Description
metadata common.Metadata

EtcdRemoveMemberByIDRequest

Field Type Label Description
member_id uint64

EtcdRemoveMemberByIDResponse

Field Type Label Description
messages EtcdRemoveMemberByID repeated

EtcdRemoveMemberRequest

Field Type Label Description
member string

EtcdRemoveMemberResponse

Field Type Label Description
messages EtcdRemoveMember repeated

EtcdSnapshotRequest

EtcdStatus

Field Type Label Description
metadata common.Metadata
member_status EtcdMemberStatus

EtcdStatusResponse

Field Type Label Description
messages EtcdStatus repeated

Event

Field Type Label Description
metadata common.Metadata
data google.protobuf.Any
id string
actor_id string

EventsRequest

Field Type Label Description
tail_events int32
tail_id string
tail_seconds int32
with_actor_id string

FeaturesInfo

FeaturesInfo describes individual Talos features that can be switched on or off.

Field Type Label Description
rbac bool RBAC is true if role-based access control is enabled.

FileInfo

FileInfo describes a file or directory's information

Field Type Label Description
metadata common.Metadata
name string Name is the name (including prefixed path) of the file or directory
size int64 Size indicates the number of bytes contained within the file
mode uint32 Mode is the bitmap of UNIX mode/permission flags of the file
modified int64 Modified indicates the UNIX timestamp at which the file was last modified
is_dir bool IsDir indicates that the file is a directory
error string Error describes any error encountered while trying to read the file information.
link string Link is filled with symlink target
relative_name string RelativeName is the name of the file or directory relative to the RootPath
uid uint32 Owner uid
gid uint32 Owner gid

GenerateClientConfiguration

Field Type Label Description
metadata common.Metadata
ca bytes PEM-encoded CA certificate.
crt bytes PEM-encoded generated client certificate.
key bytes PEM-encoded generated client key.
talosconfig bytes Client configuration (talosconfig) file content.

GenerateClientConfigurationRequest

Field Type Label Description
roles string repeated Roles in the generated client certificate.
crt_ttl google.protobuf.Duration Client certificate TTL.

GenerateClientConfigurationResponse

Field Type Label Description
messages GenerateClientConfiguration repeated

GenerateConfiguration

GenerateConfiguration describes the response to a generate configuration request.

Field Type Label Description
metadata common.Metadata
data bytes repeated
talosconfig bytes

GenerateConfigurationRequest

GenerateConfigurationRequest describes a request to generate a new configuration on a node.

Field Type Label Description
config_version string
cluster_config ClusterConfig
machine_config MachineConfig
override_time google.protobuf.Timestamp

GenerateConfigurationResponse

Field Type Label Description
messages GenerateConfiguration repeated

Hostname

Field Type Label Description
metadata common.Metadata
hostname string

HostnameResponse

Field Type Label Description
messages Hostname repeated

InstallConfig

Field Type Label Description
install_disk string
install_image string

ListRequest

ListRequest describes a request to list the contents of a directory.

Field Type Label Description
root string Root indicates the root directory for the list. If not indicated, '/' is presumed.
recurse bool Recurse indicates that subdirectories should be recursed.
recursion_depth int32 RecursionDepth indicates how many levels of subdirectories should be recursed. The default (0) indicates that no limit should be enforced.
types ListRequest.Type repeated Types indicates what file type should be returned. If not indicated, all files will be returned.

LoadAvg

Field Type Label Description
metadata common.Metadata
load1 double
load5 double
load15 double

LoadAvgResponse

Field Type Label Description
messages LoadAvg repeated

LogsRequest

rpc logs The request message containing the process name.

Field Type Label Description
namespace string
id string
driver common.ContainerDriver driver might be default "containerd" or "cri"
follow bool
tail_lines int32

MachineConfig

Field Type Label Description
type MachineConfig.MachineType
install_config InstallConfig
network_config NetworkConfig
kubernetes_version string

MachineStatusEvent

MachineStatusEvent reports changes to the MachineStatus resource.

Field Type Label Description
stage MachineStatusEvent.MachineStage
status MachineStatusEvent.MachineStatus

MachineStatusEvent.MachineStatus

Field Type Label Description
ready bool
unmet_conditions MachineStatusEvent.MachineStatus.UnmetCondition repeated

MachineStatusEvent.MachineStatus.UnmetCondition

Field Type Label Description
name string
reason string

MemInfo

Field Type Label Description
memtotal uint64
memfree uint64
memavailable uint64
buffers uint64
cached uint64
swapcached uint64
active uint64
inactive uint64
activeanon uint64
inactiveanon uint64
activefile uint64
inactivefile uint64
unevictable uint64
mlocked uint64
swaptotal uint64
swapfree uint64
dirty uint64
writeback uint64
anonpages uint64
mapped uint64
shmem uint64
slab uint64
sreclaimable uint64
sunreclaim uint64
kernelstack uint64
pagetables uint64
nfsunstable uint64
bounce uint64
writebacktmp uint64
commitlimit uint64
committedas uint64
vmalloctotal uint64
vmallocused uint64
vmallocchunk uint64
hardwarecorrupted uint64
anonhugepages uint64
shmemhugepages uint64
shmempmdmapped uint64
cmatotal uint64
cmafree uint64
hugepagestotal uint64
hugepagesfree uint64
hugepagesrsvd uint64
hugepagessurp uint64
hugepagesize uint64
directmap4k uint64
directmap2m uint64
directmap1g uint64

Memory

Field Type Label Description
metadata common.Metadata
meminfo MemInfo

MemoryResponse

Field Type Label Description
messages Memory repeated

MetaDelete

Field Type Label Description
metadata common.Metadata

MetaDeleteRequest

Field Type Label Description
key uint32

MetaDeleteResponse

Field Type Label Description
messages MetaDelete repeated

MetaWrite

Field Type Label Description
metadata common.Metadata

MetaWriteRequest

Field Type Label Description
key uint32
value bytes

MetaWriteResponse

Field Type Label Description
messages MetaWrite repeated

MountStat

The messages message containing the requested processes.

Field Type Label Description
filesystem string
size uint64
available uint64
mounted_on string

Mounts

The messages message containing the requested df stats.

Field Type Label Description
metadata common.Metadata
stats MountStat repeated

MountsResponse

Field Type Label Description
messages Mounts repeated

NetDev

Field Type Label Description
name string
rx_bytes uint64
rx_packets uint64
rx_errors uint64
rx_dropped uint64
rx_fifo uint64
rx_frame uint64
rx_compressed uint64
rx_multicast uint64
tx_bytes uint64
tx_packets uint64
tx_errors uint64
tx_dropped uint64
tx_fifo uint64
tx_collisions uint64
tx_carrier uint64
tx_compressed uint64

Netstat

Field Type Label Description
metadata common.Metadata
connectrecord ConnectRecord repeated

NetstatRequest

Field Type Label Description
filter NetstatRequest.Filter
feature NetstatRequest.Feature
l4proto NetstatRequest.L4proto
netns NetstatRequest.NetNS

NetstatRequest.Feature

Field Type Label Description
pid bool

NetstatRequest.L4proto

Field Type Label Description
tcp bool
tcp6 bool
udp bool
udp6 bool
udplite bool
udplite6 bool
raw bool
raw6 bool

NetstatRequest.NetNS

Field Type Label Description
hostnetwork bool
netns string repeated
allnetns bool

NetstatResponse

Field Type Label Description
messages Netstat repeated

NetworkConfig

Field Type Label Description
hostname string
interfaces NetworkDeviceConfig repeated

NetworkDeviceConfig

Field Type Label Description
interface string
cidr string
mtu int32
dhcp bool
ignore bool
dhcp_options DHCPOptionsConfig
routes RouteConfig repeated

NetworkDeviceStats

Field Type Label Description
metadata common.Metadata
total NetDev
devices NetDev repeated

NetworkDeviceStatsResponse

Field Type Label Description
messages NetworkDeviceStats repeated

PacketCaptureRequest

Field Type Label Description
interface string Interface name to perform packet capture on.
promiscuous bool Enable promiscuous mode.
snap_len uint32 Snap length in bytes.
bpf_filter BPFInstruction repeated BPF filter.

PhaseEvent

Field Type Label Description
phase string
action PhaseEvent.Action

PlatformInfo

Field Type Label Description
name string
mode string

Process

Field Type Label Description
metadata common.Metadata
processes ProcessInfo repeated

ProcessInfo

Field Type Label Description
pid int32
ppid int32
state string
threads int32
cpu_time double
virtual_memory uint64
resident_memory uint64
command string
executable string
args string

ProcessesResponse

rpc processes

Field Type Label Description
messages Process repeated

ReadRequest

Field Type Label Description
path string

Reboot

The reboot message containing the reboot status.

Field Type Label Description
metadata common.Metadata
actor_id string

RebootRequest

rpc reboot

Field Type Label Description
mode RebootRequest.Mode

RebootResponse

Field Type Label Description
messages Reboot repeated

Reset

The reset message containing the restart status.

Field Type Label Description
metadata common.Metadata
actor_id string

ResetPartitionSpec

rpc reset

Field Type Label Description
label string
wipe bool

ResetRequest

Field Type Label Description
graceful bool Graceful indicates whether node should leave etcd before the upgrade, it also enforces etcd checks before leaving.
reboot bool Reboot indicates whether node should reboot or halt after resetting.
system_partitions_to_wipe ResetPartitionSpec repeated System_partitions_to_wipe lists specific system disk partitions to be reset (wiped). If system_partitions_to_wipe is empty, all the partitions are erased.
user_disks_to_wipe string repeated UserDisksToWipe lists specific connected block devices to be reset (wiped).
mode ResetRequest.WipeMode WipeMode defines which devices should be wiped.

ResetResponse

Field Type Label Description
messages Reset repeated

Restart

Field Type Label Description
metadata common.Metadata

RestartEvent

Field Type Label Description
cmd int64

RestartRequest

rpc restart The request message containing the process to restart.

Field Type Label Description
namespace string
id string
driver common.ContainerDriver driver might be default "containerd" or "cri"

RestartResponse

The messages message containing the restart status.

Field Type Label Description
messages Restart repeated

Rollback

Field Type Label Description
metadata common.Metadata

RollbackRequest

rpc rollback

RollbackResponse

Field Type Label Description
messages Rollback repeated

RouteConfig

Field Type Label Description
network string
gateway string
metric uint32

SequenceEvent

rpc events

Field Type Label Description
sequence string
action SequenceEvent.Action
error common.Error

ServiceEvent

Field Type Label Description
msg string
state string
ts google.protobuf.Timestamp

ServiceEvents

Field Type Label Description
events ServiceEvent repeated

ServiceHealth

Field Type Label Description
unknown bool
healthy bool
last_message string
last_change google.protobuf.Timestamp

ServiceInfo

Field Type Label Description
id string
state string
events ServiceEvents
health ServiceHealth

ServiceList

rpc servicelist

Field Type Label Description
metadata common.Metadata
services ServiceInfo repeated

ServiceListResponse

Field Type Label Description
messages ServiceList repeated

ServiceRestart

Field Type Label Description
metadata common.Metadata
resp string

ServiceRestartRequest

Field Type Label Description
id string

ServiceRestartResponse

Field Type Label Description
messages ServiceRestart repeated

ServiceStart

Field Type Label Description
metadata common.Metadata
resp string

ServiceStartRequest

rpc servicestart

Field Type Label Description
id string

ServiceStartResponse

Field Type Label Description
messages ServiceStart repeated

ServiceStateEvent

Field Type Label Description
service string
action ServiceStateEvent.Action
message string
health ServiceHealth

ServiceStop

Field Type Label Description
metadata common.Metadata
resp string

ServiceStopRequest

Field Type Label Description
id string

ServiceStopResponse

Field Type Label Description
messages ServiceStop repeated

Shutdown

rpc shutdown The messages message containing the shutdown status.

Field Type Label Description
metadata common.Metadata
actor_id string

ShutdownRequest

Field Type Label Description
force bool Force indicates whether node should shutdown without first cordening and draining

ShutdownResponse

Field Type Label Description
messages Shutdown repeated

SoftIRQStat

Field Type Label Description
hi uint64
timer uint64
net_tx uint64
net_rx uint64
block uint64
block_io_poll uint64
tasklet uint64
sched uint64
hrtimer uint64
rcu uint64

Stat

The messages message containing the requested stat.

Field Type Label Description
namespace string
id string
memory_usage uint64
cpu_usage uint64
pod_id string
name string

Stats

The messages message containing the requested stats.

Field Type Label Description
metadata common.Metadata
stats Stat repeated

StatsRequest

The request message containing the containerd namespace.

Field Type Label Description
namespace string
driver common.ContainerDriver driver might be default "containerd" or "cri"

StatsResponse

Field Type Label Description
messages Stats repeated

SystemStat

Field Type Label Description
metadata common.Metadata
boot_time uint64
cpu_total CPUStat
cpu CPUStat repeated
irq_total uint64
irq uint64 repeated
context_switches uint64
process_created uint64
process_running uint64
process_blocked uint64
soft_irq_total uint64
soft_irq SoftIRQStat

SystemStatResponse

Field Type Label Description
messages SystemStat repeated

TaskEvent

Field Type Label Description
task string
action TaskEvent.Action

Upgrade

Field Type Label Description
metadata common.Metadata
ack string
actor_id string

UpgradeRequest

rpc upgrade

Field Type Label Description
image string
preserve bool
stage bool
force bool

UpgradeResponse

Field Type Label Description
messages Upgrade repeated

Version

Field Type Label Description
metadata common.Metadata
version VersionInfo
platform PlatformInfo
features FeaturesInfo Features describe individual Talos features that can be switched on or off.

VersionInfo

Field Type Label Description
tag string
sha string
built string
go_version string
os string
arch string

VersionResponse

Field Type Label Description
messages Version repeated

ApplyConfigurationRequest.Mode

Name Number Description
REBOOT 0
AUTO 1
NO_REBOOT 2
STAGED 3
TRY 4

ConnectRecord.State

Name Number Description
RESERVED 0
ESTABLISHED 1
SYN_SENT 2
SYN_RECV 3
FIN_WAIT1 4
FIN_WAIT2 5
TIME_WAIT 6
CLOSE 7
CLOSEWAIT 8
LASTACK 9
LISTEN 10
CLOSING 11

ConnectRecord.TimerActive

Name Number Description
OFF 0
ON 1
KEEPALIVE 2
TIMEWAIT 3
PROBE 4

EtcdMemberAlarm.AlarmType

Name Number Description
NONE 0
NOSPACE 1
CORRUPT 2

ListRequest.Type

File type.

Name Number Description
REGULAR 0 Regular file (not directory, symlink, etc).
DIRECTORY 1 Directory.
SYMLINK 2 Symbolic link.

MachineConfig.MachineType

Name Number Description
TYPE_UNKNOWN 0
TYPE_INIT 1
TYPE_CONTROL_PLANE 2
TYPE_WORKER 3

MachineStatusEvent.MachineStage

Name Number Description
UNKNOWN 0
BOOTING 1
INSTALLING 2
MAINTENANCE 3
RUNNING 4
REBOOTING 5
SHUTTING_DOWN 6
RESETTING 7
UPGRADING 8

NetstatRequest.Filter

Name Number Description
ALL 0
CONNECTED 1
LISTENING 2

PhaseEvent.Action

Name Number Description
START 0
STOP 1

RebootRequest.Mode

Name Number Description
DEFAULT 0
POWERCYCLE 1

ResetRequest.WipeMode

Name Number Description
ALL 0
SYSTEM_DISK 1
USER_DISKS 2

SequenceEvent.Action

Name Number Description
NOOP 0
START 1
STOP 2

ServiceStateEvent.Action

Name Number Description
INITIALIZED 0
PREPARING 1
WAITING 2
RUNNING 3
STOPPING 4
FINISHED 5
FAILED 6
SKIPPED 7

TaskEvent.Action

Name Number Description
START 0
STOP 1

MachineService

The machine service definition.

Method Name Request Type Response Type Description
ApplyConfiguration ApplyConfigurationRequest ApplyConfigurationResponse
Bootstrap BootstrapRequest BootstrapResponse Bootstrap method makes control plane node enter etcd bootstrap mode.

Node aborts etcd join sequence and creates single-node etcd cluster.

If recover_etcd argument is specified, etcd is recovered from a snapshot uploaded with EtcdRecover. | | Containers | ContainersRequest | ContainersResponse | | | Copy | CopyRequest | .common.Data stream | | | CPUInfo | .google.protobuf.Empty | CPUInfoResponse | | | DiskStats | .google.protobuf.Empty | DiskStatsResponse | | | Dmesg | DmesgRequest | .common.Data stream | | | Events | EventsRequest | Event stream | | | EtcdMemberList | EtcdMemberListRequest | EtcdMemberListResponse | | | EtcdRemoveMember | EtcdRemoveMemberRequest | EtcdRemoveMemberResponse | EtcdRemoveMember removes a member from the etcd cluster by hostname.

Please use EtcdRemoveMemberByID instead. | | EtcdRemoveMemberByID | EtcdRemoveMemberByIDRequest | EtcdRemoveMemberByIDResponse | EtcdRemoveMemberByID removes a member from the etcd cluster identified by member ID.

This API should be used to remove members which don't have an associated Talos node anymore. To remove a member with a running Talos node, use EtcdLeaveCluster API on the node to be removed. | | EtcdLeaveCluster | EtcdLeaveClusterRequest | EtcdLeaveClusterResponse | | | EtcdForfeitLeadership | EtcdForfeitLeadershipRequest | EtcdForfeitLeadershipResponse | | | EtcdRecover | .common.Data stream | EtcdRecoverResponse | EtcdRecover method uploads etcd data snapshot created with EtcdSnapshot to the node.

Snapshot can be later used to recover the cluster via Bootstrap method. | | EtcdSnapshot | EtcdSnapshotRequest | .common.Data stream | EtcdSnapshot method creates etcd data snapshot (backup) from the local etcd instance and streams it back to the client.

This method is available only on control plane nodes (which run etcd). | | EtcdAlarmList | .google.protobuf.Empty | EtcdAlarmListResponse | EtcdAlarmList lists etcd alarms for the current node.

This method is available only on control plane nodes (which run etcd). | | EtcdAlarmDisarm | .google.protobuf.Empty | EtcdAlarmDisarmResponse | EtcdAlarmDisarm disarms etcd alarms for the current node.

This method is available only on control plane nodes (which run etcd). | | EtcdDefragment | .google.protobuf.Empty | EtcdDefragmentResponse | EtcdDefragment defragments etcd data directory for the current node.

Defragmentation is a resource-heavy operation, so it should only run on a specific node.

This method is available only on control plane nodes (which run etcd). | | EtcdStatus | .google.protobuf.Empty | EtcdStatusResponse | EtcdStatus returns etcd status for the current member.

This method is available only on control plane nodes (which run etcd). | | GenerateConfiguration | GenerateConfigurationRequest | GenerateConfigurationResponse | | | Hostname | .google.protobuf.Empty | HostnameResponse | | | Kubeconfig | .google.protobuf.Empty | .common.Data stream | | | List | ListRequest | FileInfo stream | | | DiskUsage | DiskUsageRequest | DiskUsageInfo stream | | | LoadAvg | .google.protobuf.Empty | LoadAvgResponse | | | Logs | LogsRequest | .common.Data stream | | | Memory | .google.protobuf.Empty | MemoryResponse | | | Mounts | .google.protobuf.Empty | MountsResponse | | | NetworkDeviceStats | .google.protobuf.Empty | NetworkDeviceStatsResponse | | | Processes | .google.protobuf.Empty | ProcessesResponse | | | Read | ReadRequest | .common.Data stream | | | Reboot | RebootRequest | RebootResponse | | | Restart | RestartRequest | RestartResponse | | | Rollback | RollbackRequest | RollbackResponse | | | Reset | ResetRequest | ResetResponse | | | ServiceList | .google.protobuf.Empty | ServiceListResponse | | | ServiceRestart | ServiceRestartRequest | ServiceRestartResponse | | | ServiceStart | ServiceStartRequest | ServiceStartResponse | | | ServiceStop | ServiceStopRequest | ServiceStopResponse | | | Shutdown | ShutdownRequest | ShutdownResponse | | | Stats | StatsRequest | StatsResponse | | | SystemStat | .google.protobuf.Empty | SystemStatResponse | | | Upgrade | UpgradeRequest | UpgradeResponse | | | Version | .google.protobuf.Empty | VersionResponse | | | GenerateClientConfiguration | GenerateClientConfigurationRequest | GenerateClientConfigurationResponse | GenerateClientConfiguration generates talosctl client configuration (talosconfig). | | PacketCapture | PacketCaptureRequest | .common.Data stream | PacketCapture performs packet capture and streams back pcap file. | | Netstat | NetstatRequest | NetstatResponse | Netstat provides information about network connections. | | MetaWrite | MetaWriteRequest | MetaWriteResponse | MetaWrite writes a META key-value pair. | | MetaDelete | MetaDeleteRequest | MetaDeleteResponse | MetaDelete deletes a META key. |

Top

resource/resource.proto

Get

The GetResponse message contains the Resource returned.

Field Type Label Description
metadata common.Metadata
definition Resource
resource Resource

GetRequest

rpc Get

Field Type Label Description
namespace string
type string
id string

GetResponse

Field Type Label Description
messages Get repeated

ListRequest

rpc List The ListResponse message contains the Resource returned.

Field Type Label Description
namespace string
type string

ListResponse

Field Type Label Description
metadata common.Metadata
definition Resource
resource Resource

Metadata

Field Type Label Description
namespace string
type string
id string
version string
owner string
phase string
created google.protobuf.Timestamp
updated google.protobuf.Timestamp
finalizers string repeated
labels Metadata.LabelsEntry repeated
annotations Metadata.AnnotationsEntry repeated

Metadata.AnnotationsEntry

Field Type Label Description
key string
value string

Metadata.LabelsEntry

Field Type Label Description
key string
value string

Resource

Field Type Label Description
metadata Metadata
spec Spec

Spec

Field Type Label Description
yaml bytes

WatchRequest

rpc Watch The WatchResponse message contains the Resource returned.

Field Type Label Description
namespace string
type string
id string
tail_events uint32

WatchResponse

Field Type Label Description
metadata common.Metadata
event_type EventType
definition Resource
resource Resource

EventType

Name Number Description
CREATED 0
UPDATED 1
DESTROYED 2

ResourceService

The resource service definition.

ResourceService provides user-facing API for the Talos resources.

Method Name Request Type Response Type Description
Get GetRequest GetResponse
List ListRequest ListResponse stream
Watch WatchRequest WatchResponse stream

Top

security/security.proto

CertificateRequest

The request message containing the certificate signing request.

Field Type Label Description
csr bytes Certificate Signing Request in PEM format.

CertificateResponse

The response message containing signed certificate.

Field Type Label Description
ca bytes Certificate of the CA that signed the requested certificate in PEM format.
crt bytes Signed X.509 requested certificate in PEM format.

SecurityService

The security service definition.

Method Name Request Type Response Type Description
Certificate CertificateRequest CertificateResponse

Top

storage/storage.proto

Disk

Disk represents a disk.

Field Type Label Description
size uint64 Size indicates the disk size in bytes.
model string Model idicates the disk model.
device_name string DeviceName indicates the disk name (e.g. sda).
name string Name as in /sys/block/<dev>/device/name.
serial string Serial as in /sys/block/<dev>/device/serial.
modalias string Modalias as in /sys/block/<dev>/device/modalias.
uuid string Uuid as in /sys/block/<dev>/device/uuid.
wwid string Wwid as in /sys/block/<dev>/device/wwid.
type Disk.DiskType Type is a type of the disk: nvme, ssd, hdd, sd card.
bus_path string BusPath is the bus path of the disk.
system_disk bool SystemDisk indicates that the disk is used as Talos system disk.

Disks

DisksResponse represents the response of the Disks RPC.

Field Type Label Description
metadata common.Metadata
disks Disk repeated

DisksResponse

Field Type Label Description
messages Disks repeated

Disk.DiskType

Name Number Description
UNKNOWN 0
SSD 1
HDD 2
NVME 3
SD 4

StorageService

StorageService represents the storage service.

Method Name Request Type Response Type Description
Disks .google.protobuf.Empty DisksResponse

Top

time/time.proto

Time

Field Type Label Description
metadata common.Metadata
server string
localtime google.protobuf.Timestamp
remotetime google.protobuf.Timestamp

TimeRequest

The response message containing the ntp server

Field Type Label Description
server string

TimeResponse

The response message containing the ntp server, time, and offset

Field Type Label Description
messages Time repeated

TimeService

The time service definition.

Method Name Request Type Response Type Description
Time .google.protobuf.Empty TimeResponse
TimeCheck TimeRequest TimeResponse

Scalar Value Types

.proto Type Notes C++ Java Python Go C# PHP Ruby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)