website/content/v1.14/reference/api.md
resource/definitions/enums/enums.proto
resource/definitions/block/block.proto
resource/definitions/cri/cri.proto
resource/definitions/k8s/k8s.proto
resource/definitions/runtime/runtime.proto
resource/definitions/network/network.proto
<a name="common/common.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="common.ContainerdInstance"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| driver | ContainerDriver | Containerd instance to use. | |
| namespace | ContainerdNamespace | Containerd namespace to use. |
<a name="common.Data"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | Metadata | ||
| bytes | bytes |
<a name="common.DataResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | Data | repeated |
<a name="common.Empty"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | Metadata |
<a name="common.EmptyResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | Empty | repeated |
<a name="common.Error"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| code | Code | ||
| message | string | ||
| details | google.protobuf.Any | repeated |
<a name="common.NetIP"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| ip | bytes |
<a name="common.NetIPPort"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| ip | bytes | ||
| port | int32 |
<a name="common.NetIPPrefix"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| ip | bytes | ||
| prefix_length | int32 |
<a name="common.PEMEncodedCertificate"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| crt | bytes |
<a name="common.PEMEncodedCertificateAndKey"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| crt | bytes | ||
| key | bytes |
<a name="common.PEMEncodedKey"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| key | bytes |
<a name="common.URL"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| full_path | string |
<a name="common.Code"></a>
| Name | Number | Description |
|---|---|---|
| FATAL | 0 | |
| LOCKED | 1 | |
| CANCELED | 2 |
<a name="common.ContainerDriver"></a>
| Name | Number | Description |
|---|---|---|
| CONTAINERD | 0 | |
| CRI | 1 |
<a name="common.ContainerdNamespace"></a>
| Name | Number | Description |
|---|---|---|
| NS_UNKNOWN | 0 | |
| NS_SYSTEM | 1 | |
| NS_CRI | 2 | |
| NS_TALOSCONTAINERS | 3 | NS_TALOSCONTAINERS is the namespace for containers declared via a ContainerConfig document. |
<a name="common/common.proto-extensions"></a>
| 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. |
<a name="cluster/cluster.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="cluster.ClusterInfo"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| control_plane_nodes | string | repeated | |
| worker_nodes | string | repeated | |
| force_endpoint | string |
<a name="cluster.HealthCheckProgress"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| message | string |
<a name="cluster.HealthCheckRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| wait_timeout | google.protobuf.Duration | ||
| cluster_info | ClusterInfo |
<a name="cluster.ClusterService"></a>
The cluster service definition.
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| HealthCheck | HealthCheckRequest | HealthCheckProgress stream |
<a name="inspect/inspect.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="inspect.ControllerDependencyEdge"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| controller_name | string | ||
| edge_type | DependencyEdgeType | ||
| resource_namespace | string | ||
| resource_type | string | ||
| resource_id | string |
<a name="inspect.ControllerRuntimeDependenciesResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | ControllerRuntimeDependency | repeated |
<a name="inspect.ControllerRuntimeDependency"></a>
The ControllerRuntimeDependency message contains the graph of controller-resource dependencies.
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| edges | ControllerDependencyEdge | repeated |
<a name="inspect.DependencyEdgeType"></a>
| Name | Number | Description |
|---|---|---|
| OUTPUT_EXCLUSIVE | 0 | |
| OUTPUT_SHARED | 3 | |
| INPUT_STRONG | 1 | |
| INPUT_WEAK | 2 | |
| INPUT_DESTROY_READY | 4 |
<a name="inspect.InspectService"></a>
The inspect service definition.
InspectService provides auxiliary API to inspect OS internals.
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| ControllerRuntimeDependencies | .google.protobuf.Empty | ControllerRuntimeDependenciesResponse |
<a name="machine/debug.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="machine.DebugContainerRunRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| spec | DebugContainerRunRequestSpec | 1. send the container spec | |
| stdin_data | bytes | 2. send either of the three below to interact with the running container | |
| signal | int32 | ||
| term_resize | DebugContainerTerminalResize |
<a name="machine.DebugContainerRunRequestSpec"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| containerd | common.ContainerdInstance | ||
| image_name | string | ||
| args | string | repeated | |
| env | DebugContainerRunRequestSpec.EnvEntry | repeated | |
| profile | DebugContainerRunRequestSpec.Profile | ||
| tty | bool |
<a name="machine.DebugContainerRunRequestSpec.EnvEntry"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | string |
<a name="machine.DebugContainerRunResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| stdout_data | bytes | ||
| exit_code | int32 |
<a name="machine.DebugContainerTerminalResize"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| width | int32 | ||
| height | int32 |
<a name="machine.DebugContainerRunRequestSpec.Profile"></a>
| Name | Number | Description |
|---|---|---|
| PROFILE_UNSPECIFIED | 0 | |
| PROFILE_PRIVILEGED | 1 | |
| PROFILE_HOST_NS | 2 | PROFILE_HOST_NS forks the host mount namespace, overlays image tools at /nix, and runs the shell directly on the host rootfs without nsenter. |
<a name="machine.DebugService"></a>
DebugService provides debugging and inspection capabilities for a Talos node.
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| ContainerRun | DebugContainerRunRequest stream | DebugContainerRunResponse stream | ContainerRun runs a debug container, attaches to it, and streams I/O. |
<a name="machine/image.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="machine.ImageServiceCredentials"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| host | string | Host of the registry (e.g. "docker.io"). | |
| username | string | Username for the registry. | |
| password | string | Password (token) for the registry. |
<a name="machine.ImageServiceImportRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| containerd | common.ContainerdInstance | Containerd instance to use. | |
| image_chunk | common.Data | Chunk of the image tarball. |
<a name="machine.ImageServiceImportResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | Name of the imported image. |
<a name="machine.ImageServiceListRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| containerd | common.ContainerdInstance |
<a name="machine.ImageServiceListResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| digest | string | ||
| size | int64 | ||
| created_at | google.protobuf.Timestamp | ||
| labels | ImageServiceListResponse.LabelsEntry | repeated |
<a name="machine.ImageServiceListResponse.LabelsEntry"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | string |
<a name="machine.ImageServicePullLayerProgress"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| status | ImageServicePullLayerProgress.Status | ||
| elapsed | google.protobuf.Duration | ||
| offset | int64 | ||
| total | int64 |
<a name="machine.ImageServicePullProgress"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| layer_id | string | ||
| progress | ImageServicePullLayerProgress |
<a name="machine.ImageServicePullRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| containerd | common.ContainerdInstance | ||
| image_ref | string | Image reference to pull. |
<a name="machine.ImageServicePullResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | Name of the pulled image (when done). | |
| pull_progress | ImageServicePullProgress | Progress of the image pull (intermediate updates). |
<a name="machine.ImageServiceRemoveRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| containerd | common.ContainerdInstance | ||
| image_ref | string | Image reference to remove. |
<a name="machine.ImageServiceVerifyRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| image_ref | string | Image reference to verify. |
The image reference could be either in: * the digest form (e.g. "docker.io/library/nginx@sha256:abc123...") to ensure that the exact image is verified. * the tag form (e.g. "docker.io/library/nginx:latest") to verify the image currently pointed by the tag, and the resolved digested will be returned in the response.
Any other format will cause the error. | | credentials | ImageServiceCredentials | | Authentication credentials for the registry (if needed).
By default Talos will use configured auth, but additional image pull secret can be submitted here. |
<a name="machine.ImageServiceVerifyResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| verified | bool | Was the image verified: if it didn't match any verify rule, false will be returned. If the image matched the rule, but the verification failed, an error will be returned. | |
| message | string | Free-form verification result message, e.g. with details about the matched rule and how the image was verified. | |
| digested_image_ref | string | The pinned image reference with resolved digest that was verified (e.g. "docker.io/library/nginx@sha256:abc123..."). |
This is only set if verified=true. |
<!-- end messages --><a name="machine.ImageServicePullLayerProgress.Status"></a>
| Name | Number | Description |
|---|---|---|
| DOWNLOADING | 0 | Keep this in sync with ImagePullLayerProgress.Status. |
| DOWNLOAD_COMPLETE | 1 | |
| EXTRACTING | 2 | |
| EXTRACT_COMPLETE | 3 | |
| ALREADY_EXISTS | 4 |
<a name="machine.ImageService"></a>
The machine service definition.
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| List | ImageServiceListRequest | ImageServiceListResponse stream | List images in the containerd. |
| Pull | ImageServicePullRequest | ImageServicePullResponse stream | Pull an image into the containerd. |
| Import | ImageServiceImportRequest stream | ImageServiceImportResponse | Import an image from a stream (tarball). |
| Remove | ImageServiceRemoveRequest | .google.protobuf.Empty | Remove an image from the containerd. |
| Verify | ImageServiceVerifyRequest | ImageServiceVerifyResponse | Verify an image signature. |
<a name="machine/lifecycle.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="machine.InstallArtifactsSource"></a>
InstallArtifactsSource specifies the source of the installation artifacts.
| Field | Type | Label | Description |
|---|---|---|---|
| image_name | string | The reference name of the image, as returned by talosctl image pull. |
<a name="machine.InstallDestination"></a>
InstallDestination specifies the target for installation.
| Field | Type | Label | Description |
|---|---|---|---|
| disk | string | The disk to which Talos should be installed, e.g. "/dev/sda". |
<a name="machine.LifecycleServiceInstallProgress"></a>
LifecycleServiceInstallProgress represents the progress of the installation or upgrade process.
| Field | Type | Label | Description |
|---|---|---|---|
| message | string | A message indicating the current progress of the installation or upgrade. | |
| exit_code | int32 | An exit code indicating the result of the installation or upgrade process. A non-zero value indicates an error. Server SHOULD NOT respond with error, even if the value is non-zero. It's responsibility of the client to handle the exit code appropriately. |
<a name="machine.LifecycleServiceInstallRequest"></a>
LifecycleServiceInstallRequest contains the necessary information to perform an installation.
| Field | Type | Label | Description |
|---|---|---|---|
| containerd | common.ContainerdInstance | The containerd instance to use for pulling the installation artifacts. | |
| source | InstallArtifactsSource | The source of the installation artifacts. | |
| destination | InstallDestination | The destination for the installation. |
<a name="machine.LifecycleServiceInstallResponse"></a>
LifecycleServiceInstallResponse is the response message for the Install RPC, containing progress updates.
| Field | Type | Label | Description |
|---|---|---|---|
| progress | LifecycleServiceInstallProgress | The progress of the installation process. |
<a name="machine.LifecycleServiceUpgradeRequest"></a>
LifecycleServiceUpgradeRequest contains the necessary information to perform an upgrade.
| Field | Type | Label | Description |
|---|---|---|---|
| containerd | common.ContainerdInstance | The containerd instance to use for pulling the installation artifacts. | |
| source | InstallArtifactsSource | The source of the installation artifacts for the upgrade. |
<a name="machine.LifecycleServiceUpgradeResponse"></a>
LifecycleServiceUpgradeResponse is the response message for the Upgrade RPC, containing progress updates.
| Field | Type | Label | Description |
|---|---|---|---|
| progress | LifecycleServiceInstallProgress | The progress of the upgrade process. |
<a name="machine.LifecycleService"></a>
The LifecycleService handles installation and upgrade operations.
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| Install | LifecycleServiceInstallRequest | LifecycleServiceInstallResponse stream | Install Talos to disk. The RPC should fail if the Talos is already installed on the target disk. |
| Upgrade | LifecycleServiceUpgradeRequest | LifecycleServiceUpgradeResponse stream | Upgrade Talos to a new version. The RPC should fail if Talos is not already installed on the target disk. |
<a name="machine/lvm.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="machine.LVMServiceLogicalVolumeRemoveRequest"></a>
LVMServiceLogicalVolumeRemoveRequest identifies a single LV to remove.
| Field | Type | Label | Description |
|---|---|---|---|
| volume_group | string | VolumeGroup is the name of the parent VG (e.g. "vg0"). | |
| logical_volume | string | LogicalVolume is the name of the LV to remove (e.g. "lv0"). |
<a name="machine.LVMServicePhysicalVolumeRemoveRequest"></a>
LVMServicePhysicalVolumeRemoveRequest identifies a single PV label to wipe.
| Field | Type | Label | Description |
|---|---|---|---|
| device | string | Device is the block device path of the PV (e.g. "/dev/sda1"). |
<a name="machine.LVMServiceVolumeGroupRemoveRequest"></a>
LVMServiceVolumeGroupRemoveRequest identifies a single VG to remove.
| Field | Type | Label | Description |
|---|---|---|---|
| volume_group | string | VolumeGroup is the name of the VG to remove (e.g. "vg0"). |
<a name="machine.LVMService"></a>
LVMService manages LVM resources on a Talos node.
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| LogicalVolumeRemove | LVMServiceLogicalVolumeRemoveRequest | .google.protobuf.Empty | LogicalVolumeRemove removes an LVM logical volume. |
The LV must not be open (e.g. mounted or in use by another device). | | VolumeGroupRemove | LVMServiceVolumeGroupRemoveRequest | .google.protobuf.Empty | VolumeGroupRemove removes an LVM volume group.
WARNING: this cascades. Every logical volume inside the group is removed first, then the VG metadata itself. Callers that want fine-grained control should invoke LogicalVolumeRemove per LV before this RPC. The underlying physical volumes keep their LVM labels and must be cleared separately with PhysicalVolumeRemove. | | PhysicalVolumeRemove | LVMServicePhysicalVolumeRemoveRequest | .google.protobuf.Empty | PhysicalVolumeRemove wipes the LVM label and metadata from a block device.
The PV must not be part of an active volume group; remove the VG first with VolumeGroupRemove. |
<!-- end services --><a name="machine/machine.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="machine.AddressEvent"></a>
AddressEvent reports node endpoints aggregated from k8s.Endpoints and network.Hostname.
| Field | Type | Label | Description |
|---|---|---|---|
| hostname | string | ||
| addresses | string | repeated |
<a name="machine.ApplyConfiguration"></a>
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. |
<a name="machine.ApplyConfigurationRequest"></a>
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 |
<a name="machine.ApplyConfigurationResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | ApplyConfiguration | repeated |
<a name="machine.BPFInstruction"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| op | uint32 | ||
| jt | uint32 | ||
| jf | uint32 | ||
| k | uint32 |
<a name="machine.Bootstrap"></a>
The bootstrap message containing the bootstrap status.
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata |
<a name="machine.BootstrapRequest"></a>
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. |
<a name="machine.BootstrapResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | Bootstrap | repeated |
<a name="machine.CNIConfig"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| urls | string | repeated |
<a name="machine.CPUFreqStats"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| current_frequency | uint64 | ||
| minimum_frequency | uint64 | ||
| maximum_frequency | uint64 | ||
| governor | string |
<a name="machine.CPUFreqStatsResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | CPUsFreqStats | repeated |
<a name="machine.CPUInfo"></a>
| 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 |
<a name="machine.CPUInfoResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | CPUsInfo | repeated |
<a name="machine.CPUStat"></a>
| 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 |
<a name="machine.CPUsFreqStats"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| cpu_freq_stats | CPUFreqStats | repeated |
<a name="machine.CPUsInfo"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| cpu_info | CPUInfo | repeated |
<a name="machine.ClusterConfig"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| control_plane | ControlPlaneConfig | ||
| cluster_network | ClusterNetworkConfig | ||
| allow_scheduling_on_control_planes | bool |
<a name="machine.ClusterNetworkConfig"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| dns_domain | string | ||
| cni_config | CNIConfig |
<a name="machine.ConfigLoadErrorEvent"></a>
ConfigLoadErrorEvent is reported when the config loading has failed.
| Field | Type | Label | Description |
|---|---|---|---|
| error | string |
<a name="machine.ConfigValidationErrorEvent"></a>
ConfigValidationErrorEvent is reported when config validation has failed.
| Field | Type | Label | Description |
|---|---|---|---|
| error | string |
<a name="machine.ConnectRecord"></a>
| 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 |
<a name="machine.ConnectRecord.Process"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| pid | uint32 | ||
| name | string |
<a name="machine.Container"></a>
The messages message containing the requested containers.
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| containers | ContainerInfo | repeated |
<a name="machine.ContainerInfo"></a>
The messages message containing the requested containers.
| Field | Type | Label | Description |
|---|---|---|---|
| namespace | string | ||
| id | string | ||
| uid | string | ||
| internal_id | string | ||
| image | string | ||
| pid | uint32 | ||
| status | string | ||
| pod_id | string | ||
| name | string | ||
| network_namespace | string |
<a name="machine.ContainersRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| namespace | string | ||
| driver | common.ContainerDriver | driver might be default "containerd" or "cri" |
<a name="machine.ContainersResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | Container | repeated |
<a name="machine.ControlPlaneConfig"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| endpoint | string |
<a name="machine.CopyRequest"></a>
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 |
<a name="machine.DHCPOptionsConfig"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| route_metric | uint32 |
<a name="machine.DiskStat"></a>
| 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 |
<a name="machine.DiskStats"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| total | DiskStat | ||
| devices | DiskStat | repeated |
<a name="machine.DiskStatsResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | DiskStats | repeated |
<a name="machine.DiskUsageInfo"></a>
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 |
<a name="machine.DiskUsageRequest"></a>
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. |
<a name="machine.DmesgRequest"></a>
dmesg
| Field | Type | Label | Description |
|---|---|---|---|
| follow | bool | ||
| tail | bool |
<a name="machine.EtcdAlarm"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| member_alarms | EtcdMemberAlarm | repeated |
<a name="machine.EtcdAlarmDisarm"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| member_alarms | EtcdMemberAlarm | repeated |
<a name="machine.EtcdAlarmDisarmResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | EtcdAlarmDisarm | repeated |
<a name="machine.EtcdAlarmListResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | EtcdAlarm | repeated |
<a name="machine.EtcdClusterDowngrade"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| cluster_version | string |
<a name="machine.EtcdDefragment"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata |
<a name="machine.EtcdDefragmentResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | EtcdDefragment | repeated |
<a name="machine.EtcdDowngradeCancel"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| cluster_downgrade | EtcdClusterDowngrade |
<a name="machine.EtcdDowngradeCancelResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | EtcdDowngradeCancel | repeated |
<a name="machine.EtcdDowngradeEnable"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| cluster_downgrade | EtcdClusterDowngrade |
<a name="machine.EtcdDowngradeEnableRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| version | string |
<a name="machine.EtcdDowngradeEnableResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | EtcdDowngradeEnable | repeated |
<a name="machine.EtcdDowngradeValidate"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| cluster_downgrade | EtcdClusterDowngrade |
<a name="machine.EtcdDowngradeValidateRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| version | string |
<a name="machine.EtcdDowngradeValidateResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | EtcdDowngradeValidate | repeated |
<a name="machine.EtcdForfeitLeadership"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| member | string |
<a name="machine.EtcdForfeitLeadershipRequest"></a>
<a name="machine.EtcdForfeitLeadershipResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | EtcdForfeitLeadership | repeated |
<a name="machine.EtcdLeaveCluster"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata |
<a name="machine.EtcdLeaveClusterRequest"></a>
<a name="machine.EtcdLeaveClusterResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | EtcdLeaveCluster | repeated |
<a name="machine.EtcdMember"></a>
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 |
<a name="machine.EtcdMemberAlarm"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| member_id | uint64 | ||
| alarm | EtcdMemberAlarm.AlarmType |
<a name="machine.EtcdMemberListRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| query_local | bool |
<a name="machine.EtcdMemberListResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | EtcdMembers | repeated |
<a name="machine.EtcdMemberStatus"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| storage_version | string | ||
| 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 |
<a name="machine.EtcdMembers"></a>
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. |
<a name="machine.EtcdRecover"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata |
<a name="machine.EtcdRecoverResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | EtcdRecover | repeated |
<a name="machine.EtcdRemoveMember"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata |
<a name="machine.EtcdRemoveMemberByID"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata |
<a name="machine.EtcdRemoveMemberByIDRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| member_id | uint64 |
<a name="machine.EtcdRemoveMemberByIDResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | EtcdRemoveMemberByID | repeated |
<a name="machine.EtcdRemoveMemberRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| member | string |
<a name="machine.EtcdRemoveMemberResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | EtcdRemoveMember | repeated |
<a name="machine.EtcdSnapshotRequest"></a>
<a name="machine.EtcdStatus"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| member_status | EtcdMemberStatus |
<a name="machine.EtcdStatusResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | EtcdStatus | repeated |
<a name="machine.Event"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| data | google.protobuf.Any | ||
| id | string | ||
| actor_id | string |
<a name="machine.EventsRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| tail_events | int32 | ||
| tail_id | string | ||
| tail_seconds | int32 | ||
| with_actor_id | string |
<a name="machine.FeaturesInfo"></a>
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. |
<a name="machine.FileInfo"></a>
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 | |
| xattrs | Xattr | repeated | Extended attributes (if present and requested) |
<a name="machine.GenerateClientConfiguration"></a>
| 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. |
<a name="machine.GenerateClientConfigurationRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| roles | string | repeated | Roles in the generated client certificate. |
| crt_ttl | google.protobuf.Duration | Client certificate TTL. |
<a name="machine.GenerateClientConfigurationResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | GenerateClientConfiguration | repeated |
<a name="machine.Hostname"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| hostname | string |
<a name="machine.HostnameResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | Hostname | repeated |
<a name="machine.ImageListRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| namespace | common.ContainerdNamespace | Containerd namespace to use. |
<a name="machine.ImageListResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| name | string | ||
| digest | string | ||
| size | int64 | ||
| created_at | google.protobuf.Timestamp |
<a name="machine.ImagePull"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata |
<a name="machine.ImagePullRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| namespace | common.ContainerdNamespace | Containerd namespace to use. | |
| reference | string | Image reference to pull. |
<a name="machine.ImagePullResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | ImagePull | repeated |
<a name="machine.InstallConfig"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| install_disk | string | ||
| install_image | string |
<a name="machine.ListRequest"></a>
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. |
| report_xattrs | bool | Report xattrs |
<a name="machine.LoadAvg"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| load1 | double | ||
| load5 | double | ||
| load15 | double |
<a name="machine.LoadAvgResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | LoadAvg | repeated |
<a name="machine.LogsContainer"></a>
LogsContainer describes all available registered log containers.
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| ids | string | repeated |
<a name="machine.LogsContainersResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | LogsContainer | repeated |
<a name="machine.LogsRequest"></a>
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 |
<a name="machine.MachineConfig"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| type | MachineConfig.MachineType | ||
| install_config | InstallConfig | ||
| network_config | NetworkConfig | ||
| kubernetes_version | string |
<a name="machine.MachineStatusEvent"></a>
MachineStatusEvent reports changes to the MachineStatus resource.
| Field | Type | Label | Description |
|---|---|---|---|
| stage | MachineStatusEvent.MachineStage | ||
| status | MachineStatusEvent.MachineStatus |
<a name="machine.MachineStatusEvent.MachineStatus"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| ready | bool | ||
| unmet_conditions | MachineStatusEvent.MachineStatus.UnmetCondition | repeated |
<a name="machine.MachineStatusEvent.MachineStatus.UnmetCondition"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| reason | string |
<a name="machine.MemInfo"></a>
| 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 |
<a name="machine.Memory"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| meminfo | MemInfo |
<a name="machine.MemoryResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | Memory | repeated |
<a name="machine.MetaDelete"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata |
<a name="machine.MetaDeleteRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| key | uint32 |
<a name="machine.MetaDeleteResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | MetaDelete | repeated |
<a name="machine.MetaWrite"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata |
<a name="machine.MetaWriteRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| key | uint32 | ||
| value | bytes |
<a name="machine.MetaWriteResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | MetaWrite | repeated |
<a name="machine.MountStat"></a>
The messages message containing the requested processes.
| Field | Type | Label | Description |
|---|---|---|---|
| filesystem | string | ||
| size | uint64 | ||
| available | uint64 | ||
| mounted_on | string |
<a name="machine.Mounts"></a>
The messages message containing the requested df stats.
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| stats | MountStat | repeated |
<a name="machine.MountsResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | Mounts | repeated |
<a name="machine.NetDev"></a>
| 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 |
<a name="machine.Netstat"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| connectrecord | ConnectRecord | repeated |
<a name="machine.NetstatRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| filter | NetstatRequest.Filter | ||
| feature | NetstatRequest.Feature | ||
| l4proto | NetstatRequest.L4proto | ||
| netns | NetstatRequest.NetNS |
<a name="machine.NetstatRequest.Feature"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| pid | bool |
<a name="machine.NetstatRequest.L4proto"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| tcp | bool | ||
| tcp6 | bool | ||
| udp | bool | ||
| udp6 | bool | ||
| udplite | bool | ||
| udplite6 | bool | ||
| raw | bool | ||
| raw6 | bool |
<a name="machine.NetstatRequest.NetNS"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| hostnetwork | bool | ||
| netns | string | repeated | |
| allnetns | bool |
<a name="machine.NetstatResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | Netstat | repeated |
<a name="machine.NetworkConfig"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| hostname | string | ||
| interfaces | NetworkDeviceConfig | repeated |
<a name="machine.NetworkDeviceConfig"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| interface | string | ||
| cidr | string | ||
| mtu | int32 | ||
| dhcp | bool | ||
| ignore | bool | ||
| dhcp_options | DHCPOptionsConfig | ||
| routes | RouteConfig | repeated |
<a name="machine.NetworkDeviceStats"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| total | NetDev | ||
| devices | NetDev | repeated |
<a name="machine.NetworkDeviceStatsResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | NetworkDeviceStats | repeated |
<a name="machine.PacketCaptureRequest"></a>
| 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. |
<a name="machine.PhaseEvent"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| phase | string | ||
| action | PhaseEvent.Action |
<a name="machine.PlatformInfo"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| mode | string |
<a name="machine.Process"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| processes | ProcessInfo | repeated |
<a name="machine.ProcessInfo"></a>
| 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 | ||
| label | string |
<a name="machine.ProcessesResponse"></a>
rpc processes
| Field | Type | Label | Description |
|---|---|---|---|
| messages | Process | repeated |
<a name="machine.ReadRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| path | string |
<a name="machine.Reboot"></a>
The reboot message containing the reboot status.
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| actor_id | string |
<a name="machine.RebootRequest"></a>
rpc reboot
| Field | Type | Label | Description |
|---|---|---|---|
| mode | RebootRequest.Mode |
<a name="machine.RebootResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | Reboot | repeated |
<a name="machine.Reset"></a>
The reset message containing the restart status.
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| actor_id | string |
<a name="machine.ResetPartitionSpec"></a>
rpc reset
| Field | Type | Label | Description |
|---|---|---|---|
| label | string | ||
| wipe | bool |
<a name="machine.ResetRequest"></a>
| 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. |
<a name="machine.ResetResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | Reset | repeated |
<a name="machine.Restart"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata |
<a name="machine.RestartEvent"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| cmd | int64 |
<a name="machine.RestartRequest"></a>
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" |
<a name="machine.RestartResponse"></a>
The messages message containing the restart status.
| Field | Type | Label | Description |
|---|---|---|---|
| messages | Restart | repeated |
<a name="machine.Rollback"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata |
<a name="machine.RollbackRequest"></a>
rpc rollback
<a name="machine.RollbackResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | Rollback | repeated |
<a name="machine.RouteConfig"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| network | string | ||
| gateway | string | ||
| metric | uint32 |
<a name="machine.SequenceEvent"></a>
rpc events
| Field | Type | Label | Description |
|---|---|---|---|
| sequence | string | ||
| action | SequenceEvent.Action | ||
| error | common.Error |
<a name="machine.ServiceEvent"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| msg | string | ||
| state | string | ||
| ts | google.protobuf.Timestamp |
<a name="machine.ServiceEvents"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| events | ServiceEvent | repeated |
<a name="machine.ServiceHealth"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| unknown | bool | ||
| healthy | bool | ||
| last_message | string | ||
| last_change | google.protobuf.Timestamp |
<a name="machine.ServiceInfo"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| id | string | ||
| state | string | ||
| events | ServiceEvents | ||
| health | ServiceHealth |
<a name="machine.ServiceList"></a>
rpc servicelist
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| services | ServiceInfo | repeated |
<a name="machine.ServiceListResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | ServiceList | repeated |
<a name="machine.ServiceRestart"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| resp | string |
<a name="machine.ServiceRestartRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| id | string |
<a name="machine.ServiceRestartResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | ServiceRestart | repeated |
<a name="machine.ServiceStart"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| resp | string |
<a name="machine.ServiceStartRequest"></a>
rpc servicestart
| Field | Type | Label | Description |
|---|---|---|---|
| id | string |
<a name="machine.ServiceStartResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | ServiceStart | repeated |
<a name="machine.ServiceStateEvent"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| service | string | ||
| action | ServiceStateEvent.Action | ||
| message | string | ||
| health | ServiceHealth |
<a name="machine.ServiceStop"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| resp | string |
<a name="machine.ServiceStopRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| id | string |
<a name="machine.ServiceStopResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | ServiceStop | repeated |
<a name="machine.Shutdown"></a>
rpc shutdown The messages message containing the shutdown status.
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| actor_id | string |
<a name="machine.ShutdownRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| force | bool | Force indicates whether node should shutdown without first cordening and draining |
<a name="machine.ShutdownResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | Shutdown | repeated |
<a name="machine.SoftIRQStat"></a>
| 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 |
<a name="machine.Stat"></a>
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 |
<a name="machine.Stats"></a>
The messages message containing the requested stats.
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| stats | Stat | repeated |
<a name="machine.StatsRequest"></a>
The request message containing the containerd namespace.
| Field | Type | Label | Description |
|---|---|---|---|
| namespace | string | ||
| driver | common.ContainerDriver | driver might be default "containerd" or "cri" |
<a name="machine.StatsResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | Stats | repeated |
<a name="machine.SystemStat"></a>
| 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 |
<a name="machine.SystemStatResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | SystemStat | repeated |
<a name="machine.TaskEvent"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| task | string | ||
| action | TaskEvent.Action |
<a name="machine.Upgrade"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| ack | string | ||
| actor_id | string |
<a name="machine.UpgradeRequest"></a>
rpc upgrade
| Field | Type | Label | Description |
|---|---|---|---|
| image | string | ||
| preserve | bool | ||
| stage | bool | ||
| force | bool | ||
| reboot_mode | UpgradeRequest.RebootMode |
<a name="machine.UpgradeResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | Upgrade | repeated |
<a name="machine.Version"></a>
| 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. |
<a name="machine.VersionInfo"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| tag | string | ||
| sha | string | ||
| built | string | ||
| go_version | string | ||
| os | string | ||
| arch | string |
<a name="machine.VersionResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | Version | repeated |
<a name="machine.Xattr"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| data | bytes |
<a name="machine.ApplyConfigurationRequest.Mode"></a>
| Name | Number | Description |
|---|---|---|
| REBOOT | 0 | Deprecated: use AUTO or NO_REBOOT instead |
| AUTO | 1 | |
| NO_REBOOT | 2 | |
| STAGED | 3 | |
| TRY | 4 |
<a name="machine.ConnectRecord.State"></a>
| 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 |
<a name="machine.ConnectRecord.TimerActive"></a>
| Name | Number | Description |
|---|---|---|
| OFF | 0 | |
| ON | 1 | |
| KEEPALIVE | 2 | |
| TIMEWAIT | 3 | |
| PROBE | 4 |
<a name="machine.EtcdMemberAlarm.AlarmType"></a>
| Name | Number | Description |
|---|---|---|
| NONE | 0 | |
| NOSPACE | 1 | |
| CORRUPT | 2 |
<a name="machine.ListRequest.Type"></a>
File type.
| Name | Number | Description |
|---|---|---|
| REGULAR | 0 | Regular file (not directory, symlink, etc). |
| DIRECTORY | 1 | Directory. |
| SYMLINK | 2 | Symbolic link. |
<a name="machine.MachineConfig.MachineType"></a>
| Name | Number | Description |
|---|---|---|
| TYPE_UNKNOWN | 0 | |
| TYPE_INIT | 1 | |
| TYPE_CONTROL_PLANE | 2 | |
| TYPE_WORKER | 3 |
<a name="machine.MachineStatusEvent.MachineStage"></a>
| Name | Number | Description |
|---|---|---|
| UNKNOWN | 0 | |
| BOOTING | 1 | |
| INSTALLING | 2 | |
| MAINTENANCE | 3 | |
| RUNNING | 4 | |
| REBOOTING | 5 | |
| SHUTTING_DOWN | 6 | |
| RESETTING | 7 | |
| UPGRADING | 8 |
<a name="machine.NetstatRequest.Filter"></a>
| Name | Number | Description |
|---|---|---|
| ALL | 0 | |
| CONNECTED | 1 | |
| LISTENING | 2 |
<a name="machine.PhaseEvent.Action"></a>
| Name | Number | Description |
|---|---|---|
| START | 0 | |
| STOP | 1 |
<a name="machine.RebootRequest.Mode"></a>
| Name | Number | Description |
|---|---|---|
| DEFAULT | 0 | |
| POWERCYCLE | 1 | |
| FORCE | 2 |
<a name="machine.ResetRequest.WipeMode"></a>
| Name | Number | Description |
|---|---|---|
| ALL | 0 | |
| SYSTEM_DISK | 1 | |
| USER_DISKS | 2 |
<a name="machine.SequenceEvent.Action"></a>
| Name | Number | Description |
|---|---|---|
| NOOP | 0 | |
| START | 1 | |
| STOP | 2 |
<a name="machine.ServiceStateEvent.Action"></a>
| Name | Number | Description |
|---|---|---|
| INITIALIZED | 0 | |
| PREPARING | 1 | |
| WAITING | 2 | |
| RUNNING | 3 | |
| STOPPING | 4 | |
| FINISHED | 5 | |
| FAILED | 6 | |
| SKIPPED | 7 | |
| STARTING | 8 |
<a name="machine.TaskEvent.Action"></a>
| Name | Number | Description |
|---|---|---|
| START | 0 | |
| STOP | 1 |
<a name="machine.UpgradeRequest.RebootMode"></a>
| Name | Number | Description |
|---|---|---|
| DEFAULT | 0 | |
| POWERCYCLE | 1 |
<a name="machine.MachineService"></a>
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 | |
| CPUFreqStats | .google.protobuf.Empty | CPUFreqStatsResponse | |
| CPUInfo | .google.protobuf.Empty | CPUInfoResponse | |
| DiskStats | .google.protobuf.Empty | DiskStatsResponse | |
| Dmesg | DmesgRequest | .common.Data stream | |
| Events | EventsRequest | Event stream | |
| EtcdMemberList | EtcdMemberListRequest | EtcdMemberListResponse | |
| 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). |
| EtcdDowngradeValidate | EtcdDowngradeValidateRequest | EtcdDowngradeValidateResponse | EtcdDowngradeValidate validates etcd cluster for downgrade to a specific version. This method is available only on control plane nodes (which run etcd). |
| EtcdDowngradeEnable | EtcdDowngradeEnableRequest | EtcdDowngradeEnableResponse | EtcdDowngradeEnable enables etcd cluster downgrade to a specific version. This method is available only on control plane nodes (which run etcd). |
| EtcdDowngradeCancel | .google.protobuf.Empty | EtcdDowngradeCancelResponse | EtcdDowngradeCancel cancels etcd cluster downgrade that is in progress. This method is available only on control plane nodes (which run etcd). |
| 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 | |
| LogsContainers | .google.protobuf.Empty | LogsContainersResponse | |
| 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 | Upgrade initiates the upgrade of the node to a new version of Talos. |
Use LifecycleService Upgrade RPC instead. | | 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. | | ImageList | ImageListRequest | ImageListResponse stream | ImageList lists images in the CRI.
Use ImageService List RPC instead. | | ImagePull | ImagePullRequest | ImagePullResponse | ImagePull pulls an image into the CRI.
Use ImageService Pull RPC instead. |
<!-- end services --><a name="machine/md.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="machine.MDDestroyRequest"></a>
MDDestroyRequest identifies the array device to tear down.
| Field | Type | Label | Description |
|---|---|---|---|
| device | string | Device is the full array device path to destroy (e.g. "/dev/disk/by-id/md-name-data"). |
<a name="machine.MDService"></a>
MDService maintains MD (Multiple Device, software RAID) arrays.
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| Destroy | MDDestroyRequest | .google.protobuf.Empty | Destroy stops the array and clears the superblock on every member. |
The array must not be in use (e.g. mounted or claimed by another device) at the time of the call. |
<!-- end services --><a name="resource/config/config.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="resource.config.MachineConfigSpec"></a>
MessageConfigSpec is the spec for the config.MachineConfig resource.
| Field | Type | Label | Description |
|---|---|---|---|
| yaml_marshalled | bytes | Contains YAML marshalled machine configuration. |
Byte representation is preserved as the machine configuration was submitted to the node. |
<a name="resource.config.MachineTypeSpec"></a>
MachineTypeSpec is the spec for the config.MachineType resource.
| Field | Type | Label | Description |
|---|---|---|---|
| machine_type | MachineType |
<a name="resource.config.MachineType"></a>
MachineType matches machine.Type constants.
| Name | Number | Description |
|---|---|---|
| UNKNOWN | 0 | |
| INIT | 1 | |
| CONTROL_PLANE | 2 | |
| WORKER | 3 |
<a name="resource/definitions/enums/enums.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="talos.resource.definitions.enums.BlockEncryptionKeyType"></a>
BlockEncryptionKeyType describes encryption key type.
| Name | Number | Description |
|---|---|---|
| ENCRYPTION_KEY_STATIC | 0 | |
| ENCRYPTION_KEY_NODE_ID | 1 | |
| ENCRYPTION_KEY_KMS | 2 | |
| ENCRYPTION_KEY_TPM | 3 |
<a name="talos.resource.definitions.enums.BlockEncryptionProviderType"></a>
BlockEncryptionProviderType describes encryption provider type.
| Name | Number | Description |
|---|---|---|
| ENCRYPTION_PROVIDER_NONE | 0 | |
| ENCRYPTION_PROVIDER_LUKS2 | 1 |
<a name="talos.resource.definitions.enums.BlockFSParameterType"></a>
BlockFSParameterType describes Filesystem Parameter type.
| Name | Number | Description |
|---|---|---|
| FS_PARAMETER_TYPE_STRING_VALUE | 0 | |
| FS_PARAMETER_TYPE_BOOLEAN_VALUE | 1 | |
| FS_PARAMETER_TYPE_BINARY_VALUE | 2 |
<a name="talos.resource.definitions.enums.BlockFilesystemType"></a>
BlockFilesystemType describes filesystem type.
| Name | Number | Description |
|---|---|---|
| FILESYSTEM_TYPE_NONE | 0 | |
| FILESYSTEM_TYPE_XFS | 1 | |
| FILESYSTEM_TYPE_VFAT | 2 | |
| FILESYSTEM_TYPE_EXT4 | 3 | |
| FILESYSTEM_TYPE_ISO9660 | 4 | |
| FILESYSTEM_TYPE_SWAP | 5 | |
| FILESYSTEM_TYPE_VIRTIOFS | 6 | |
| FILESYSTEM_TYPE_BTRFS | 7 |
<a name="talos.resource.definitions.enums.BlockVolumePhase"></a>
BlockVolumePhase describes volume phase.
| Name | Number | Description |
|---|---|---|
| VOLUME_PHASE_WAITING | 0 | |
| VOLUME_PHASE_FAILED | 1 | |
| VOLUME_PHASE_MISSING | 2 | |
| VOLUME_PHASE_LOCATED | 3 | |
| VOLUME_PHASE_PROVISIONED | 4 | |
| VOLUME_PHASE_PREPARED | 5 | |
| VOLUME_PHASE_READY | 6 | |
| VOLUME_PHASE_CLOSED | 7 |
<a name="talos.resource.definitions.enums.BlockVolumeType"></a>
BlockVolumeType describes volume type.
| Name | Number | Description |
|---|---|---|
| VOLUME_TYPE_PARTITION | 0 | |
| VOLUME_TYPE_DISK | 1 | |
| VOLUME_TYPE_TMPFS | 2 | |
| VOLUME_TYPE_DIRECTORY | 3 | |
| VOLUME_TYPE_SYMLINK | 4 | |
| VOLUME_TYPE_OVERLAY | 5 | |
| VOLUME_TYPE_EXTERNAL | 6 |
<a name="talos.resource.definitions.enums.ContainersContainerImagePhase"></a>
ContainersContainerImagePhase describes the state of a container's image pull.
| Name | Number | Description |
|---|---|---|
| CONTAINER_IMAGE_PHASE_PENDING | 0 | |
| CONTAINER_IMAGE_PHASE_PULLING | 1 | |
| CONTAINER_IMAGE_PHASE_READY | 2 | |
| CONTAINER_IMAGE_PHASE_FAILED | 3 |
<a name="talos.resource.definitions.enums.ContainersContainerInstancePhase"></a>
ContainersContainerInstancePhase describes the state of a container instance's execution.
| Name | Number | Description |
|---|---|---|
| CONTAINER_INSTANCE_PHASE_CREATED | 0 | |
| CONTAINER_INSTANCE_PHASE_RUNNING | 1 | |
| CONTAINER_INSTANCE_PHASE_TERMINATED | 2 | |
| CONTAINER_INSTANCE_PHASE_FAILED | 3 |
<a name="talos.resource.definitions.enums.CriImageCacheCopyStatus"></a>
CriImageCacheCopyStatus describes image cache copy status type.
| Name | Number | Description |
|---|---|---|
| IMAGE_CACHE_COPY_STATUS_UNKNOWN | 0 | |
| IMAGE_CACHE_COPY_STATUS_SKIPPED | 1 | |
| IMAGE_CACHE_COPY_STATUS_PENDING | 2 | |
| IMAGE_CACHE_COPY_STATUS_READY | 3 |
<a name="talos.resource.definitions.enums.CriImageCacheStatus"></a>
CriImageCacheStatus describes image cache status type.
| Name | Number | Description |
|---|---|---|
| IMAGE_CACHE_STATUS_UNKNOWN | 0 | |
| IMAGE_CACHE_STATUS_DISABLED | 1 | |
| IMAGE_CACHE_STATUS_PREPARING | 2 | |
| IMAGE_CACHE_STATUS_READY | 3 |
<a name="talos.resource.definitions.enums.KubespanPeerState"></a>
KubespanPeerState is KubeSpan peer current state.
| Name | Number | Description |
|---|---|---|
| PEER_STATE_UNKNOWN | 0 | |
| PEER_STATE_UP | 1 | |
| PEER_STATE_DOWN | 2 |
<a name="talos.resource.definitions.enums.MachineType"></a>
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. |
<a name="talos.resource.definitions.enums.NethelpersADLACPActive"></a>
NethelpersADLACPActive is ADLACPActive.
| Name | Number | Description |
|---|---|---|
| ADLACP_ACTIVE_OFF | 0 | |
| ADLACP_ACTIVE_ON | 1 |
<a name="talos.resource.definitions.enums.NethelpersADSelect"></a>
NethelpersADSelect is ADSelect.
| Name | Number | Description |
|---|---|---|
| AD_SELECT_STABLE | 0 | |
| AD_SELECT_BANDWIDTH | 1 | |
| AD_SELECT_COUNT | 2 |
<a name="talos.resource.definitions.enums.NethelpersARPAllTargets"></a>
NethelpersARPAllTargets is an ARP targets mode.
| Name | Number | Description |
|---|---|---|
| ARP_ALL_TARGETS_ANY | 0 | |
| ARP_ALL_TARGETS_ALL | 1 |
<a name="talos.resource.definitions.enums.NethelpersARPValidate"></a>
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 | |
| ARP_VALIDATE_FILTER | 4 | |
| ARP_VALIDATE_FILTER_ACTIVE | 5 | |
| ARP_VALIDATE_FILTER_BACKUP | 6 |
<a name="talos.resource.definitions.enums.NethelpersAddressFlag"></a>
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 |
<a name="talos.resource.definitions.enums.NethelpersAddressSortAlgorithm"></a>
NethelpersAddressSortAlgorithm is an internal address sorting algorithm.
| Name | Number | Description |
|---|---|---|
| ADDRESS_SORT_ALGORITHM_V1 | 0 | |
| ADDRESS_SORT_ALGORITHM_V2 | 1 |
<a name="talos.resource.definitions.enums.NethelpersAutoHostnameKind"></a>
NethelpersAutoHostnameKind is a kind of automatically generated hostname.
| Name | Number | Description |
|---|---|---|
| AUTO_HOSTNAME_KIND_OFF | 0 | |
| AUTO_HOSTNAME_KIND_ADDR | 1 | |
| AUTO_HOSTNAME_KIND_STABLE | 2 |
<a name="talos.resource.definitions.enums.NethelpersBGPSessionState"></a>
NethelpersBGPSessionState is the state of a BGP peering session (RFC 4271 FSM).
| Name | Number | Description |
|---|---|---|
| BGP_SESSION_STATE_UNKNOWN | 0 | |
| BGP_SESSION_STATE_IDLE | 1 | |
| BGP_SESSION_STATE_CONNECT | 2 | |
| BGP_SESSION_STATE_ACTIVE | 3 | |
| BGP_SESSION_STATE_OPEN_SENT | 4 | |
| BGP_SESSION_STATE_OPEN_CONFIRM | 5 | |
| BGP_SESSION_STATE_ESTABLISHED | 6 |
<a name="talos.resource.definitions.enums.NethelpersBondMode"></a>
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 |
<a name="talos.resource.definitions.enums.NethelpersBondXmitHashPolicy"></a>
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 |
<a name="talos.resource.definitions.enums.NethelpersClientIdentifier"></a>
NethelpersClientIdentifier is a DHCP client identifier.
| Name | Number | Description |
|---|---|---|
| CLIENT_IDENTIFIER_NONE | 0 | |
| CLIENT_IDENTIFIER_MAC | 1 | |
| CLIENT_IDENTIFIER_DUID | 2 |
<a name="talos.resource.definitions.enums.NethelpersConntrackState"></a>
NethelpersConntrackState is a conntrack state.
| Name | Number | Description |
|---|---|---|
| NETHELPERS_CONNTRACKSTATE_UNSPECIFIED | 0 | |
| CONNTRACK_STATE_NEW | 8 | |
| CONNTRACK_STATE_RELATED | 4 | |
| CONNTRACK_STATE_ESTABLISHED | 2 | |
| CONNTRACK_STATE_INVALID | 1 |
<a name="talos.resource.definitions.enums.NethelpersDNSProtocol"></a>
NethelpersDNSProtocol is a kind of DNS protocol.
| Name | Number | Description |
|---|---|---|
| DNS_PROTOCOL_DEFAULT | 0 | |
| DNS_PROTOCOL_DNS_OVER_TLS | 1 | |
| DNS_PROTOCOL_DNS_OVER_HTTP | 2 |
<a name="talos.resource.definitions.enums.NethelpersDuplex"></a>
NethelpersDuplex wraps ethtool.Duplex for YAML marshaling.
| Name | Number | Description |
|---|---|---|
| HALF | 0 | |
| FULL | 1 | |
| UNKNOWN | 255 |
<a name="talos.resource.definitions.enums.NethelpersFailOverMAC"></a>
NethelpersFailOverMAC is a MAC failover mode.
| Name | Number | Description |
|---|---|---|
| FAIL_OVER_MAC_NONE | 0 | |
| FAIL_OVER_MAC_ACTIVE | 1 | |
| FAIL_OVER_MAC_FOLLOW | 2 |
<a name="talos.resource.definitions.enums.NethelpersFamily"></a>
NethelpersFamily is a network family.
| Name | Number | Description |
|---|---|---|
| NETHELPERS_FAMILY_UNSPECIFIED | 0 | |
| FAMILY_INET4 | 2 | |
| FAMILY_INET6 | 10 |
<a name="talos.resource.definitions.enums.NethelpersICMPType"></a>
NethelpersICMPType is a ICMP packet type.
| Name | Number | Description |
|---|---|---|
| NETHELPERS_ICMPTYPE_UNSPECIFIED | 0 | |
| ICMP_TYPE_TIMESTAMP_REQUEST | 13 | |
| ICMP_TYPE_TIMESTAMP_REPLY | 14 | |
| ICMP_TYPE_ADDRESS_MASK_REQUEST | 17 | |
| ICMP_TYPE_ADDRESS_MASK_REPLY | 18 |
<a name="talos.resource.definitions.enums.NethelpersLACPRate"></a>
NethelpersLACPRate is a LACP rate.
| Name | Number | Description |
|---|---|---|
| LACP_RATE_SLOW | 0 | |
| LACP_RATE_FAST | 1 |
<a name="talos.resource.definitions.enums.NethelpersLinkType"></a>
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 |
<a name="talos.resource.definitions.enums.NethelpersMatchOperator"></a>
NethelpersMatchOperator is a netfilter match operator.
| Name | Number | Description |
|---|---|---|
| OPERATOR_EQUAL | 0 | |
| OPERATOR_NOT_EQUAL | 1 |
<a name="talos.resource.definitions.enums.NethelpersNfTablesChainHook"></a>
NethelpersNfTablesChainHook wraps nftables.ChainHook for YAML marshaling.
| Name | Number | Description |
|---|---|---|
| CHAIN_HOOK_PREROUTING | 0 | |
| CHAIN_HOOK_INPUT | 1 | |
| CHAIN_HOOK_FORWARD | 2 | |
| CHAIN_HOOK_OUTPUT | 3 | |
| CHAIN_HOOK_POSTROUTING | 4 |
<a name="talos.resource.definitions.enums.NethelpersNfTablesChainPriority"></a>
NethelpersNfTablesChainPriority wraps nftables.ChainPriority for YAML marshaling.
| Name | Number | Description |
|---|---|---|
| NETHELPERS_NFTABLESCHAINPRIORITY_UNSPECIFIED | 0 | |
| CHAIN_PRIORITY_FIRST | -2147483648 | |
| CHAIN_PRIORITY_CONNTRACK_DEFRAG | -400 | |
| CHAIN_PRIORITY_RAW | -300 | |
| CHAIN_PRIORITY_SE_LINUX_FIRST | -225 | |
| CHAIN_PRIORITY_CONNTRACK | -200 | |
| CHAIN_PRIORITY_MANGLE | -150 | |
| CHAIN_PRIORITY_NAT_DEST | -100 | |
| CHAIN_PRIORITY_FILTER | 0 | |
| CHAIN_PRIORITY_SECURITY | 50 | |
| CHAIN_PRIORITY_NAT_SOURCE | 100 | |
| CHAIN_PRIORITY_SE_LINUX_LAST | 225 | |
| CHAIN_PRIORITY_CONNTRACK_HELPER | 300 | |
| CHAIN_PRIORITY_LAST | 2147483647 |
<a name="talos.resource.definitions.enums.NethelpersNfTablesVerdict"></a>
NethelpersNfTablesVerdict wraps nftables.Verdict for YAML marshaling.
| Name | Number | Description |
|---|---|---|
| VERDICT_DROP | 0 | |
| VERDICT_ACCEPT | 1 |
<a name="talos.resource.definitions.enums.NethelpersOperationalState"></a>
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 |
<a name="talos.resource.definitions.enums.NethelpersPort"></a>
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 |
<a name="talos.resource.definitions.enums.NethelpersPrimaryReselect"></a>
NethelpersPrimaryReselect is an ARP targets mode.
| Name | Number | Description |
|---|---|---|
| PRIMARY_RESELECT_ALWAYS | 0 | |
| PRIMARY_RESELECT_BETTER | 1 | |
| PRIMARY_RESELECT_FAILURE | 2 |
<a name="talos.resource.definitions.enums.NethelpersProtocol"></a>
NethelpersProtocol is a inet protocol.
| Name | Number | Description |
|---|---|---|
| NETHELPERS_PROTOCOL_UNSPECIFIED | 0 | |
| PROTOCOL_ICMP | 1 | |
| PROTOCOL_TCP | 6 | |
| PROTOCOL_UDP | 17 | |
| PROTOCOL_ICM_PV6 | 58 |
<a name="talos.resource.definitions.enums.NethelpersRouteFlag"></a>
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 |
<a name="talos.resource.definitions.enums.NethelpersRouteProtocol"></a>
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 |
<a name="talos.resource.definitions.enums.NethelpersRouteType"></a>
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 |
<a name="talos.resource.definitions.enums.NethelpersRoutingRuleAction"></a>
NethelpersRoutingRuleAction is a routing rule action.
| Name | Number | Description |
|---|---|---|
| ROUTING_RULE_ACTION_UNSPEC | 0 | |
| ROUTING_RULE_ACTION_UNICAST | 1 | |
| ROUTING_RULE_ACTION_BLACKHOLE | 6 | |
| ROUTING_RULE_ACTION_UNREACHABLE | 7 | |
| ROUTING_RULE_ACTION_PROHIBIT | 8 |
<a name="talos.resource.definitions.enums.NethelpersRoutingTable"></a>
NethelpersRoutingTable is a routing table ID.
| Name | Number | Description |
|---|---|---|
| TABLE_UNSPEC | 0 | |
| TABLE1 | 1 | |
| TABLE2 | 2 | |
| TABLE3 | 3 | |
| TABLE4 | 4 | |
| TABLE5 | 5 | |
| TABLE6 | 6 | |
| TABLE7 | 7 | |
| TABLE8 | 8 | |
| TABLE9 | 9 | |
| TABLE10 | 10 | |
| TABLE11 | 11 | |
| TABLE12 | 12 | |
| TABLE13 | 13 | |
| TABLE14 | 14 | |
| TABLE15 | 15 | |
| TABLE16 | 16 | |
| TABLE17 | 17 | |
| TABLE18 | 18 | |
| TABLE19 | 19 | |
| TABLE20 | 20 | |
| TABLE21 | 21 | |
| TABLE22 | 22 | |
| TABLE23 | 23 | |
| TABLE24 | 24 | |
| TABLE25 | 25 | |
| TABLE26 | 26 | |
| TABLE27 | 27 | |
| TABLE28 | 28 | |
| TABLE29 | 29 | |
| TABLE30 | 30 | |
| TABLE31 | 31 | |
| TABLE32 | 32 | |
| TABLE33 | 33 | |
| TABLE34 | 34 | |
| TABLE35 | 35 | |
| TABLE36 | 36 | |
| TABLE37 | 37 | |
| TABLE38 | 38 | |
| TABLE39 | 39 | |
| TABLE40 | 40 | |
| TABLE41 | 41 | |
| TABLE42 | 42 | |
| TABLE43 | 43 | |
| TABLE44 | 44 | |
| TABLE45 | 45 | |
| TABLE46 | 46 | |
| TABLE47 | 47 | |
| TABLE48 | 48 | |
| TABLE49 | 49 | |
| TABLE50 | 50 | |
| TABLE51 | 51 | |
| TABLE52 | 52 | |
| TABLE53 | 53 | |
| TABLE54 | 54 | |
| TABLE55 | 55 | |
| TABLE56 | 56 | |
| TABLE57 | 57 | |
| TABLE58 | 58 | |
| TABLE59 | 59 | |
| TABLE60 | 60 | |
| TABLE61 | 61 | |
| TABLE62 | 62 | |
| TABLE63 | 63 | |
| TABLE64 | 64 | |
| TABLE65 | 65 | |
| TABLE66 | 66 | |
| TABLE67 | 67 | |
| TABLE68 | 68 | |
| TABLE69 | 69 | |
| TABLE70 | 70 | |
| TABLE71 | 71 | |
| TABLE72 | 72 | |
| TABLE73 | 73 | |
| TABLE74 | 74 | |
| TABLE75 | 75 | |
| TABLE76 | 76 | |
| TABLE77 | 77 | |
| TABLE78 | 78 | |
| TABLE79 | 79 | |
| TABLE80 | 80 | |
| TABLE81 | 81 | |
| TABLE82 | 82 | |
| TABLE83 | 83 | |
| TABLE84 | 84 | |
| TABLE85 | 85 | |
| TABLE86 | 86 | |
| TABLE87 | 87 | |
| TABLE88 | 88 | |
| TABLE89 | 89 | |
| TABLE90 | 90 | |
| TABLE91 | 91 | |
| TABLE92 | 92 | |
| TABLE93 | 93 | |
| TABLE94 | 94 | |
| TABLE95 | 95 | |
| TABLE96 | 96 | |
| TABLE97 | 97 | |
| TABLE98 | 98 | |
| TABLE99 | 99 | |
| TABLE100 | 100 | |
| TABLE101 | 101 | |
| TABLE102 | 102 | |
| TABLE103 | 103 | |
| TABLE104 | 104 | |
| TABLE105 | 105 | |
| TABLE106 | 106 | |
| TABLE107 | 107 | |
| TABLE108 | 108 | |
| TABLE109 | 109 | |
| TABLE110 | 110 | |
| TABLE111 | 111 | |
| TABLE112 | 112 | |
| TABLE113 | 113 | |
| TABLE114 | 114 | |
| TABLE115 | 115 | |
| TABLE116 | 116 | |
| TABLE117 | 117 | |
| TABLE118 | 118 | |
| TABLE119 | 119 | |
| TABLE120 | 120 | |
| TABLE121 | 121 | |
| TABLE122 | 122 | |
| TABLE123 | 123 | |
| TABLE124 | 124 | |
| TABLE125 | 125 | |
| TABLE126 | 126 | |
| TABLE127 | 127 | |
| TABLE128 | 128 | |
| TABLE129 | 129 | |
| TABLE130 | 130 | |
| TABLE131 | 131 | |
| TABLE132 | 132 | |
| TABLE133 | 133 | |
| TABLE134 | 134 | |
| TABLE135 | 135 | |
| TABLE136 | 136 | |
| TABLE137 | 137 | |
| TABLE138 | 138 | |
| TABLE139 | 139 | |
| TABLE140 | 140 | |
| TABLE141 | 141 | |
| TABLE142 | 142 | |
| TABLE143 | 143 | |
| TABLE144 | 144 | |
| TABLE145 | 145 | |
| TABLE146 | 146 | |
| TABLE147 | 147 | |
| TABLE148 | 148 | |
| TABLE149 | 149 | |
| TABLE150 | 150 | |
| TABLE151 | 151 | |
| TABLE152 | 152 | |
| TABLE153 | 153 | |
| TABLE154 | 154 | |
| TABLE155 | 155 | |
| TABLE156 | 156 | |
| TABLE157 | 157 | |
| TABLE158 | 158 | |
| TABLE159 | 159 | |
| TABLE160 | 160 | |
| TABLE161 | 161 | |
| TABLE162 | 162 | |
| TABLE163 | 163 | |
| TABLE164 | 164 | |
| TABLE165 | 165 | |
| TABLE166 | 166 | |
| TABLE167 | 167 | |
| TABLE168 | 168 | |
| TABLE169 | 169 | |
| TABLE170 | 170 | |
| TABLE171 | 171 | |
| TABLE172 | 172 | |
| TABLE173 | 173 | |
| TABLE174 | 174 | |
| TABLE175 | 175 | |
| TABLE176 | 176 | |
| TABLE177 | 177 | |
| TABLE178 | 178 | |
| TABLE179 | 179 | |
| TABLE180 | 180 | |
| TABLE181 | 181 | |
| TABLE182 | 182 | |
| TABLE183 | 183 | |
| TABLE184 | 184 | |
| TABLE185 | 185 | |
| TABLE186 | 186 | |
| TABLE187 | 187 | |
| TABLE188 | 188 | |
| TABLE189 | 189 | |
| TABLE190 | 190 | |
| TABLE191 | 191 | |
| TABLE192 | 192 | |
| TABLE193 | 193 | |
| TABLE194 | 194 | |
| TABLE195 | 195 | |
| TABLE196 | 196 | |
| TABLE197 | 197 | |
| TABLE198 | 198 | |
| TABLE199 | 199 | |
| TABLE200 | 200 | |
| TABLE201 | 201 | |
| TABLE202 | 202 | |
| TABLE203 | 203 | |
| TABLE204 | 204 | |
| TABLE205 | 205 | |
| TABLE206 | 206 | |
| TABLE207 | 207 | |
| TABLE208 | 208 | |
| TABLE209 | 209 | |
| TABLE210 | 210 | |
| TABLE211 | 211 | |
| TABLE212 | 212 | |
| TABLE213 | 213 | |
| TABLE214 | 214 | |
| TABLE215 | 215 | |
| TABLE216 | 216 | |
| TABLE217 | 217 | |
| TABLE218 | 218 | |
| TABLE219 | 219 | |
| TABLE220 | 220 | |
| TABLE221 | 221 | |
| TABLE222 | 222 | |
| TABLE223 | 223 | |
| TABLE224 | 224 | |
| TABLE225 | 225 | |
| TABLE226 | 226 | |
| TABLE227 | 227 | |
| TABLE228 | 228 | |
| TABLE229 | 229 | |
| TABLE230 | 230 | |
| TABLE231 | 231 | |
| TABLE232 | 232 | |
| TABLE233 | 233 | |
| TABLE234 | 234 | |
| TABLE235 | 235 | |
| TABLE236 | 236 | |
| TABLE237 | 237 | |
| TABLE238 | 238 | |
| TABLE239 | 239 | |
| TABLE240 | 240 | |
| TABLE241 | 241 | |
| TABLE242 | 242 | |
| TABLE243 | 243 | |
| TABLE244 | 244 | |
| TABLE245 | 245 | |
| TABLE246 | 246 | |
| TABLE247 | 247 | |
| TABLE248 | 248 | |
| TABLE249 | 249 | |
| TABLE250 | 250 | |
| TABLE251 | 251 | |
| TABLE252 | 252 | |
| TABLE_DEFAULT | 253 | |
| TABLE_MAIN | 254 | |
| TABLE_LOCAL | 255 |
<a name="talos.resource.definitions.enums.NethelpersScope"></a>
NethelpersScope is an address scope.
| Name | Number | Description |
|---|---|---|
| SCOPE_GLOBAL | 0 | |
| SCOPE_SITE | 200 | |
| SCOPE_LINK | 253 | |
| SCOPE_HOST | 254 | |
| SCOPE_NOWHERE | 255 |
<a name="talos.resource.definitions.enums.NethelpersVLANProtocol"></a>
NethelpersVLANProtocol is a VLAN protocol.
| Name | Number | Description |
|---|---|---|
| NETHELPERS_VLANPROTOCOL_UNSPECIFIED | 0 | |
| VLAN_PROTOCOL8021_Q | 33024 | |
| VLAN_PROTOCOL8021_AD | 34984 |
<a name="talos.resource.definitions.enums.NethelpersWOLMode"></a>
NethelpersWOLMode wraps ethtool.WOLMode for YAML marshaling.
| Name | Number | Description |
|---|---|---|
| NETHELPERS_WOLMODE_UNSPECIFIED | 0 | |
| WOL_MODE_PHY | 1 | |
| WOL_MODE_UNICAST | 2 | |
| WOL_MODE_MULTICAST | 4 | |
| WOL_MODE_BROADCAST | 8 | |
| WOL_MODE_MAGIC | 32 | |
| WOL_MODE_MAGIC_SECURE | 64 | |
| WOL_MODE_FILTER | 128 |
<a name="talos.resource.definitions.enums.NetworkConfigLayer"></a>
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 |
<a name="talos.resource.definitions.enums.NetworkOperator"></a>
NetworkOperator enumerates Talos network operators.
| Name | Number | Description |
|---|---|---|
| OPERATOR_DHCP4 | 0 | |
| OPERATOR_DHCP6 | 1 | |
| OPERATOR_VIP | 2 |
<a name="talos.resource.definitions.enums.RuntimeFIPSState"></a>
RuntimeFIPSState describes the current FIPS status.
| Name | Number | Description |
|---|---|---|
| FIPS_STATE_DISABLED | 0 | |
| FIPS_STATE_ENABLED | 1 | |
| FIPS_STATE_STRICT | 2 |
<a name="talos.resource.definitions.enums.RuntimeKernelModuleState"></a>
RuntimeKernelModuleState represents the operational state of a kernel module.
| Name | Number | Description |
|---|---|---|
| KERNEL_MODULE_STATE_LIVE | 0 | |
| KERNEL_MODULE_STATE_LOADING | 1 | |
| KERNEL_MODULE_STATE_UNLOADING | 2 | |
| KERNEL_MODULE_STATE_BUILTIN | 3 |
<a name="talos.resource.definitions.enums.RuntimeKernelModuleType"></a>
RuntimeKernelModuleType represents whether a kernel module is built into the kernel or dynamically loaded.
| Name | Number | Description |
|---|---|---|
| KERNEL_MODULE_TYPE_UNKNOWN | 0 | |
| KERNEL_MODULE_TYPE_BUILTIN | 1 | |
| KERNEL_MODULE_TYPE_DYNAMIC | 2 |
<a name="talos.resource.definitions.enums.RuntimeMachineStage"></a>
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 |
<a name="talos.resource.definitions.enums.RuntimeSELinuxState"></a>
RuntimeSELinuxState describes the current SELinux status.
| Name | Number | Description |
|---|---|---|
| SE_LINUX_STATE_DISABLED | 0 | |
| SE_LINUX_STATE_PERMISSIVE | 1 | |
| SE_LINUX_STATE_ENFORCING | 2 |
<a name="talos.resource.definitions.enums.RuntimeUnattendedInstallPhase"></a>
RuntimeUnattendedInstallPhase describes the phase of the unattended install.
| Name | Number | Description |
|---|---|---|
| UNATTENDED_INSTALL_PHASE_PENDING | 0 | |
| UNATTENDED_INSTALL_PHASE_INSTALLING | 1 | |
| UNATTENDED_INSTALL_PHASE_INSTALLED | 2 | |
| UNATTENDED_INSTALL_PHASE_WAITING_FOR_REBOOT | 3 | |
| UNATTENDED_INSTALL_PHASE_FAILED | 4 |
<a name="talos.resource.definitions.enums.StorageLVMLogicalVolumeType"></a>
StorageLVMLogicalVolumeType describes the layout of an LVM logical volume.
| Name | Number | Description |
|---|---|---|
| LVM_LOGICAL_VOLUME_TYPE_LINEAR | 0 | |
| LVM_LOGICAL_VOLUME_TYPE_RAID1 | 1 | |
| LVM_LOGICAL_VOLUME_TYPE_RAID0 | 2 | |
| LVM_LOGICAL_VOLUME_TYPE_RAID10 | 3 |
<a name="talos.resource.definitions.enums.StorageMDArrayPhase"></a>
StorageMDArrayPhase describes the provisioning/sync state of an MD array.
| Name | Number | Description |
|---|---|---|
| MD_ARRAY_PHASE_UNKNOWN | 0 | |
| MD_ARRAY_PHASE_WAITING | 1 | |
| MD_ARRAY_PHASE_REBUILDING | 2 | |
| MD_ARRAY_PHASE_READY | 3 | |
| MD_ARRAY_PHASE_ERROR | 4 |
<a name="talos.resource.definitions.enums.StorageMDLevel"></a>
StorageMDLevel describes the RAID level of an MD (software RAID) array.
| Name | Number | Description |
|---|---|---|
| MD_LEVEL_RAID1 | 0 |
<a name="talos.resource.definitions.enums.StorageMDMetadata"></a>
StorageMDMetadata describes the on-disk metadata format of an MD (software RAID) array.
| Name | Number | Description |
|---|---|---|
| MD_METADATA10 | 0 | |
| MD_METADATA12 | 1 |
<a name="resource/definitions/block/block.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="talos.resource.definitions.block.DeviceSpec"></a>
DeviceSpec is the spec for devices status.
| Field | Type | Label | Description |
|---|---|---|---|
| type | string | ||
| major | int64 | ||
| minor | int64 | ||
| partition_name | string | ||
| partition_number | int64 | ||
| generation | int64 | Generation is bumped every time the device might have changed and might need to be re-probed. | |
| device_path | string | ||
| parent | string | Parent (if set) specifies the parent device ID. | |
| secondaries | string | repeated | Secondaries (if set) specifies the secondary device IDs. |
E.g. for a LVM volume secondary is a list of blockdevices that the volume consists of. |
<a name="talos.resource.definitions.block.DiscoveredVolumeSpec"></a>
DiscoveredVolumeSpec is the spec for DiscoveredVolumes resource.
| Field | Type | Label | Description |
|---|---|---|---|
| size | uint64 | Overall size of the probed device (in bytes). | |
| sector_size | uint64 | Sector size of the device (in bytes). | |
| io_size | uint64 | Optimal I/O size for the device (in bytes). | |
| name | string | ||
| uuid | string | ||
| label | string | ||
| block_size | uint32 | ||
| filesystem_block_size | uint32 | ||
| probed_size | uint64 | ||
| partition_uuid | string | ||
| partition_type | string | ||
| partition_label | string | ||
| partition_index | uint64 | ||
| type | string | ||
| device_path | string | ||
| parent | string | ||
| dev_path | string | ||
| parent_dev_path | string | ||
| pretty_size | string | ||
| offset | uint64 | Offset of the partition/volume inside Parent device (in bytes). |
<a name="talos.resource.definitions.block.DiscoveredVolumesStatusSpec"></a>
DiscoveredVolumesStatusSpec is the spec for discovered volumes status.
| Field | Type | Label | Description |
|---|---|---|---|
| ready | bool | Volume discovery has been completed and the discovered volumes are ready to be used. |
<a name="talos.resource.definitions.block.DiscoveryRefreshRequestSpec"></a>
DiscoveryRefreshRequestSpec is the spec for DiscoveryRefreshRequest.
| Field | Type | Label | Description |
|---|---|---|---|
| request | int64 |
<a name="talos.resource.definitions.block.DiscoveryRefreshStatusSpec"></a>
DiscoveryRefreshStatusSpec is the spec for DiscoveryRefreshStatus status.
| Field | Type | Label | Description |
|---|---|---|---|
| request | int64 |
<a name="talos.resource.definitions.block.DiskSelector"></a>
DiskSelector selects a disk for the volume.
| Field | Type | Label | Description |
|---|---|---|---|
| match | google.api.expr.v1alpha1.CheckedExpr | ||
| external | string |
<a name="talos.resource.definitions.block.DiskSpec"></a>
DiskSpec is the spec for Disks status.
| Field | Type | Label | Description |
|---|---|---|---|
| size | uint64 | ||
| io_size | uint64 | ||
| sector_size | uint64 | ||
| readonly | bool | ||
| model | string | ||
| serial | string | ||
| modalias | string | ||
| wwid | string | ||
| bus_path | string | ||
| sub_system | string | ||
| transport | string | ||
| rotational | bool | ||
| cdrom | bool | ||
| dev_path | string | ||
| pretty_size | string | ||
| secondary_disks | string | repeated | SecondaryDisks (if set) specifies the secondary disk IDs. |
E.g. if the blockdevice secondary is vda5, the secondary disk will be set as vda. This allows to map secondaries between disks ignoring the partitions. | | uuid | string | | | | symlinks | string | repeated | | | firmware_version | string | | |
<a name="talos.resource.definitions.block.EncryptionKey"></a>
EncryptionKey is the spec for volume encryption key.
| Field | Type | Label | Description |
|---|---|---|---|
| slot | int64 | ||
| type | talos.resource.definitions.enums.BlockEncryptionKeyType | ||
| static_passphrase | bytes | Only for Type == "static": | |
| kms_endpoint | string | Only for Type == "kms": | |
| tpm_check_secureboot_status_on_enroll | bool | Only for Type == "tpm": | |
| lock_to_state | bool | ||
| tpmpc_rs | int64 | repeated | Only for Type == "tpm": |
| tpm_pub_key_pc_rs | int64 | repeated | Only for Type == "tpm": |
<a name="talos.resource.definitions.block.EncryptionSpec"></a>
EncryptionSpec is the spec for volume encryption.
| Field | Type | Label | Description |
|---|---|---|---|
| provider | talos.resource.definitions.enums.BlockEncryptionProviderType | ||
| keys | EncryptionKey | repeated | |
| cipher | string | ||
| key_size | uint64 | ||
| block_size | uint64 | ||
| perf_options | string | repeated | |
| allow_discards | bool |
<a name="talos.resource.definitions.block.FSScrubScheduleSpec"></a>
FSScrubScheduleSpec is the spec for FSScrubSchedule resource.
| Field | Type | Label | Description |
|---|---|---|---|
| filesystem | talos.resource.definitions.enums.BlockFilesystemType | Filesystem is the filesystem type of the volume to be scrubbed. | |
| interval | google.protobuf.Duration | Interval is the scrub interval for the volume. | |
| next_scrub | google.protobuf.Timestamp | NextScrub is the next scheduled scrub time for the volume. |
<a name="talos.resource.definitions.block.FSScrubStatusSpec"></a>
FSScrubStatusSpec describes status of filesystem scrub jobs.
| Field | Type | Label | Description |
|---|---|---|---|
| mountpoint | string | ||
| interval | google.protobuf.Duration | ||
| time | google.protobuf.Timestamp | ||
| duration | google.protobuf.Duration | ||
| status | string |
<a name="talos.resource.definitions.block.FilesystemSpec"></a>
FilesystemSpec is the spec for volume filesystem.
| Field | Type | Label | Description |
|---|---|---|---|
| type | talos.resource.definitions.enums.BlockFilesystemType | Filesystem type. | |
| label | string | Filesystem label. | |
| min_allocation_group_size | uint64 | MinAllocationGroupSize is the minimum XFS allocation group size in bytes. |
Zero leaves the mkfs.xfs defaults alone. |
<a name="talos.resource.definitions.block.LocatorSpec"></a>
LocatorSpec is the spec for volume locator.
| Field | Type | Label | Description |
|---|---|---|---|
| match | google.api.expr.v1alpha1.CheckedExpr | Match is a volume locator match expression. | |
| disk_match | google.api.expr.v1alpha1.CheckedExpr | DiskMatch is a disk locator match expression. |
<a name="talos.resource.definitions.block.MountRequestSpec"></a>
MountRequestSpec is the spec for MountRequest.
| Field | Type | Label | Description |
|---|---|---|---|
| volume_id | string | ||
| parent_mount_id | string | ||
| requesters | string | repeated | |
| requester_i_ds | string | repeated | |
| read_only | bool | ||
| detached | bool | ||
| disable_access_time | bool | ||
| secure | bool | ||
| no_exec | bool |
<a name="talos.resource.definitions.block.MountSpec"></a>
MountSpec is the spec for volume mount.
| Field | Type | Label | Description |
|---|---|---|---|
| target_path | string | Mount path for the volume. | |
| selinux_label | string | SELinux label for the volume. | |
| project_quota_support | bool | Enable project quota (xfs) for the volume. | |
| parent_id | string | Parent mount request ID. | |
| file_mode | uint32 | FileMode is the file mode for the mount target. | |
| uid | int64 | UID is the user ID for the mount target. | |
| gid | int64 | GID is the group ID for the mount target. | |
| recursive_relabel | bool | RecursiveRelabel is the recursive relabel/chown flag for the mount target. | |
| bind_target | string | BindTarget is an optional path on the host to bind-mount the volume onto. | |
| parameters | ParameterSpec | repeated | Parameters are additional filesystem mount options used when mounting the volume. |
| secure | bool | Secure applies MOUNT_ATTR_NOSUID|NODEV to the mount. | |
| no_exec | bool | NoExec applies MOUNT_ATTR_NOEXEC to the mount. |
<a name="talos.resource.definitions.block.MountStatusSpec"></a>
MountStatusSpec is the spec for MountStatus.
| Field | Type | Label | Description |
|---|---|---|---|
| spec | MountRequestSpec | ||
| target | string | ||
| source | string | ||
| filesystem | talos.resource.definitions.enums.BlockFilesystemType | ||
| read_only | bool | ||
| project_quota_support | bool | ||
| encryption_provider | talos.resource.definitions.enums.BlockEncryptionProviderType | ||
| detached | bool |
<a name="talos.resource.definitions.block.ParameterSpec"></a>
ParameterSpec is a mount parameter.
| Field | Type | Label | Description |
|---|---|---|---|
| type | talos.resource.definitions.enums.BlockFSParameterType | Type of the parameter. | |
| name | string | Name of the parameter. | |
| string | string | String value of the parameter. | |
| binary | bytes | Binary value of the parameter. |
<a name="talos.resource.definitions.block.PartitionSpec"></a>
PartitionSpec is the spec for volume partitioning.
| Field | Type | Label | Description |
|---|---|---|---|
| min_size | uint64 | Partition minimum size in bytes. | |
| max_size | uint64 | Partition maximum size in bytes, if not set, grows to the maximum size. | |
| grow | bool | Grow the partition automatically to the maximum size. | |
| label | string | Label for the partition. | |
| type_uuid | string | Partition type UUID. | |
| relative_max_size | uint64 | Partition maximum size (relative), if not set, grows to the maximum size. | |
| negative_max_size | bool | NegativeMaxSize indicates that MaxSize or RelativeMaxSize represents space to be left free on the device rather than space to consume. |
<a name="talos.resource.definitions.block.ProvisioningSpec"></a>
ProvisioningSpec is the spec for volume provisioning.
| Field | Type | Label | Description |
|---|---|---|---|
| disk_selector | DiskSelector | DiskSelector selects a disk for the volume. | |
| partition_spec | PartitionSpec | PartitionSpec describes how to provision the volume (partition type). | |
| wave | int64 | Provisioning wave for the volume. |
Waves are processed sequentially - the volumes in the wave are only provisioned after the previous wave is done. | | filesystem_spec | FilesystemSpec | | FilesystemSpec describes how to provision the volume (filesystem type). |
<a name="talos.resource.definitions.block.SwapStatusSpec"></a>
SwapStatusSpec is the spec for SwapStatuss resource.
| Field | Type | Label | Description |
|---|---|---|---|
| device | string | ||
| size_bytes | uint64 | ||
| size_human | string | ||
| used_bytes | uint64 | ||
| used_human | string | ||
| priority | int32 | ||
| type | string |
<a name="talos.resource.definitions.block.SymlinkProvisioningSpec"></a>
SymlinkProvisioningSpec is the spec for volume symlink.
| Field | Type | Label | Description |
|---|---|---|---|
| symlink_target_path | string | Symlink target path for the volume. | |
| force | bool | Force symlink creation. |
<a name="talos.resource.definitions.block.SymlinkSpec"></a>
SymlinkSpec is the spec for Symlinks resource.
| Field | Type | Label | Description |
|---|---|---|---|
| paths | string | repeated |
<a name="talos.resource.definitions.block.SystemDiskSpec"></a>
SystemDiskSpec is the spec for SystemDisks resource.
| Field | Type | Label | Description |
|---|---|---|---|
| disk_id | string | ||
| dev_path | string |
<a name="talos.resource.definitions.block.TPMEncryptionOptionsInfo"></a>
TPMEncryptionOptionsInfo is the options for TPM-based encryption.
| Field | Type | Label | Description |
|---|---|---|---|
| pc_rs | int64 | repeated | |
| pub_key_pc_rs | int64 | repeated |
<a name="talos.resource.definitions.block.UserDiskConfigStatusSpec"></a>
UserDiskConfigStatusSpec is the spec for UserDiskConfigStatus resource.
| Field | Type | Label | Description |
|---|---|---|---|
| ready | bool | ||
| torn_down | bool |
<a name="talos.resource.definitions.block.VolumeConfigSpec"></a>
VolumeConfigSpec is the spec for VolumeConfig resource.
| Field | Type | Label | Description |
|---|---|---|---|
| parent_id | string | Parent volume ID, if set no operations on the volume continue until the parent volume is ready. | |
| type | talos.resource.definitions.enums.BlockVolumeType | Volume type. | |
| provisioning | ProvisioningSpec | Provisioning configuration (how to provision a volume). | |
| locator | LocatorSpec | How to find a volume. | |
| mount | MountSpec | Mount options for the volume. | |
| encryption | EncryptionSpec | Encryption configuration (how to encrypt a volume). | |
| symlink | SymlinkProvisioningSpec | Symlink options for the volume. | |
| trim_enabled | bool | TrimEnabled indicates whether the volume should be trimmed (fstrim) on a schedule. | |
| trim_interval | google.protobuf.Duration | TrimInterval is the resolved interval at which the volume should be trimmed. | |
| scrub_enabled | bool | ScrubEnabled indicates whether the volume filesystem should be scrubbed on a schedule. | |
| scrub_interval | google.protobuf.Duration | ScrubInterval is the resolved period at which the volume filesystem should be scrubbed. |
<a name="talos.resource.definitions.block.VolumeMountRequestSpec"></a>
VolumeMountRequestSpec is the spec for VolumeMountRequest.
| Field | Type | Label | Description |
|---|---|---|---|
| volume_id | string | ||
| requester | string | ||
| read_only | bool | ||
| detached | bool | ||
| disable_access_time | bool | ||
| secure | bool | ||
| no_exec | bool |
<a name="talos.resource.definitions.block.VolumeMountStatusSpec"></a>
VolumeMountStatusSpec is the spec for VolumeMountStatus.
| Field | Type | Label | Description |
|---|---|---|---|
| volume_id | string | ||
| requester | string | ||
| target | string | ||
| read_only | bool | ||
| detached | bool | ||
| disable_access_time | bool | ||
| secure | bool | ||
| no_exec | bool |
<a name="talos.resource.definitions.block.VolumeStatusSpec"></a>
VolumeStatusSpec is the spec for VolumeStatus resource.
| Field | Type | Label | Description |
|---|---|---|---|
| phase | talos.resource.definitions.enums.BlockVolumePhase | ||
| location | string | Location is the path to the block device (raw). | |
| error_message | string | ||
| uuid | string | ||
| partition_uuid | string | ||
| pre_fail_phase | talos.resource.definitions.enums.BlockVolumePhase | ||
| parent_location | string | ParentLocation (if present) is the location of the parent block device for partitions. | |
| partition_index | int64 | ||
| size | uint64 | ||
| filesystem | talos.resource.definitions.enums.BlockFilesystemType | Filesystem is the filesystem type. | |
| mount_location | string | MountLocation is the location to be mounted, might be different from location. | |
| encryption_provider | talos.resource.definitions.enums.BlockEncryptionProviderType | EncryptionProvider is the provider of the encryption which was used to unlock the volume. | |
| pretty_size | string | ||
| encryption_failed_syncs | string | repeated | EncryptionFailedSyncs is the list of failed syncs for the volume (per key/provider). |
| mount_spec | MountSpec | MountSpec is the mount specification. | |
| type | talos.resource.definitions.enums.BlockVolumeType | ||
| configured_encryption_keys | string | repeated | ConfiguredEncryptionKeys is the list of configured encryption keys for the volume. |
| symlink_spec | SymlinkProvisioningSpec | Symlink is the symlink specification. | |
| parent_id | string | ||
| encryption_locked_to_state | bool | EncryptionLockedToState indicates if the encryption is locked to STATE partition | |
| encryption_slot | int64 | EncryptionSlot indicates the currently used encryption slot used for decryption. | |
| tpm_encryption_options | TPMEncryptionOptionsInfo | TPMEncryptionOptions is the options for TPM-based encryption. | |
| encryption_allow_discards | bool | EncryptionAllowDiscards indicates whether the encrypted volume passes discards to the underlying device. | |
| trim_enabled | bool | TrimEnabled indicates whether the volume should be trimmed (fstrim) on a schedule. | |
| trim_interval | google.protobuf.Duration | TrimInterval is the resolved interval at which the volume should be trimmed. | |
| scrub_enabled | bool | ScrubEnabled indicates whether the volume filesystem should be scrubbed on a schedule. | |
| scrub_interval | google.protobuf.Duration | ScrubInterval is the resolved period at which the volume filesystem should be scrubbed. |
<a name="talos.resource.definitions.block.VolumeTrimScheduleSpec"></a>
VolumeTrimScheduleSpec is the spec for VolumeTrimSchedule resource.
| Field | Type | Label | Description |
|---|---|---|---|
| filesystem | talos.resource.definitions.enums.BlockFilesystemType | Filesystem is the filesystem type of the volume to be trimmed. | |
| interval | google.protobuf.Duration | Interval is the trim interval for the volume. | |
| next_trim | google.protobuf.Timestamp | NextTrim is the next scheduled trim time for the volume. |
<a name="talos.resource.definitions.block.ZswapStatusSpec"></a>
ZswapStatusSpec is the spec for ZswapStatus resource.
| Field | Type | Label | Description |
|---|---|---|---|
| total_size_bytes | uint64 | ||
| total_size_human | string | ||
| stored_pages | uint64 | ||
| pool_limit_hit | uint64 | ||
| reject_reclaim_fail | uint64 | ||
| reject_alloc_fail | uint64 | ||
| reject_kmemcache_fail | uint64 | ||
| reject_compress_fail | uint64 | ||
| reject_compress_poor | uint64 | ||
| written_back_pages | uint64 |
<a name="resource/definitions/cluster/cluster.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="talos.resource.definitions.cluster.AffiliateSpec"></a>
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 | ||
| control_plane | ControlPlane |
<a name="talos.resource.definitions.cluster.ConfigSpec"></a>
ConfigSpec describes Discovery configuration.
| Field | Type | Label | Description |
|---|---|---|---|
| discovery_enabled | bool | Deprecated: use ServiceEndpoints instead (configured via DiscoveryServiceConfig documents) | |
| registry_kubernetes_enabled | bool | ||
| registry_service_enabled | bool | Deprecated: enabled via DiscoveryServiceConfig documents instead. | |
| service_endpoint | string | Deprecated: use ServiceEndpoints instead | |
| service_endpoint_insecure | bool | Deprecated: use ServiceEndpoints instead | |
| service_encryption_key | bytes | ||
| service_cluster_id | string | ||
| service_endpoints | ServiceEndpoint | repeated |
<a name="talos.resource.definitions.cluster.ControlPlane"></a>
ControlPlane describes ControlPlane data if any.
| Field | Type | Label | Description |
|---|---|---|---|
| api_server_port | int64 |
<a name="talos.resource.definitions.cluster.IdentitySpec"></a>
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 | NodeID is a random value which is persisted across reboots, but it gets reset on wipe. |
<a name="talos.resource.definitions.cluster.InfoSpec"></a>
InfoSpec describes cluster information.
| Field | Type | Label | Description |
|---|---|---|---|
| cluster_id | string | ||
| cluster_name | string |
<a name="talos.resource.definitions.cluster.KubeSpanAffiliateSpec"></a>
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 | |
| exclude_advertised_networks | common.NetIPPrefix | repeated |
<a name="talos.resource.definitions.cluster.MemberSpec"></a>
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 | ||
| control_plane | ControlPlane |
<a name="talos.resource.definitions.cluster.ServiceEndpoint"></a>
ServiceEndpoint describes a service endpoint for discovery.
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| endpoint | string | ||
| insecure | bool |
<a name="resource/definitions/containers/containers.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="talos.resource.definitions.containers.ContainerDependsOnSpec"></a>
ContainerDependsOnSpec is the resolved dependency set.
| Field | Type | Label | Description |
|---|---|---|---|
| paths | string | repeated | |
| networks | string | repeated | |
| time | bool | ||
| containers | string | repeated |
<a name="talos.resource.definitions.containers.ContainerImageSpec"></a>
ContainerImageSpec is a resolved container image reference.
| Field | Type | Label | Description |
|---|---|---|---|
| ref | string |
<a name="talos.resource.definitions.containers.ContainerImageStatusSpec"></a>
ContainerImageStatusSpec is the spec for ContainerImageStatus.
| Field | Type | Label | Description |
|---|---|---|---|
| phase | talos.resource.definitions.enums.ContainersContainerImagePhase | ||
| image | string | Image is the reference that was requested, in canonical form. | |
| digest | string | Digest is the resolved digest, set once the pull completes. | |
| error | string | Error is the last pull failure, verbatim. |
<a name="talos.resource.definitions.containers.ContainerInstanceSpecSpec"></a>
ContainerInstanceSpecSpec is the spec for ContainerInstanceSpec.
It carries a resolved snapshot of everything needed to run one execution, so whatever runs it never has to re-read the container spec or image status. That keeps the execution independent of later changes to those inputs: a spec change destroys this instance rather than mutating it.
| Field | Type | Label | Description |
|---|---|---|---|
| container_id | string | ContainerID is the name of the owning container, i.e. the ContainerSpec ID. | |
| generation | uint64 | Generation is this instance's sequence number for that container. | |
| image | string | Image is the digest-resolved reference to run. | |
| entrypoint | string | repeated | |
| args | string | repeated | |
| working_dir | string | ||
| run_as | ContainerRunAsSpec | ||
| environment | string | repeated | |
| mounts | ResolvedMountSpec | repeated | Mounts are fully resolved, with host source paths filled in. |
| security | ContainerSecuritySpec | ||
| network | ContainerNetworkSpec | ||
| resources | ContainerResourcesSpec |
<a name="talos.resource.definitions.containers.ContainerInstanceStatusSpec"></a>
ContainerInstanceStatusSpec is the spec for ContainerInstanceStatus.
| Field | Type | Label | Description |
|---|---|---|---|
| container_id | string | ContainerID is the name of the owning container, i.e. the ContainerSpec ID. | |
| generation | uint64 | Generation is the reported instance's sequence number for that container. | |
| phase | talos.resource.definitions.enums.ContainersContainerInstancePhase | Phase is the current execution phase. | |
| pid | uint32 | PID is the task's process ID while running. | |
| exit_code | int32 | ExitCode is the task's exit code, meaningful only once Phase is ContainerInstancePhaseTerminated. | |
| error | string | Error describes why the task never started or exited abnormally. | |
| started_at | google.protobuf.Timestamp | StartedAt is when the task's process started. | |
| finished_at | google.protobuf.Timestamp | FinishedAt is when the task stopped running. |
<a name="talos.resource.definitions.containers.ContainerMountSpec"></a>
ContainerMountSpec is a resolved mount.
Exactly one of VolumeID, Tmpfs or HostPath describes the source; Kind says which.
| Field | Type | Label | Description |
|---|---|---|---|
| kind | string | Kind is one of "userVolume", "tmpfs" or "hostPath". | |
| volume_id | string | VolumeID is the block volume ID for a userVolume mount, e.g. "u-web-content". | |
| source | string | Source is the host path for a hostPath mount. | |
| destination | string | Destination inside the container. | |
| size | uint64 | Size of a tmpfs mount, in bytes; zero means the kernel default. | |
| options | string | repeated | Options with the writable default already applied. |
<a name="talos.resource.definitions.containers.ContainerMountStatusSpec"></a>
ContainerMountStatusSpec is the spec for ContainerMountStatus.
| Field | Type | Label | Description |
|---|---|---|---|
| ready | bool | Ready is true once every mount the container declares is available. | |
| mounts | ResolvedMountSpec | repeated | Mounts are the resolved mounts, with host source paths filled in. Only meaningful when Ready. |
| error | string | Error describes why the mounts are not ready. |
<a name="talos.resource.definitions.containers.ContainerNetworkSpec"></a>
ContainerNetworkSpec is the resolved network configuration.
| Field | Type | Label | Description |
|---|---|---|---|
| host_network | bool | HostNetwork shares the host network namespace instead of creating an empty one. |
<a name="talos.resource.definitions.containers.ContainerResourcesSpec"></a>
ContainerResourcesSpec is the resolved cgroup configuration, in bytes and millicores.
Zero means unset, which for a limit means unlimited.
| Field | Type | Label | Description |
|---|---|---|---|
| memory_limit | uint64 | ||
| cpu_limit | uint64 |
<a name="talos.resource.definitions.containers.ContainerRunAsSpec"></a>
ContainerRunAsSpec is the resolved uid/gid override.
Nil means use the image's own USER for that half.
| Field | Type | Label | Description |
|---|---|---|---|
| uid | int32 | ||
| gid | int32 |
<a name="talos.resource.definitions.containers.ContainerSecuritySpec"></a>
ContainerSecuritySpec is the resolved security posture.
| Field | Type | Label | Description |
|---|---|---|---|
| privileged | bool | Privileged grants all grantable capabilities and all devices, matching what extension services get implicitly. | |
| capabilities_add | string | repeated | |
| capabilities_drop | string | repeated | |
| machined_access | bool | MachinedAccess publishes the container's PID as a ServicePID resource and mounts the machined API socket into the container. |
<a name="talos.resource.definitions.containers.ContainerSpecSpec"></a>
ContainerSpecSpec is the spec for ContainerSpec.
| Field | Type | Label | Description |
|---|---|---|---|
| image | ContainerImageSpec | Image is the OCI reference in canonical form, already normalized by ContainerConfigController. | |
| entrypoint | string | repeated | |
| args | string | repeated | |
| working_dir | string | ||
| run_as | ContainerRunAsSpec | ||
| environment | string | repeated | |
| mounts | ContainerMountSpec | repeated | |
| security | ContainerSecuritySpec | ||
| network | ContainerNetworkSpec | ||
| resources | ContainerResourcesSpec | ||
| depends_on | ContainerDependsOnSpec |
<a name="talos.resource.definitions.containers.ResolvedMountSpec"></a>
ResolvedMountSpec is a mount with its host-side source resolved.
| Field | Type | Label | Description |
|---|---|---|---|
| kind | string | ||
| source | string | Source is the host path to bind from; empty for tmpfs and userVolume. | |
| destination | string | ||
| size | uint64 | ||
| options | string | repeated | |
| volume_id | string | VolumeID is the resolved userVolume's ID; empty for tmpfs and hostPath. |
<a name="resource/definitions/cri/cri.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="talos.resource.definitions.cri.BaseRuntimeSpecConfigSpec"></a>
BaseRuntimeSpecConfigSpec describes an OCI runtime spec configuration source.
| Field | Type | Label | Description |
|---|---|---|---|
| object | google.protobuf.Struct |
<a name="talos.resource.definitions.cri.CustomizationConfigSpec"></a>
CustomizationConfigSpec describes one CRI customization fragment.
| Field | Type | Label | Description |
|---|---|---|---|
| content | string |
<a name="talos.resource.definitions.cri.ImageCacheConfigSpec"></a>
ImageCacheConfigSpec represents the ImageCacheConfig.
| Field | Type | Label | Description |
|---|---|---|---|
| status | talos.resource.definitions.enums.CriImageCacheStatus | ||
| roots | string | repeated | |
| copy_status | talos.resource.definitions.enums.CriImageCacheCopyStatus |
<a name="talos.resource.definitions.cri.RegistriesConfigSpec"></a>
RegistriesConfigSpec describes status of rendered secrets.
| Field | Type | Label | Description |
|---|---|---|---|
| registry_mirrors | RegistriesConfigSpec.RegistryMirrorsEntry | repeated | |
| registry_auths | RegistriesConfigSpec.RegistryAuthsEntry | repeated | |
| registry_tl_ss | RegistriesConfigSpec.RegistryTlSsEntry | repeated |
<a name="talos.resource.definitions.cri.RegistriesConfigSpec.RegistryAuthsEntry"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | RegistryAuthConfig |
<a name="talos.resource.definitions.cri.RegistriesConfigSpec.RegistryMirrorsEntry"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | RegistryMirrorConfig |
<a name="talos.resource.definitions.cri.RegistriesConfigSpec.RegistryTlSsEntry"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | RegistryTLSConfig |
<a name="talos.resource.definitions.cri.RegistryAuthConfig"></a>
RegistryAuthConfig specifies authentication configuration for a registry.
| Field | Type | Label | Description |
|---|---|---|---|
| registry_username | string | ||
| registry_password | string | ||
| registry_auth | string | ||
| registry_identity_token | string |
<a name="talos.resource.definitions.cri.RegistryEndpointConfig"></a>
RegistryEndpointConfig represents a single registry endpoint.
| Field | Type | Label | Description |
|---|---|---|---|
| endpoint_endpoint | string | ||
| endpoint_override_path | bool |
<a name="talos.resource.definitions.cri.RegistryMirrorConfig"></a>
RegistryMirrorConfig represents mirror configuration for a registry.
| Field | Type | Label | Description |
|---|---|---|---|
| mirror_endpoints | RegistryEndpointConfig | repeated | |
| mirror_skip_fallback | bool |
<a name="talos.resource.definitions.cri.RegistryTLSConfig"></a>
RegistryTLSConfig specifies TLS config for HTTPS registries.
| Field | Type | Label | Description |
|---|---|---|---|
| tls_client_identity | common.PEMEncodedCertificateAndKey | ||
| tlsca | bytes | ||
| tls_insecure_skip_verify | bool |
<a name="talos.resource.definitions.cri.SeccompProfileSpec"></a>
SeccompProfileSpec represents the SeccompProfile.
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| value | google.protobuf.Struct |
<a name="resource/definitions/etcd/etcd.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="talos.resource.definitions.etcd.ArgValues"></a>
ArgValues represents values for a command line argument which can be specified multiple times.
| Field | Type | Label | Description |
|---|---|---|---|
| values | string | repeated |
<a name="talos.resource.definitions.etcd.ConfigSpec"></a>
ConfigSpec describes (some) configuration settings of etcd.
| Field | Type | Label | Description |
|---|---|---|---|
| advertise_valid_subnets | string | repeated | |
| advertise_exclude_subnets | string | repeated | |
| image | string | ||
| listen_valid_subnets | string | repeated | |
| listen_exclude_subnets | string | repeated | |
| extra_args | ConfigSpec.ExtraArgsEntry | repeated |
<a name="talos.resource.definitions.etcd.ConfigSpec.ExtraArgsEntry"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | ArgValues |
<a name="talos.resource.definitions.etcd.MemberSpec"></a>
MemberSpec holds information about an etcd member.
| Field | Type | Label | Description |
|---|---|---|---|
| member_id | string |
<a name="talos.resource.definitions.etcd.PKIStatusSpec"></a>
PKIStatusSpec describes status of rendered secrets.
| Field | Type | Label | Description |
|---|---|---|---|
| ready | bool | ||
| version | string |
<a name="talos.resource.definitions.etcd.SpecSpec"></a>
SpecSpec describes (some) Specuration settings of etcd.
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| advertised_addresses | common.NetIP | repeated | |
| image | string | ||
| listen_peer_addresses | common.NetIP | repeated | |
| listen_client_addresses | common.NetIP | repeated | |
| extra_args | SpecSpec.ExtraArgsEntry | repeated |
<a name="talos.resource.definitions.etcd.SpecSpec.ExtraArgsEntry"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | ArgValues |
<a name="resource/definitions/extensions/extensions.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="talos.resource.definitions.extensions.Compatibility"></a>
Compatibility describes extension compatibility.
| Field | Type | Label | Description |
|---|---|---|---|
| talos | Constraint |
<a name="talos.resource.definitions.extensions.Constraint"></a>
Constraint describes compatibility constraint.
| Field | Type | Label | Description |
|---|---|---|---|
| version | string |
<a name="talos.resource.definitions.extensions.Layer"></a>
Layer defines overlay mount layer.
| Field | Type | Label | Description |
|---|---|---|---|
| image | string | ||
| metadata | Metadata |
<a name="talos.resource.definitions.extensions.Metadata"></a>
Metadata describes base extension metadata.
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| version | string | ||
| author | string | ||
| description | string | ||
| compatibility | Compatibility | ||
| extra_info | string |
<a name="resource/definitions/files/files.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="talos.resource.definitions.files.EtcFileSpecSpec"></a>
EtcFileSpecSpec describes status of rendered secrets.
| Field | Type | Label | Description |
|---|---|---|---|
| contents | bytes | ||
| mode | uint32 | ||
| selinux_label | string |
<a name="talos.resource.definitions.files.EtcFileStatusSpec"></a>
EtcFileStatusSpec describes status of rendered secrets.
| Field | Type | Label | Description |
|---|---|---|---|
| spec_version | string |
<a name="resource/definitions/hardware/hardware.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="talos.resource.definitions.hardware.CPUCoreSpec"></a>
CPUCoreSpec represents a single CPU core as seen by the Linux kernel.
| Field | Type | Label | Description |
|---|---|---|---|
| socket | string | Socket is the physical package (socket) identifier the core belongs to. | |
| core_id | string | CoreID is the core identifier within the socket. | |
| logical_cp_us | uint32 | repeated | LogicalCPUs is the sorted list of logical CPU (hardware thread) numbers belonging to this core. |
| vendor_id | string | VendorID is the CPU vendor identifier (e.g. GenuineIntel, AuthenticAMD). | |
| cpu_family | string | CPUFamily is the CPU family. | |
| model | string | Model is the CPU model number. | |
| model_name | string | ModelName is the human-readable CPU model name. | |
| stepping | string | Stepping is the CPU stepping. | |
| microcode | string | Microcode is the microcode revision. | |
| cache_size | string | CacheSize is the CPU cache size as reported by the kernel (e.g. 512 KB). | |
| cores_per_socket | uint32 | CoresPerSocket is the number of cores in the socket this core belongs to. | |
| threads_per_socket | uint32 | ThreadsPerSocket is the number of logical CPUs (siblings) in the socket this core belongs to. | |
| flags | string | repeated | Flags is the list of CPU feature flags. |
| bugs | string | repeated | Bugs is the list of known CPU bugs. |
| bogo_mips | double | BogoMips is the kernel BogoMips measurement for the core. | |
| address_sizes | string | AddressSizes describes the physical and virtual address sizes. |
<a name="talos.resource.definitions.hardware.MemoryModuleSpec"></a>
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 |
<a name="talos.resource.definitions.hardware.PCIDeviceSpec"></a>
PCIDeviceSpec represents a single processor.
| Field | Type | Label | Description |
|---|---|---|---|
| class | string | ||
| subclass | string | ||
| vendor | string | ||
| product | string | ||
| class_id | string | ||
| subclass_id | string | ||
| vendor_id | string | ||
| product_id | string | ||
| driver | string |
<a name="talos.resource.definitions.hardware.PCIDriverRebindConfigSpec"></a>
PCIDriverRebindConfigSpec describes PCI rebind configuration.
| Field | Type | Label | Description |
|---|---|---|---|
| pciid | string | ||
| target_driver | string |
<a name="talos.resource.definitions.hardware.PCIDriverRebindStatusSpec"></a>
PCIDriverRebindStatusSpec describes status of rebinded drivers.
| Field | Type | Label | Description |
|---|---|---|---|
| pciid | string | ||
| target_driver | string |
<a name="talos.resource.definitions.hardware.ProcessorSpec"></a>
ProcessorSpec represents a single processor.
| Field | Type | Label | Description |
|---|---|---|---|
| socket | string | ||
| manufacturer | string | ||
| product_name | string | ||
| max_speed | uint32 | MaxSpeed is in megahertz (MHz). | |
| boot_speed | uint32 | BootSpeed is in megahertz (MHz). | |
| status | uint32 | ||
| serial_number | string | ||
| asset_tag | string | ||
| part_number | string | ||
| core_count | uint32 | ||
| core_enabled | uint32 | ||
| thread_count | uint32 |
<a name="talos.resource.definitions.hardware.SystemInformationSpec"></a>
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 | ||
| bios_version | string |
<a name="resource/definitions/proto/proto.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="talos.resource.definitions.proto.LinuxIDMapping"></a>
LinuxIDMapping specifies UID/GID mappings.
| Field | Type | Label | Description |
|---|---|---|---|
| container_id | uint32 | ||
| host_id | uint32 | ||
| size | uint32 |
<a name="talos.resource.definitions.proto.Mount"></a>
Mount specifies a mount for a container.
| Field | Type | Label | Description |
|---|---|---|---|
| destination | string | ||
| type | string | ||
| source | string | ||
| options | string | repeated | |
| uid_mappings | LinuxIDMapping | repeated | |
| gid_mappings | LinuxIDMapping | repeated |
<a name="resource/definitions/k8s/k8s.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="talos.resource.definitions.k8s.APIServerConfigSpec"></a>
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_volumes | ExtraVolume | repeated | |
| environment_variables | APIServerConfigSpec.EnvironmentVariablesEntry | repeated | |
| advertised_address | string | ||
| resources | Resources | ||
| extra_args | APIServerConfigSpec.ExtraArgsEntry | repeated | |
| startup_probes_enabled | bool | ||
| use_authentication_config | bool | ||
| args | string | repeated |
<a name="talos.resource.definitions.k8s.APIServerConfigSpec.EnvironmentVariablesEntry"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | string |
<a name="talos.resource.definitions.k8s.APIServerConfigSpec.ExtraArgsEntry"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | ArgValues |
<a name="talos.resource.definitions.k8s.AdmissionControlConfigSpec"></a>
AdmissionControlConfigSpec is configuration for kube-apiserver.
| Field | Type | Label | Description |
|---|---|---|---|
| config | AdmissionPluginSpec | repeated |
<a name="talos.resource.definitions.k8s.AdmissionPluginSpec"></a>
AdmissionPluginSpec is a single admission plugin configuration Admission Control plugins.
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| configuration | google.protobuf.Struct |
<a name="talos.resource.definitions.k8s.ArgValues"></a>
ArgValues represents values for a command line argument which can be specified multiple times.
| Field | Type | Label | Description |
|---|---|---|---|
| values | string | repeated |
<a name="talos.resource.definitions.k8s.AuditPolicyConfigSpec"></a>
AuditPolicyConfigSpec is audit policy configuration for kube-apiserver.
| Field | Type | Label | Description |
|---|---|---|---|
| config | google.protobuf.Struct |
<a name="talos.resource.definitions.k8s.AuthenticationConfigSpec"></a>
AuthenticationConfigSpec is authentication configuration for kube-apiserver.
| Field | Type | Label | Description |
|---|---|---|---|
| config | google.protobuf.Struct |
<a name="talos.resource.definitions.k8s.AuthorizationAuthorizersSpec"></a>
AuthorizationAuthorizersSpec is a configuration of authorization authorizers.
| Field | Type | Label | Description |
|---|---|---|---|
| type | string | ||
| name | string | ||
| webhook | google.protobuf.Struct |
<a name="talos.resource.definitions.k8s.AuthorizationConfigSpec"></a>
AuthorizationConfigSpec is authorization configuration for kube-apiserver.
| Field | Type | Label | Description |
|---|---|---|---|
| image | string | ||
| config | AuthorizationAuthorizersSpec | repeated |
<a name="talos.resource.definitions.k8s.BootstrapManifestsConfigSpec"></a>
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 | ||
| pod_security_policy_enabled | bool | ||
| talos_api_service_enabled | bool | ||
| flannel_extra_args | string | repeated | |
| flannel_kube_service_host | string | ||
| flannel_kube_service_port | string | ||
| flannel_kube_network_policies_enabled | bool | ||
| flannel_kube_network_policies_image | string | ||
| cni_name | string | ||
| flannel_backend_mtu | uint32 | ||
| flannel_backend_type | string | ||
| flannel_backend_port | uint32 | ||
| flannel_resources | Resources | ||
| flannel_backend_extra_config | google.protobuf.Struct | ||
| proxy_config | google.protobuf.Struct | ||
| proxy_resources | Resources | ||
| proxy_config_checksum | string |
<a name="talos.resource.definitions.k8s.ConfigStatusSpec"></a>
ConfigStatusSpec describes status of rendered secrets.
| Field | Type | Label | Description |
|---|---|---|---|
| ready | bool | ||
| version | string |
<a name="talos.resource.definitions.k8s.ControllerManagerConfigSpec"></a>
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_volumes | ExtraVolume | repeated | |
| environment_variables | ControllerManagerConfigSpec.EnvironmentVariablesEntry | repeated | |
| resources | Resources | ||
| extra_args | ControllerManagerConfigSpec.ExtraArgsEntry | repeated | |
| args | string | repeated | |
| node_cidr_mask_size_i_pv4 | int64 | ||
| node_cidr_mask_size_i_pv6 | int64 |
<a name="talos.resource.definitions.k8s.ControllerManagerConfigSpec.EnvironmentVariablesEntry"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | string |
<a name="talos.resource.definitions.k8s.ControllerManagerConfigSpec.ExtraArgsEntry"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | ArgValues |
<a name="talos.resource.definitions.k8s.EndpointSpec"></a>
EndpointSpec describes a list of endpoints to connect to.
| Field | Type | Label | Description |
|---|---|---|---|
| addresses | common.NetIP | repeated | |
| hosts | string | repeated |
<a name="talos.resource.definitions.k8s.EtcdEncryptionConfigSpec"></a>
EtcdEncryptionConfigSpec describes root Kubernetes secrets.
| Field | Type | Label | Description |
|---|---|---|---|
| configuration | string |
<a name="talos.resource.definitions.k8s.ExtraManifest"></a>
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 |
<a name="talos.resource.definitions.k8s.ExtraManifest.ExtraHeadersEntry"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | string |
<a name="talos.resource.definitions.k8s.ExtraManifestsConfigSpec"></a>
ExtraManifestsConfigSpec is configuration for extra bootstrap manifests.
| Field | Type | Label | Description |
|---|---|---|---|
| extra_manifests | ExtraManifest | repeated |
<a name="talos.resource.definitions.k8s.ExtraVolume"></a>
ExtraVolume is a configuration of extra volume.
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| host_path | string | ||
| mount_path | string | ||
| read_only | bool |
<a name="talos.resource.definitions.k8s.KubePrismConfigSpec"></a>
KubePrismConfigSpec describes KubePrismConfig data.
| Field | Type | Label | Description |
|---|---|---|---|
| host | string | ||
| port | int64 | ||
| endpoints | KubePrismEndpoint | repeated |
<a name="talos.resource.definitions.k8s.KubePrismEndpoint"></a>
KubePrismEndpoint holds data for control plane endpoint.
| Field | Type | Label | Description |
|---|---|---|---|
| host | string | ||
| port | uint32 |
<a name="talos.resource.definitions.k8s.KubePrismEndpointsSpec"></a>
KubePrismEndpointsSpec describes KubePrismEndpoints configuration.
| Field | Type | Label | Description |
|---|---|---|---|
| endpoints | KubePrismEndpoint | repeated |
<a name="talos.resource.definitions.k8s.KubePrismStatusesSpec"></a>
KubePrismStatusesSpec describes KubePrismStatuses data.
| Field | Type | Label | Description |
|---|---|---|---|
| host | string | ||
| healthy | bool |
<a name="talos.resource.definitions.k8s.KubeletConfigSpec"></a>
KubeletConfigSpec holds the source of kubelet configuration.
| Field | Type | Label | Description |
|---|---|---|---|
| image | string | ||
| cluster_dns | string | repeated | |
| cluster_domain | string | ||
| 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 | ||
| enable_fs_quota_monitoring | bool | ||
| credential_provider_config | google.protobuf.Struct | ||
| extra_args | KubeletConfigSpec.ExtraArgsEntry | repeated | |
| register_with_taints | KubeletConfigSpec.RegisterWithTaintsEntry | repeated |
<a name="talos.resource.definitions.k8s.KubeletConfigSpec.ExtraArgsEntry"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | ArgValues |
<a name="talos.resource.definitions.k8s.KubeletConfigSpec.RegisterWithTaintsEntry"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | string |
<a name="talos.resource.definitions.k8s.KubeletKubeconfigSpec"></a>
KubeletKubeconfigSpec describes the current kubelet kubeconfig file.
| Field | Type | Label | Description |
|---|---|---|---|
| hash | string | Hash is a content digest of the kubeconfig file. It changes whenever the file contents change, which is the signal consumers use to rebuild their Kubernetes clients. |
<a name="talos.resource.definitions.k8s.KubeletSpecSpec"></a>
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 | ||
| credential_provider_config | google.protobuf.Struct |
<a name="talos.resource.definitions.k8s.KubeletStatusSpec"></a>
KubeletStatusSpec describes the current kubelet state.
| Field | Type | Label | Description |
|---|---|---|---|
| image | string | Image is the kubelet image reference. |
<a name="talos.resource.definitions.k8s.ManifestSpec"></a>
ManifestSpec holds the Kubernetes resources spec.
| Field | Type | Label | Description |
|---|---|---|---|
| items | SingleManifest | repeated |
<a name="talos.resource.definitions.k8s.ManifestStatusSpec"></a>
ManifestStatusSpec describes manifest application status.
| Field | Type | Label | Description |
|---|---|---|---|
| manifests_applied | string | repeated |
<a name="talos.resource.definitions.k8s.NodeAnnotationSpecSpec"></a>
NodeAnnotationSpecSpec represents an annoation that's attached to a Talos node.
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | string |
<a name="talos.resource.definitions.k8s.NodeIPConfigSpec"></a>
NodeIPConfigSpec holds the Node IP specification.
| Field | Type | Label | Description |
|---|---|---|---|
| valid_subnets | string | repeated | |
| exclude_subnets | string | repeated |
<a name="talos.resource.definitions.k8s.NodeIPSpec"></a>
NodeIPSpec holds the Node IP specification.
| Field | Type | Label | Description |
|---|---|---|---|
| addresses | common.NetIP | repeated |
<a name="talos.resource.definitions.k8s.NodeLabelSpecSpec"></a>
NodeLabelSpecSpec represents a label that's attached to a Talos node.
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | string |
<a name="talos.resource.definitions.k8s.NodeStatusSpec"></a>
NodeStatusSpec describes Kubernetes NodeStatus.
| Field | Type | Label | Description |
|---|---|---|---|
| nodename | string | ||
| node_ready | bool | ||
| unschedulable | bool | ||
| labels | NodeStatusSpec.LabelsEntry | repeated | |
| annotations | NodeStatusSpec.AnnotationsEntry | repeated | |
| pod_cid_rs | common.NetIPPrefix | repeated |
<a name="talos.resource.definitions.k8s.NodeStatusSpec.AnnotationsEntry"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | string |
<a name="talos.resource.definitions.k8s.NodeStatusSpec.LabelsEntry"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | string |
<a name="talos.resource.definitions.k8s.NodeTaintSpecSpec"></a>
NodeTaintSpecSpec represents a label that's attached to a Talos node.
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| effect | string | ||
| value | string |
<a name="talos.resource.definitions.k8s.NodenameSpec"></a>
NodenameSpec describes Kubernetes nodename.
| Field | Type | Label | Description |
|---|---|---|---|
| nodename | string | ||
| hostname_version | string | ||
| skip_node_registration | bool |
<a name="talos.resource.definitions.k8s.Resources"></a>
Resources is a configuration of cpu and memory resources.
| Field | Type | Label | Description |
|---|---|---|---|
| requests | Resources.RequestsEntry | repeated | |
| limits | Resources.LimitsEntry | repeated |
<a name="talos.resource.definitions.k8s.Resources.LimitsEntry"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | string |
<a name="talos.resource.definitions.k8s.Resources.RequestsEntry"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | string |
<a name="talos.resource.definitions.k8s.SchedulerConfigSpec"></a>
SchedulerConfigSpec is configuration for kube-scheduler.
| Field | Type | Label | Description |
|---|---|---|---|
| enabled | bool | ||
| image | string | ||
| extra_volumes | ExtraVolume | repeated | |
| environment_variables | SchedulerConfigSpec.EnvironmentVariablesEntry | repeated | |
| resources | Resources | ||
| config | google.protobuf.Struct | ||
| extra_args | SchedulerConfigSpec.ExtraArgsEntry | repeated | |
| args | string | repeated |
<a name="talos.resource.definitions.k8s.SchedulerConfigSpec.EnvironmentVariablesEntry"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | string |
<a name="talos.resource.definitions.k8s.SchedulerConfigSpec.ExtraArgsEntry"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | ArgValues |
<a name="talos.resource.definitions.k8s.SecretsStatusSpec"></a>
SecretsStatusSpec describes status of rendered secrets.
| Field | Type | Label | Description |
|---|---|---|---|
| ready | bool | ||
| version | string |
<a name="talos.resource.definitions.k8s.SingleManifest"></a>
SingleManifest is a single manifest.
| Field | Type | Label | Description |
|---|---|---|---|
| object | google.protobuf.Struct |
<a name="talos.resource.definitions.k8s.StaticPodServerStatusSpec"></a>
StaticPodServerStatusSpec describes static pod spec, it contains marshaled *v1.Pod spec.
| Field | Type | Label | Description |
|---|---|---|---|
| url | string |
<a name="talos.resource.definitions.k8s.StaticPodSpec"></a>
StaticPodSpec describes static pod spec, it contains marshaled *v1.Pod spec.
| Field | Type | Label | Description |
|---|---|---|---|
| pod | google.protobuf.Struct |
<a name="talos.resource.definitions.k8s.StaticPodStatusSpec"></a>
StaticPodStatusSpec describes kubelet static pod status.
| Field | Type | Label | Description |
|---|---|---|---|
| pod_status | google.protobuf.Struct |
<a name="resource/definitions/kubeaccess/kubeaccess.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="talos.resource.definitions.kubeaccess.ConfigSpec"></a>
ConfigSpec describes KubeSpan configuration..
| Field | Type | Label | Description |
|---|---|---|---|
| enabled | bool | ||
| allowed_api_roles | string | repeated | |
| allowed_kubernetes_namespaces | string | repeated |
<a name="resource/definitions/kubespan/kubespan.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="talos.resource.definitions.kubespan.ConfigSpec"></a>
ConfigSpec describes KubeSpan configuration..
| Field | Type | Label | Description |
|---|---|---|---|
| enabled | bool | ||
| cluster_id | string | ||
| shared_secret | string | ||
| force_routing | bool | Force routing via KubeSpan even if the peer connection is not up. | |
| advertise_kubernetes_networks | bool | Advertise Kubernetes pod networks or skip it completely. | |
| mtu | uint32 | Force kubeSpan MTU size. | |
| endpoint_filters | string | repeated | If not empty, filter advertised endpoints using the list of CIDRs. |
| harvest_extra_endpoints | bool | Harvest endpoints from the peer statuses. | |
| extra_endpoints | common.NetIPPort | repeated | Extra endpoints to announce. |
| exclude_advertised_networks | common.NetIPPrefix | repeated | If not empty, filter advertised networks using the list of CIDRs. |
<a name="talos.resource.definitions.kubespan.EndpointSpec"></a>
EndpointSpec describes Endpoint state.
| Field | Type | Label | Description |
|---|---|---|---|
| affiliate_id | string | ||
| endpoint | common.NetIPPort |
<a name="talos.resource.definitions.kubespan.IdentitySpec"></a>
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 | Address of the node on the Wireguard network. | |
| subnet | common.NetIPPrefix | ||
| private_key | string | Public and private Wireguard keys. | |
| public_key | string |
<a name="talos.resource.definitions.kubespan.PeerSpecSpec"></a>
PeerSpecSpec describes PeerSpec state.
| Field | Type | Label | Description |
|---|---|---|---|
| address | common.NetIP | ||
| allowed_ips | common.NetIPPrefix | repeated | |
| endpoints | common.NetIPPort | repeated | |
| label | string |
<a name="talos.resource.definitions.kubespan.PeerStatusSpec"></a>
PeerStatusSpec describes PeerStatus state.
| Field | Type | Label | Description |
|---|---|---|---|
| endpoint | common.NetIPPort | Active endpoint as seen by the Wireguard. | |
| label | string | Label derived from the peer spec. | |
| state | talos.resource.definitions.enums.KubespanPeerState | Calculated state. | |
| receive_bytes | int64 | Tx/Rx bytes. | |
| transmit_bytes | int64 | ||
| last_handshake_time | google.protobuf.Timestamp | Handshake. | |
| last_used_endpoint | common.NetIPPort | Endpoint selection input. | |
| last_endpoint_change | google.protobuf.Timestamp |
<a name="resource/definitions/runtime/runtime.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="talos.resource.definitions.runtime.APIServiceConfigSpec"></a>
APIServiceConfigSpec describes configuration for Talos API service (apid).
| Field | Type | Label | Description |
|---|---|---|---|
| listen_address | string | ||
| node_routing_disabled | bool | ||
| readonly_role_mode | bool | ||
| skip_verifying_client_cert | bool |
<a name="talos.resource.definitions.runtime.BootIDSpec"></a>
BootIDSpec presents the kernel boot ID (contents of /proc/sys/kernel/random/boot_id).
| Field | Type | Label | Description |
|---|---|---|---|
| boot_id | string |
<a name="talos.resource.definitions.runtime.BootedEntrySpec"></a>
BootedEntrySpec describes the booted entry resource properties.
| Field | Type | Label | Description |
|---|---|---|---|
| booted_entry | string |
<a name="talos.resource.definitions.runtime.DevicesStatusSpec"></a>
DevicesStatusSpec is the spec for devices status.
| Field | Type | Label | Description |
|---|---|---|---|
| ready | bool | Devices are settled down and ready to be used. |
<a name="talos.resource.definitions.runtime.DiagnosticSpec"></a>
DiagnosticSpec is the spec for devices status.
| Field | Type | Label | Description |
|---|---|---|---|
| message | string | Short message describing the problem. | |
| details | string | repeated | Details about the problem. |
<a name="talos.resource.definitions.runtime.EnvironmentSpec"></a>
EnvironmentSpec describes the specification of Environment resource.
| Field | Type | Label | Description |
|---|---|---|---|
| variables | string | repeated |
<a name="talos.resource.definitions.runtime.EventSinkConfigSpec"></a>
EventSinkConfigSpec describes configuration of Talos event log streaming.
| Field | Type | Label | Description |
|---|---|---|---|
| endpoint | string |
<a name="talos.resource.definitions.runtime.ExtensionServiceConfigFile"></a>
ExtensionServiceConfigFile describes extensions service config files.
| Field | Type | Label | Description |
|---|---|---|---|
| content | string | ||
| mount_path | string |
<a name="talos.resource.definitions.runtime.ExtensionServiceConfigSpec"></a>
ExtensionServiceConfigSpec describes status of rendered extensions service config files.
| Field | Type | Label | Description |
|---|---|---|---|
| files | ExtensionServiceConfigFile | repeated | |
| environment | string | repeated |
<a name="talos.resource.definitions.runtime.ExtensionServiceConfigStatusSpec"></a>
ExtensionServiceConfigStatusSpec describes status of rendered extensions service config files.
| Field | Type | Label | Description |
|---|---|---|---|
| spec_version | string |
<a name="talos.resource.definitions.runtime.ImageFactorySchematicSpec"></a>
ImageFactorySchematicSpec describes Image Factory schematic information.
| Field | Type | Label | Description |
|---|---|---|---|
| schematic_id | string | ||
| flavor | string | ||
| apiurl | string |
<a name="talos.resource.definitions.runtime.KernelCmdlineSpec"></a>
KernelCmdlineSpec presents kernel command line (contents of /proc/cmdline).
| Field | Type | Label | Description |
|---|---|---|---|
| cmdline | string |
<a name="talos.resource.definitions.runtime.KernelModuleSpecSpec"></a>
KernelModuleSpecSpec describes Linux kernel module to load.
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| parameters | string | repeated |
<a name="talos.resource.definitions.runtime.KernelModuleStatusSpec"></a>
KernelModuleStatusSpec represents the status of a Linux kernel module.
| Field | Type | Label | Description |
|---|---|---|---|
| type | talos.resource.definitions.enums.RuntimeKernelModuleType | Type indicates whether the kernel module is built-in or dynamically loaded. | |
| size | int64 | Size is the size of the kernel module in bytes. | |
| reference_count | int64 | ReferenceCount is the number of references to this kernel module. | |
| dependencies | string | repeated | Dependencies lists the names of kernel modules that this module depends on. |
| state | talos.resource.definitions.enums.RuntimeKernelModuleState | State is the operational state of the kernel module. | |
| address | string | Address is the memory address where the kernel module is loaded (if applicable). |
<a name="talos.resource.definitions.runtime.KernelParamSpecSpec"></a>
KernelParamSpecSpec describes status of the defined sysctls.
| Field | Type | Label | Description |
|---|---|---|---|
| value | string | ||
| ignore_errors | bool |
<a name="talos.resource.definitions.runtime.KernelParamStatusSpec"></a>
KernelParamStatusSpec describes status of the defined sysctls.
| Field | Type | Label | Description |
|---|---|---|---|
| current | string | ||
| default | string | ||
| unsupported | bool |
<a name="talos.resource.definitions.runtime.KmsgLogConfigSpec"></a>
KmsgLogConfigSpec describes configuration for kmsg log streaming.
| Field | Type | Label | Description |
|---|---|---|---|
| destinations | common.URL | repeated |
<a name="talos.resource.definitions.runtime.MachineStatusSpec"></a>
MachineStatusSpec describes status of the defined sysctls.
| Field | Type | Label | Description |
|---|---|---|---|
| stage | talos.resource.definitions.enums.RuntimeMachineStage | ||
| status | MachineStatusStatus |
<a name="talos.resource.definitions.runtime.MachineStatusStatus"></a>
MachineStatusStatus describes machine current status at the stage.
| Field | Type | Label | Description |
|---|---|---|---|
| ready | bool | ||
| unmet_conditions | UnmetCondition | repeated |
<a name="talos.resource.definitions.runtime.MaintenanceServiceConfigSpec"></a>
MaintenanceServiceConfigSpec describes configuration for maintenance service API.
| Field | Type | Label | Description |
|---|---|---|---|
| listen_address | string | ||
| reachable_addresses | common.NetIP | repeated |
<a name="talos.resource.definitions.runtime.MetaKeySpec"></a>
MetaKeySpec describes status of the defined sysctls.
| Field | Type | Label | Description |
|---|---|---|---|
| value | string |
<a name="talos.resource.definitions.runtime.MetaLoadedSpec"></a>
MetaLoadedSpec is the spec for meta loaded. The Done field is always true when resource exists.
| Field | Type | Label | Description |
|---|---|---|---|
| done | bool |
<a name="talos.resource.definitions.runtime.MountStatusSpec"></a>
MountStatusSpec describes status of the defined sysctls.
| Field | Type | Label | Description |
|---|---|---|---|
| source | string | ||
| target | string | ||
| filesystem_type | string | ||
| options | string | repeated | |
| encrypted | bool | ||
| encryption_providers | string | repeated |
<a name="talos.resource.definitions.runtime.OOMActionSpec"></a>
OOMActionSpec describes the OOM action record resource properties.
| Field | Type | Label | Description |
|---|---|---|---|
| trigger_context | string | ||
| score | double | ||
| processes | string | repeated |
<a name="talos.resource.definitions.runtime.PlatformMetadataSpec"></a>
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 | ||
| internal_dns | string | ||
| external_dns | string | ||
| tags | PlatformMetadataSpec.TagsEntry | repeated |
<a name="talos.resource.definitions.runtime.PlatformMetadataSpec.TagsEntry"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | string |
<a name="talos.resource.definitions.runtime.SBOMItemSpec"></a>
SBOMItemSpec describes the SBOM item resource properties.
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| version | string | ||
| license | string | ||
| cp_es | string | repeated | |
| pur_ls | string | repeated | |
| extension | bool |
<a name="talos.resource.definitions.runtime.SecurityStateSpec"></a>
SecurityStateSpec describes the security state resource properties.
| Field | Type | Label | Description |
|---|---|---|---|
| secure_boot | bool | ||
| uki_signing_key_fingerprint | string | ||
| pcr_signing_key_fingerprint | string | ||
| se_linux_state | talos.resource.definitions.enums.RuntimeSELinuxState | ||
| booted_with_uki | bool | ||
| fips_state | talos.resource.definitions.enums.RuntimeFIPSState | ||
| module_signature_enforced | bool |
<a name="talos.resource.definitions.runtime.ServicePIDSpec"></a>
ServicePIDSpec is the spec for the service PID.
| Field | Type | Label | Description |
|---|---|---|---|
| pid | int32 | PID is the host PID of the service. | |
| mount_namespace | string | MountNamespace is the mount namespace of the service. |
<a name="talos.resource.definitions.runtime.UnattendedInstallStatusSpec"></a>
UnattendedInstallStatusSpec describes the unattended install status.
| Field | Type | Label | Description |
|---|---|---|---|
| image | string | ||
| phase | talos.resource.definitions.enums.RuntimeUnattendedInstallPhase | ||
| error | string |
<a name="talos.resource.definitions.runtime.UniqueMachineTokenSpec"></a>
UniqueMachineTokenSpec is the spec for the machine unique token. Token can be empty if machine wasn't assigned any.
| Field | Type | Label | Description |
|---|---|---|---|
| token | string |
<a name="talos.resource.definitions.runtime.UnmetCondition"></a>
UnmetCondition is a failure which prevents machine from being ready at the stage.
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| reason | string |
<a name="talos.resource.definitions.runtime.VersionSpec"></a>
VersionSpec describes version of Talos.
| Field | Type | Label | Description |
|---|---|---|---|
| version | string | ||
| name | string |
<a name="talos.resource.definitions.runtime.WatchdogTimerConfigSpec"></a>
WatchdogTimerConfigSpec describes configuration of watchdog timer.
| Field | Type | Label | Description |
|---|---|---|---|
| device | string | ||
| timeout | google.protobuf.Duration |
<a name="talos.resource.definitions.runtime.WatchdogTimerStatusSpec"></a>
WatchdogTimerStatusSpec describes configuration of watchdog timer.
| Field | Type | Label | Description |
|---|---|---|---|
| device | string | ||
| timeout | google.protobuf.Duration | ||
| feed_interval | google.protobuf.Duration |
<a name="resource/definitions/network/network.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="talos.resource.definitions.network.AddressSpecSpec"></a>
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 | ||
| priority | uint32 |
<a name="talos.resource.definitions.network.AddressStatusSpec"></a>
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 | ||
| priority | uint32 |
<a name="talos.resource.definitions.network.BGPBFDConfigSpec"></a>
BGPBFDConfigSpec contains BFD parameters for a BGP neighbor.
| Field | Type | Label | Description |
|---|---|---|---|
| transmit_interval | google.protobuf.Duration | ||
| receive_interval | google.protobuf.Duration | ||
| detect_multiplier | uint32 |
<a name="talos.resource.definitions.network.BGPImportRouteSpec"></a>
BGPImportRouteSpec selects routes learned by another BGP instance for one-way import.
| Field | Type | Label | Description |
|---|---|---|---|
| bgp_instance | string | ||
| prefixes | common.NetIPPrefix | repeated |
<a name="talos.resource.definitions.network.BGPInstanceConfigSpec"></a>
BGPInstanceConfigSpec contains the resolved runtime configuration for a BGP routing instance.
| Field | Type | Label | Description |
|---|---|---|---|
| local_asn | uint32 | ||
| router_id | common.NetIP | ||
| route_source | common.NetIP | ||
| advertise_links | string | repeated | |
| multipath | bool | ||
| max_paths | uint32 | ||
| neighbors | BGPNeighborConfigSpec | repeated | |
| vrf | string | ||
| vrf_table | talos.resource.definitions.enums.NethelpersRoutingTable | ||
| import_routes | BGPImportRouteSpec | repeated | |
| install_routes | bool |
<a name="talos.resource.definitions.network.BGPNeighborConfigSpec"></a>
BGPNeighborConfigSpec contains the runtime configuration for a BGP neighbor.
| Field | Type | Label | Description |
|---|---|---|---|
| address | common.NetIP | ||
| link | string | ||
| peer_asn | uint32 | ||
| hold_time | google.protobuf.Duration | ||
| bfd | BGPBFDConfigSpec | ||
| local_asn | uint32 | ||
| passive | bool |
<a name="talos.resource.definitions.network.BGPPeerStatusSpec"></a>
BGPPeerStatusSpec describes the status of a BGP peering session.
| Field | Type | Label | Description |
|---|---|---|---|
| peer | string | ||
| local_asn | uint32 | ||
| peer_asn | uint32 | ||
| state | talos.resource.definitions.enums.NethelpersBGPSessionState | ||
| router_id | common.NetIP | ||
| since | google.protobuf.Timestamp | ||
| received | uint32 | ||
| advertised | uint32 | ||
| accepted | uint32 | ||
| bfd_state | string | ||
| instance | string |
<a name="talos.resource.definitions.network.BondMasterSpec"></a>
BondMasterSpec describes bond settings if Kind == "bond".
| Field | Type | Label | Description |
|---|---|---|---|
| mode | talos.resource.definitions.enums.NethelpersBondMode | Mode specifies the bonding policy | |
| hash_policy | talos.resource.definitions.enums.NethelpersBondXmitHashPolicy | HashPolicy selects the transmit hash policy to use for slave selection. | |
| lacp_rate | talos.resource.definitions.enums.NethelpersLACPRate | LACPRate specifies the rate at which LACPDU frames are sent. | |
| arp_validate | talos.resource.definitions.enums.NethelpersARPValidate | ARPValidate specifies whether or not ARP probes and replies should be validated. | |
| arp_all_targets | talos.resource.definitions.enums.NethelpersARPAllTargets | ARPAllTargets specifies whether ARP probes should be sent to any or all targets. | |
| primary_index | uint32 | PrimaryIndex is a device index specifying which slave is the primary device. | |
| primary_reselect | talos.resource.definitions.enums.NethelpersPrimaryReselect | PrimaryReselect specifies the policy under which the primary slave should be reselected. | |
| fail_over_mac | talos.resource.definitions.enums.NethelpersFailOverMAC | FailOverMac whether active-backup mode should set all slaves to the same MAC address at enslavement, when enabled, or perform special handling. | |
| ad_select | talos.resource.definitions.enums.NethelpersADSelect | ADSelect specifies the aggregate selection policy for 802.3ad. | |
| mii_mon | uint32 | MIIMon is the link monitoring frequency in milliseconds. | |
| up_delay | uint32 | UpDelay is the time, in milliseconds, to wait before enabling a slave after a link recovery has been detected. | |
| down_delay | uint32 | DownDelay is the time, in milliseconds, to wait before disabling a slave after a link failure has been detected. | |
| arp_interval | uint32 | ARPInterval is the ARP link monitoring frequency in milliseconds. | |
| resend_igmp | uint32 | ResendIGMP specifies the number of times IGMP packets should be resent. | |
| min_links | uint32 | MinLinks specifies the minimum number of active links to assert carrier. | |
| lp_interval | uint32 | LPInterval specifies the number of seconds between instances where the bonding driver sends learning packets to each slave's peer switch. | |
| packets_per_slave | uint32 | PacketsPerSlave specifies the number of packets to transmit through a slave before moving to the next one. | |
| num_peer_notif | uint32 | NumPeerNotif specifies the number of peer notifications (gratuitous ARPs and unsolicited IPv6 Neighbor Advertisements) to be issued after a failover event. | |
| tlb_dynamic_lb | uint32 | TLBDynamicLB specifies if dynamic shuffling of flows is enabled in tlb or alb mode. | |
| all_slaves_active | uint32 | AllSlavesActive specifies that duplicate frames (received on inactive ports) should be dropped (0) or delivered (1). | |
| use_carrier | bool | UseCarrier specifies whether or not miimon should use MII or ETHTOOL. | |
| ad_actor_sys_prio | uint32 | ADActorSysPrio is the actor system priority for 802.3ad. | |
| ad_user_port_key | uint32 | ADUserPortKey is the user port key (upper 10 bits) for 802.3ad. | |
| peer_notify_delay | uint32 | PeerNotifyDelay is the delay, in milliseconds, between each peer notification. | |
| arpip_targets | common.NetIP | repeated | ARPIPTargets is the list of IP addresses to use for ARP link monitoring when ARPInterval is set. |
Maximum of 16 targets are supported. | | nsip6_targets | common.NetIP | repeated | NSIP6Targets is the list of IPv6 addresses to use for NS link monitoring when ARPInterval is set.
Maximum of 16 targets are supported. | | adlacp_active | talos.resource.definitions.enums.NethelpersADLACPActive | | ADLACPActive specifies whether to send LACPDU frames periodically. | | missed_max | uint32 | | MissedMax is the number of arp_interval monitor checks that must fail in order for an interface to be marked down by the ARP monitor. |
<a name="talos.resource.definitions.network.BondSlave"></a>
BondSlave contains a bond's master name and slave index.
| Field | Type | Label | Description |
|---|---|---|---|
| master_name | string | MasterName indicates master link for enslaved bonded interfaces. | |
| slave_index | int64 | SlaveIndex indicates a slave's position in bond. |
<a name="talos.resource.definitions.network.BridgeMasterSpec"></a>
BridgeMasterSpec describes bridge settings if Kind == "bridge".
| Field | Type | Label | Description |
|---|---|---|---|
| stp | STPSpec | ||
| vlan | BridgeVLANSpec |
<a name="talos.resource.definitions.network.BridgeSlave"></a>
BridgeSlave contains the name of the master bridge of a bridged interface
| Field | Type | Label | Description |
|---|---|---|---|
| master_name | string | MasterName indicates master link for enslaved bridged interfaces. |
<a name="talos.resource.definitions.network.BridgeVLANSpec"></a>
BridgeVLANSpec describes VLAN settings of a bridge.
| Field | Type | Label | Description |
|---|---|---|---|
| filtering_enabled | bool |
<a name="talos.resource.definitions.network.ClientIdentifierSpec"></a>
ClientIdentifierSpec is a shared DHCP4/DHCP6 client identifier spec.
| Field | Type | Label | Description |
|---|---|---|---|
| client_identifier | talos.resource.definitions.enums.NethelpersClientIdentifier | ||
| duid_raw_hex | string |
<a name="talos.resource.definitions.network.DHCP4OperatorSpec"></a>
DHCP4OperatorSpec describes DHCP4 operator options.
| Field | Type | Label | Description |
|---|---|---|---|
| route_metric | uint32 | ||
| skip_hostname_request | bool | ||
| client_identifier | ClientIdentifierSpec | ||
| skip_routes | bool |
<a name="talos.resource.definitions.network.DHCP6OperatorSpec"></a>
DHCP6OperatorSpec describes DHCP6 operator options.
| Field | Type | Label | Description |
|---|---|---|---|
| route_metric | uint32 | ||
| skip_hostname_request | bool | ||
| client_identifier | ClientIdentifierSpec |
<a name="talos.resource.definitions.network.DNSResolveCacheSpec"></a>
DNSResolveCacheSpec describes DNS servers status.
| Field | Type | Label | Description |
|---|---|---|---|
| status | string |
<a name="talos.resource.definitions.network.EthernetChannelsSpec"></a>
EthernetChannelsSpec describes config of Ethernet channels.
| Field | Type | Label | Description |
|---|---|---|---|
| rx | uint32 | ||
| tx | uint32 | ||
| other | uint32 | ||
| combined | uint32 |
<a name="talos.resource.definitions.network.EthernetChannelsStatus"></a>
EthernetChannelsStatus describes status of Ethernet channels.
| Field | Type | Label | Description |
|---|---|---|---|
| rx_max | uint32 | Read-only settings. | |
| tx_max | uint32 | ||
| other_max | uint32 | ||
| combined_max | uint32 | ||
| rx | uint32 | Current settings (read-write). | |
| tx | uint32 | ||
| other | uint32 | ||
| combined | uint32 |
<a name="talos.resource.definitions.network.EthernetFeatureStatus"></a>
EthernetFeatureStatus describes status of Ethernet features.
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| status | string |
<a name="talos.resource.definitions.network.EthernetRingsSpec"></a>
EthernetRingsSpec describes config of Ethernet rings.
| Field | Type | Label | Description |
|---|---|---|---|
| rx | uint32 | ||
| rx_mini | uint32 | ||
| rx_jumbo | uint32 | ||
| tx | uint32 | ||
| rx_buf_len | uint32 | ||
| cqe_size | uint32 | ||
| tx_push | bool | ||
| rx_push | bool | ||
| tx_push_buf_len | uint32 | ||
| tcp_data_split | bool |
<a name="talos.resource.definitions.network.EthernetRingsStatus"></a>
EthernetRingsStatus describes status of Ethernet rings.
| Field | Type | Label | Description |
|---|---|---|---|
| rx_max | uint32 | Read-only settings. | |
| rx_mini_max | uint32 | ||
| rx_jumbo_max | uint32 | ||
| tx_max | uint32 | ||
| tx_push_buf_len_max | uint32 | ||
| rx | uint32 | Current settings (read-write). | |
| rx_mini | uint32 | ||
| rx_jumbo | uint32 | ||
| tx | uint32 | ||
| rx_buf_len | uint32 | ||
| cqe_size | uint32 | ||
| tx_push | bool | ||
| rx_push | bool | ||
| tx_push_buf_len | uint32 | ||
| tcp_data_split | bool |
<a name="talos.resource.definitions.network.EthernetSpecSpec"></a>
EthernetSpecSpec describes config of Ethernet link.
| Field | Type | Label | Description |
|---|---|---|---|
| rings | EthernetRingsSpec | ||
| features | EthernetSpecSpec.FeaturesEntry | repeated | |
| channels | EthernetChannelsSpec | ||
| wake_on_lan | talos.resource.definitions.enums.NethelpersWOLMode | repeated |
<a name="talos.resource.definitions.network.EthernetSpecSpec.FeaturesEntry"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | bool |
<a name="talos.resource.definitions.network.EthernetStatusSpec"></a>
EthernetStatusSpec describes status of rendered secrets.
| Field | Type | Label | Description |
|---|---|---|---|
| link_state | bool | ||
| speed_megabits | int64 | ||
| port | talos.resource.definitions.enums.NethelpersPort | ||
| duplex | talos.resource.definitions.enums.NethelpersDuplex | ||
| our_modes | string | repeated | |
| peer_modes | string | repeated | |
| rings | EthernetRingsStatus | ||
| features | EthernetFeatureStatus | repeated | |
| channels | EthernetChannelsStatus | ||
| wake_on_lan | talos.resource.definitions.enums.NethelpersWOLMode | repeated |
<a name="talos.resource.definitions.network.HTTPProbeSpec"></a>
HTTPProbeSpec describes the HTTP Probe.
| Field | Type | Label | Description |
|---|---|---|---|
| url | common.URL | URL to probe: http:// or https:// URL. | |
| timeout | google.protobuf.Duration | Timeout for the probe. |
<a name="talos.resource.definitions.network.HardwareAddrSpec"></a>
HardwareAddrSpec describes spec for the link.
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | Name defines link name | |
| hardware_addr | bytes | Hardware address |
<a name="talos.resource.definitions.network.HostDNSConfigSpec"></a>
HostDNSConfigSpec describes host DNS config.
| Field | Type | Label | Description |
|---|---|---|---|
| enabled | bool | ||
| listen_addresses | common.NetIPPort | repeated | |
| service_host_dns_address | common.NetIP | ||
| resolve_member_names | bool | ||
| service_host_dns_address_v6 | common.NetIP |
<a name="talos.resource.definitions.network.HostnameSpecSpec"></a>
HostnameSpecSpec describes node hostname.
| Field | Type | Label | Description |
|---|---|---|---|
| hostname | string | ||
| domainname | string | ||
| config_layer | talos.resource.definitions.enums.NetworkConfigLayer |
<a name="talos.resource.definitions.network.HostnameStatusSpec"></a>
HostnameStatusSpec describes node hostname.
| Field | Type | Label | Description |
|---|---|---|---|
| hostname | string | ||
| domainname | string |
<a name="talos.resource.definitions.network.LinkAliasSpecSpec"></a>
LinkAliasSpecSpec describes status of rendered secrets.
| Field | Type | Label | Description |
|---|---|---|---|
| alias | string |
<a name="talos.resource.definitions.network.LinkRefreshSpec"></a>
LinkRefreshSpec describes status of rendered secrets.
| Field | Type | Label | Description |
|---|---|---|---|
| generation | int64 |
<a name="talos.resource.definitions.network.LinkSpecSpec"></a>
LinkSpecSpec describes spec for the link.
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | Name defines link name | |
| logical | bool | Logical describes if the interface should be created on the fly if it doesn't exist. | |
| up | bool | If Up is true, bring interface up, otherwise bring interface down. |
TODO: make *bool ? | | mtu | uint32 | | Interface MTU (always applies). | | kind | string | | Kind and Type are only required for Logical interfaces. | | type | talos.resource.definitions.enums.NethelpersLinkType | | | | parent_name | string | | ParentName indicates link parent for VLAN interfaces. | | bond_slave | BondSlave | | BondSlave contains bond slave configuration for interfaces enslaved to a bond. | | bridge_slave | BridgeSlave | | BridgeSlave carries bridge slave details for bridged interfaces. | | vlan | VLANSpec | | These structures are present depending on "Kind" for Logical interfaces. | | bond_master | BondMasterSpec | | | | bridge_master | BridgeMasterSpec | | | | wireguard | WireguardSpec | | | | config_layer | talos.resource.definitions.enums.NetworkConfigLayer | | Configuration layer. | | hardware_address | bytes | | Override hardware (MAC) address (if supported). | | multicast | bool | | Multicast indicates whether the multicast flag should be set on the interface to the value. | | vrf_master | VRFMasterSpec | | | | vrf_slave | VRFSlave | | VRFSlave carries VRF slave details for interfaces in a VRF. | | veth | VethSpec | | |
<a name="talos.resource.definitions.network.LinkStatusSpec"></a>
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 | Fields coming from ethtool API. | |
| speed_megabits | int64 | ||
| port | talos.resource.definitions.enums.NethelpersPort | ||
| duplex | talos.resource.definitions.enums.NethelpersDuplex | ||
| vlan | VLANSpec | Following fields are only populated with respective Kind. | |
| bridge_master | BridgeMasterSpec | ||
| bond_master | BondMasterSpec | ||
| wireguard | WireguardSpec | ||
| permanent_addr | bytes | ||
| alias | string | Fields coming from rtnetlink API. | |
| alt_names | string | repeated | |
| vrf_master | VRFMasterSpec | ||
| veth | VethSpec |
<a name="talos.resource.definitions.network.NameServerSpec"></a>
NameServerSpec describes a single DNS nameserver with additional configuration.
| Field | Type | Label | Description |
|---|---|---|---|
| addr | common.NetIP | ||
| protocol | talos.resource.definitions.enums.NethelpersDNSProtocol | ||
| tls_server_name | string |
<a name="talos.resource.definitions.network.NfTablesAddressMatch"></a>
NfTablesAddressMatch describes the match on the IP address.
| Field | Type | Label | Description |
|---|---|---|---|
| include_subnets | common.NetIPPrefix | repeated | |
| exclude_subnets | common.NetIPPrefix | repeated | |
| invert | bool |
<a name="talos.resource.definitions.network.NfTablesChainSpec"></a>
NfTablesChainSpec describes status of rendered secrets.
| Field | Type | Label | Description |
|---|---|---|---|
| type | string | ||
| hook | talos.resource.definitions.enums.NethelpersNfTablesChainHook | ||
| priority | talos.resource.definitions.enums.NethelpersNfTablesChainPriority | ||
| rules | NfTablesRule | repeated | |
| policy | talos.resource.definitions.enums.NethelpersNfTablesVerdict |
<a name="talos.resource.definitions.network.NfTablesClampMSS"></a>
NfTablesClampMSS describes the TCP MSS clamping operation.
MSS is limited by the MaxMTU so that:
| Field | Type | Label | Description |
|---|---|---|---|
| mtu | uint32 |
<a name="talos.resource.definitions.network.NfTablesConntrackStateMatch"></a>
NfTablesConntrackStateMatch describes the match on the connection tracking state.
| Field | Type | Label | Description |
|---|---|---|---|
| states | talos.resource.definitions.enums.NethelpersConntrackState | repeated |
<a name="talos.resource.definitions.network.NfTablesICMPTypeMatch"></a>
NfTablesICMPTypeMatch describes the match on the ICMP type.
| Field | Type | Label | Description |
|---|---|---|---|
| types | talos.resource.definitions.enums.NethelpersICMPType | repeated |
<a name="talos.resource.definitions.network.NfTablesIfNameMatch"></a>
NfTablesIfNameMatch describes the match on the interface name.
| Field | Type | Label | Description |
|---|---|---|---|
| operator | talos.resource.definitions.enums.NethelpersMatchOperator | ||
| interface_names | string | repeated |
<a name="talos.resource.definitions.network.NfTablesLayer4Match"></a>
NfTablesLayer4Match describes the match on the transport layer protocol.
| Field | Type | Label | Description |
|---|---|---|---|
| protocol | talos.resource.definitions.enums.NethelpersProtocol | ||
| match_source_port | NfTablesPortMatch | ||
| match_destination_port | NfTablesPortMatch | ||
| match_icmp_type | NfTablesICMPTypeMatch |
<a name="talos.resource.definitions.network.NfTablesLimitMatch"></a>
NfTablesLimitMatch describes the match on the packet rate.
| Field | Type | Label | Description |
|---|---|---|---|
| packet_rate_per_second | uint64 |
<a name="talos.resource.definitions.network.NfTablesMark"></a>
NfTablesMark encodes packet mark match/update operation.
When used as a match computes the following condition: (mark & mask) ^ xor == value
When used as an update computes the following operation: mark = (mark & mask) ^ xor.
| Field | Type | Label | Description |
|---|---|---|---|
| mask | uint32 | ||
| xor | uint32 | ||
| value | uint32 |
<a name="talos.resource.definitions.network.NfTablesPortMatch"></a>
NfTablesPortMatch describes the match on the transport layer port.
| Field | Type | Label | Description |
|---|---|---|---|
| ranges | PortRange | repeated |
<a name="talos.resource.definitions.network.NfTablesRule"></a>
NfTablesRule describes a single rule in the nftables chain.
| Field | Type | Label | Description |
|---|---|---|---|
| match_o_if_name | NfTablesIfNameMatch | ||
| verdict | talos.resource.definitions.enums.NethelpersNfTablesVerdict | ||
| match_mark | NfTablesMark | ||
| set_mark | NfTablesMark | ||
| match_source_address | NfTablesAddressMatch | ||
| match_destination_address | NfTablesAddressMatch | ||
| match_layer4 | NfTablesLayer4Match | ||
| match_i_if_name | NfTablesIfNameMatch | ||
| clamp_mss | NfTablesClampMSS | ||
| match_limit | NfTablesLimitMatch | ||
| match_conntrack_state | NfTablesConntrackStateMatch | ||
| anon_counter | bool |
<a name="talos.resource.definitions.network.NodeAddressFilterSpec"></a>
NodeAddressFilterSpec describes a filter for NodeAddresses.
| Field | Type | Label | Description |
|---|---|---|---|
| include_subnets | common.NetIPPrefix | repeated | Address is skipped if it doesn't match any of the includeSubnets (if includeSubnets is not empty). |
| exclude_subnets | common.NetIPPrefix | repeated | Address is skipped if it matches any of the excludeSubnets. |
<a name="talos.resource.definitions.network.NodeAddressSortAlgorithmSpec"></a>
NodeAddressSortAlgorithmSpec describes a filter for NodeAddresses.
| Field | Type | Label | Description |
|---|---|---|---|
| algorithm | talos.resource.definitions.enums.NethelpersAddressSortAlgorithm |
<a name="talos.resource.definitions.network.NodeAddressSpec"></a>
NodeAddressSpec describes a set of node addresses.
| Field | Type | Label | Description |
|---|---|---|---|
| addresses | common.NetIPPrefix | repeated | |
| sort_algorithm | talos.resource.definitions.enums.NethelpersAddressSortAlgorithm |
<a name="talos.resource.definitions.network.OperatorSpecSpec"></a>
OperatorSpecSpec describes operator specification.
| 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 |
<a name="talos.resource.definitions.network.PlatformConfigSpec"></a>
PlatformConfigSpec describes platform network configuration.
This structure is marshaled to STATE partition to persist cached network configuration across reboots.
| Field | Type | Label | Description |
|---|---|---|---|
| addresses | AddressSpecSpec | repeated | |
| links | LinkSpecSpec | repeated | |
| routes | RouteSpecSpec | repeated | |
| hostnames | HostnameSpecSpec | repeated | |
| resolvers | ResolverSpecSpec | repeated | |
| time_servers | TimeServerSpecSpec | repeated | |
| operators | OperatorSpecSpec | repeated | |
| external_ips | common.NetIP | repeated | |
| probes | ProbeSpecSpec | repeated | |
| metadata | talos.resource.definitions.runtime.PlatformMetadataSpec |
<a name="talos.resource.definitions.network.PortRange"></a>
PortRange describes a range of ports.
Range is [lo, hi].
| Field | Type | Label | Description |
|---|---|---|---|
| lo | uint32 | ||
| hi | uint32 |
<a name="talos.resource.definitions.network.ProbeSpecSpec"></a>
ProbeSpecSpec describes the Probe.
| Field | Type | Label | Description |
|---|---|---|---|
| interval | google.protobuf.Duration | Interval between the probes. | |
| failure_threshold | int64 | FailureThreshold is the number of consecutive failures for the probe to be considered failed after having succeeded. | |
| tcp | TCPProbeSpec | TCP is the TCP probe spec. One of TCP or HTTP must be specified. | |
| config_layer | talos.resource.definitions.enums.NetworkConfigLayer | Configuration layer. | |
| http | HTTPProbeSpec | HTTP is the HTTP probe spec. One of TCP or HTTP must be specified. |
<a name="talos.resource.definitions.network.ProbeStatusSpec"></a>
ProbeStatusSpec describes the Probe.
| Field | Type | Label | Description |
|---|---|---|---|
| success | bool | Success of the check. | |
| last_error | string | Last error of the probe. |
<a name="talos.resource.definitions.network.ResolverSpecSpec"></a>
ResolverSpecSpec describes DNS resolvers.
| Field | Type | Label | Description |
|---|---|---|---|
| dns_servers | common.NetIP | repeated | DNSServers is a flat list of DNS server IP addresses. |
Deprecated: This field is deprecated in favor of NameServers which contain more information. | | config_layer | talos.resource.definitions.enums.NetworkConfigLayer | | | | search_domains | string | repeated | | | name_servers | NameServerSpec | repeated | NameServers is a list of DNS servers with additional configuration. | | search_domains_overridden | bool | | SearchDomainsOverridden indicates that SearchDomains was explicitly set on the machine configuration layer and must override (rather than merge with) search domains from previous layers. This is a separate field because protobuf cannot distinguish an empty slice from an unset one, and an empty override is used to clear DHCP/platform search domains. |
<a name="talos.resource.definitions.network.ResolverStatusSpec"></a>
ResolverStatusSpec describes DNS resolvers.
| Field | Type | Label | Description |
|---|---|---|---|
| dns_servers | common.NetIP | repeated | DNSServers is a flat list of DNS server IP addresses. |
Deprecated: This field is deprecated in favor of NameServers which contain more information. | | search_domains | string | repeated | | | name_servers | NameServerSpec | repeated | NameServers is a list of DNS servers with additional configuration. |
<a name="talos.resource.definitions.network.RouteNextHop"></a>
RouteNextHop describes a single next-hop of a (possibly multipath) route.
A next-hop gateway may be in a different address family than the route destination (e.g. an IPv4 prefix reachable via an IPv6 link-local next-hop, RFC 8950).
| Field | Type | Label | Description |
|---|---|---|---|
| gateway | common.NetIP | ||
| out_link_name | string | ||
| weight | uint32 |
<a name="talos.resource.definitions.network.RouteSpecSpec"></a>
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 | ||
| next_hops | RouteNextHop | repeated | NextHops, when non-empty, describes a multipath (ECMP) route. The top-level Gateway and OutLinkName are left unset in that case, mirroring the kernel's RTA_GATEWAY vs RTA_MULTIPATH split. |
<a name="talos.resource.definitions.network.RouteStatusSpec"></a>
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 | ||
| next_hops | RouteNextHop | repeated | NextHops is populated for multipath (ECMP) routes; the top-level Gateway/OutLink stay unset then. |
<a name="talos.resource.definitions.network.RoutingRuleSpecSpec"></a>
RoutingRuleSpecSpec describes the routing rule.
| Field | Type | Label | Description |
|---|---|---|---|
| family | talos.resource.definitions.enums.NethelpersFamily | ||
| src | common.NetIPPrefix | ||
| dst | common.NetIPPrefix | ||
| table | talos.resource.definitions.enums.NethelpersRoutingTable | ||
| priority | uint32 | ||
| action | talos.resource.definitions.enums.NethelpersRoutingRuleAction | ||
| iif_name | string | ||
| oif_name | string | ||
| fw_mark | uint32 | ||
| fw_mask | uint32 | ||
| config_layer | talos.resource.definitions.enums.NetworkConfigLayer |
<a name="talos.resource.definitions.network.RoutingRuleStatusSpec"></a>
RoutingRuleStatusSpec describes the observed routing rule state.
| Field | Type | Label | Description |
|---|---|---|---|
| family | talos.resource.definitions.enums.NethelpersFamily | ||
| src | common.NetIPPrefix | ||
| dst | common.NetIPPrefix | ||
| table | talos.resource.definitions.enums.NethelpersRoutingTable | ||
| priority | uint32 | ||
| action | talos.resource.definitions.enums.NethelpersRoutingRuleAction | ||
| iif_name | string | ||
| oif_name | string | ||
| fw_mark | uint32 | ||
| fw_mask | uint32 |
<a name="talos.resource.definitions.network.STPSpec"></a>
STPSpec describes Spanning Tree Protocol (STP) settings of a bridge.
| Field | Type | Label | Description |
|---|---|---|---|
| enabled | bool |
<a name="talos.resource.definitions.network.StaticHostSpec"></a>
StaticHostSpec describes addresses for a static host name.
| Field | Type | Label | Description |
|---|---|---|---|
| addresses | common.NetIP | repeated |
<a name="talos.resource.definitions.network.StatusSpec"></a>
StatusSpec describes network state.
| Field | Type | Label | Description |
|---|---|---|---|
| address_ready | bool | ||
| connectivity_ready | bool | ||
| hostname_ready | bool | ||
| etc_files_ready | bool |
<a name="talos.resource.definitions.network.TCPProbeSpec"></a>
TCPProbeSpec describes the TCP Probe.
| Field | Type | Label | Description |
|---|---|---|---|
| endpoint | string | Endpoint to probe: host:port. | |
| timeout | google.protobuf.Duration | Timeout for the probe. |
<a name="talos.resource.definitions.network.TimeServerSpecSpec"></a>
TimeServerSpecSpec describes NTP servers.
| Field | Type | Label | Description |
|---|---|---|---|
| ntp_servers | string | repeated | |
| config_layer | talos.resource.definitions.enums.NetworkConfigLayer | ||
| use_nts | bool |
<a name="talos.resource.definitions.network.TimeServerStatusSpec"></a>
TimeServerStatusSpec describes NTP servers.
| Field | Type | Label | Description |
|---|---|---|---|
| ntp_servers | string | repeated | |
| use_nts | bool |
<a name="talos.resource.definitions.network.VIPEquinixMetalSpec"></a>
VIPEquinixMetalSpec describes virtual (elastic) IP settings for Equinix Metal.
| Field | Type | Label | Description |
|---|---|---|---|
| project_id | string | ||
| device_id | string | ||
| api_token | string |
<a name="talos.resource.definitions.network.VIPHCloudSpec"></a>
VIPHCloudSpec describes virtual (elastic) IP settings for Hetzner Cloud.
| Field | Type | Label | Description |
|---|---|---|---|
| device_id | int64 | ||
| network_id | int64 | ||
| api_token | string |
<a name="talos.resource.definitions.network.VIPOperatorSpec"></a>
VIPOperatorSpec describes virtual IP operator options.
| Field | Type | Label | Description |
|---|---|---|---|
| ip | common.NetIP | ||
| gratuitous_arp | bool | ||
| equinix_metal | VIPEquinixMetalSpec | ||
| h_cloud | VIPHCloudSpec |
<a name="talos.resource.definitions.network.VLANSpec"></a>
VLANSpec describes VLAN settings if Kind == "vlan".
| Field | Type | Label | Description |
|---|---|---|---|
| vid | uint32 | VID is the vlan ID. | |
| protocol | talos.resource.definitions.enums.NethelpersVLANProtocol | Protocol is the vlan protocol. |
<a name="talos.resource.definitions.network.VRFMasterSpec"></a>
VRFMasterSpec describes vrf settings if Kind == "vrf".
| Field | Type | Label | Description |
|---|---|---|---|
| table | talos.resource.definitions.enums.NethelpersRoutingTable |
<a name="talos.resource.definitions.network.VRFSlave"></a>
VRFSlave contains the name of the master vrf for an interface
| Field | Type | Label | Description |
|---|---|---|---|
| master_name | string |
<a name="talos.resource.definitions.network.VethSpec"></a>
VethSpec identifies the expected peer of a veth endpoint.
| Field | Type | Label | Description |
|---|---|---|---|
| peer_name | string |
<a name="talos.resource.definitions.network.WireguardPeer"></a>
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 |
<a name="talos.resource.definitions.network.WireguardSpec"></a>
WireguardSpec describes Wireguard settings if Kind == "wireguard".
| Field | Type | Label | Description |
|---|---|---|---|
| private_key | string | PrivateKey is used to configure the link, present only in the LinkSpec. | |
| public_key | string | PublicKey is only used in LinkStatus to show the link status. | |
| listen_port | int64 | ||
| firewall_mark | int64 | ||
| peers | WireguardPeer | repeated |
<a name="resource/definitions/perf/perf.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="talos.resource.definitions.perf.CPUSpec"></a>
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 |
<a name="talos.resource.definitions.perf.CPUStat"></a>
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 |
<a name="talos.resource.definitions.perf.MemorySpec"></a>
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 |
<a name="resource/definitions/secrets/secrets.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="talos.resource.definitions.secrets.APICertsSpec"></a>
APICertsSpec describes etcd certs secrets.
| Field | Type | Label | Description |
|---|---|---|---|
| client | common.PEMEncodedCertificateAndKey | ||
| server | common.PEMEncodedCertificateAndKey | ||
| accepted_c_as | common.PEMEncodedCertificate | repeated | |
| skip_verifying_client_cert | bool | Skip verifying client certificate, to be used only with the maintenance mode operations. |
<a name="talos.resource.definitions.secrets.CertSANSpec"></a>
CertSANSpec describes fields of the cert SANs.
| Field | Type | Label | Description |
|---|---|---|---|
| i_ps | common.NetIP | repeated | |
| dns_names | string | repeated | |
| fqdn | string |
<a name="talos.resource.definitions.secrets.EncryptionSaltSpec"></a>
EncryptionSaltSpec describes the salt.
| Field | Type | Label | Description |
|---|---|---|---|
| disk_salt | bytes |
<a name="talos.resource.definitions.secrets.EtcdCertsSpec"></a>
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 |
<a name="talos.resource.definitions.secrets.EtcdRootSpec"></a>
EtcdRootSpec describes etcd CA secrets.
| Field | Type | Label | Description |
|---|---|---|---|
| etcd_ca | common.PEMEncodedCertificateAndKey |
<a name="talos.resource.definitions.secrets.KubeletSpec"></a>
KubeletSpec describes root Kubernetes secrets.
| Field | Type | Label | Description |
|---|---|---|---|
| endpoint | common.URL | ||
| bootstrap_token_id | string | ||
| bootstrap_token_secret | string | ||
| accepted_c_as | common.PEMEncodedCertificate | repeated | |
| endpoint_tls_server_name | string | EndpointTLSServerName, when non-empty, is propagated to the generated kubelet kubeconfig as clusters[0].cluster.tls-server-name, overriding the SNI/hostname the kubelet uses while still dialing Endpoint as the TCP destination. |
<a name="talos.resource.definitions.secrets.KubernetesCertsSpec"></a>
KubernetesCertsSpec describes generated Kubernetes certificates.
| Field | Type | Label | Description |
|---|---|---|---|
| scheduler_kubeconfig | string | ||
| controller_manager_kubeconfig | string | ||
| localhost_admin_kubeconfig | string | Admin-level kubeconfig with access through the localhost endpoint and cluster endpoints. | |
| admin_kubeconfig | string |
<a name="talos.resource.definitions.secrets.KubernetesDynamicCertsSpec"></a>
KubernetesDynamicCertsSpec describes generated KubernetesCerts certificates.
| Field | Type | Label | Description |
|---|---|---|---|
| api_server | common.PEMEncodedCertificateAndKey | ||
| api_server_kubelet_client | common.PEMEncodedCertificateAndKey | ||
| front_proxy | common.PEMEncodedCertificateAndKey |
<a name="talos.resource.definitions.secrets.KubernetesRootSpec"></a>
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 | ||
| issuing_ca | common.PEMEncodedCertificateAndKey | ||
| service_account | common.PEMEncodedKey | ServiceAccount is the issuing service account key. | |
| 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 | |
| accepted_c_as | common.PEMEncodedCertificate | repeated | |
| etcd_encryption_config | google.protobuf.Struct | ||
| accepted_aggregator_c_as | common.PEMEncodedCertificate | repeated | |
| service_account_accepted_keys | common.PEMEncodedKey | repeated | ServiceAccountAcceptedKeys are the accepted service account keys. |
It already contains the public version of the issuing key. | | issuer_url | string | | IssuerURL is the URL of the service account issuer. | | accepted_issuers | string | repeated | AcceptedIssuers are the accepted service account issuers.
It doesn't contain the issuerURL. | | api_audiences | string | repeated | APIAudiences are the accepted service account audiences. |
<a name="talos.resource.definitions.secrets.MaintenanceRootSpec"></a>
MaintenanceRootSpec describes maintenance service CA.
| Field | Type | Label | Description |
|---|---|---|---|
| ca | common.PEMEncodedCertificateAndKey |
<a name="talos.resource.definitions.secrets.OSRootSpec"></a>
OSRootSpec describes operating system CA.
| Field | Type | Label | Description |
|---|---|---|---|
| issuing_ca | common.PEMEncodedCertificateAndKey | ||
| cert_sani_ps | common.NetIP | repeated | |
| cert_sandns_names | string | repeated | |
| token | string | ||
| accepted_c_as | common.PEMEncodedCertificate | repeated |
<a name="talos.resource.definitions.secrets.TrustdCertsSpec"></a>
TrustdCertsSpec describes etcd certs secrets.
| Field | Type | Label | Description |
|---|---|---|---|
| server | common.PEMEncodedCertificateAndKey | ||
| accepted_c_as | common.PEMEncodedCertificate | repeated |
<a name="resource/definitions/security/security.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="talos.resource.definitions.security.ImageKeylessVerifierSpec"></a>
ImageKeylessVerifierSpec represents a signature verification provider.
| Field | Type | Label | Description |
|---|---|---|---|
| issuer | string | Issuer is the OIDC issuer URL. | |
| subject | string | Subject is the expected subject. | |
| subject_regex | string | SubjectRegex is a regex pattern for subject matching. |
<a name="talos.resource.definitions.security.ImagePublicKeyVerifierSpec"></a>
ImagePublicKeyVerifierSpec represents a signature verification provider with static public key.
| Field | Type | Label | Description |
|---|---|---|---|
| certificate | string | Certificate is a public certificate in PEM format accepted for image signature verification. |
<a name="talos.resource.definitions.security.ImageVerificationRuleSpec"></a>
ImageVerificationRuleSpec represents a verification rule.
| Field | Type | Label | Description |
|---|---|---|---|
| image_pattern | string | ImagePattern is the image name pattern. | |
| skip | bool | Skip is the action for matching images. | |
| deny | bool | Deny is the action for matching images. | |
| keyless_verifier | ImageKeylessVerifierSpec | KeylessVerifier is the keyless verifier configuration to use. | |
| public_key_verifier | ImagePublicKeyVerifierSpec | PublicKeyVerifier is the public key verifier configuration to use. |
<a name="talos.resource.definitions.security.TUFTrustedRootSpec"></a>
TUFTrustedRootSpec represents a sigstore's TUF trusted root information.
| Field | Type | Label | Description |
|---|---|---|---|
| last_refresh_time | google.protobuf.Timestamp | LastRefreshTime is the last time the trusted root was refreshed. | |
| json_data | string | JSONData is the trusted root data in JSON format. |
<a name="resource/definitions/siderolink/siderolink.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="talos.resource.definitions.siderolink.ConfigSpec"></a>
ConfigSpec describes Siderolink configuration.
| Field | Type | Label | Description |
|---|---|---|---|
| api_endpoint | string | ||
| host | string | ||
| join_token | string | ||
| insecure | bool | ||
| tunnel | bool |
<a name="talos.resource.definitions.siderolink.StatusSpec"></a>
StatusSpec describes Siderolink status.
| Field | Type | Label | Description |
|---|---|---|---|
| host | string | Host is the Siderolink target host. | |
| connected | bool | Connected is the status of the Siderolink GRPC connection. | |
| link_name | string | LinkName is the name of the interface used for the Siderolink tunnel. | |
| grpc_tunnel | bool | GRPCTunnel is true if the Wireguard-over-GRPC tunnel is being used. |
<a name="talos.resource.definitions.siderolink.TunnelSpec"></a>
TunnelSpec describes Siderolink GRPC Tunnel configuration.
| Field | Type | Label | Description |
|---|---|---|---|
| api_endpoint | string | APIEndpoint is the Siderolink WireGuard over GRPC endpoint. | |
| link_name | string | LinkName is the name to use for WireGuard tunnel. | |
| mtu | int64 | MTU is the maximum transmission unit for the tunnel. | |
| node_address | common.NetIPPort | NodeAddress is the virtual address of our node. It's used to identify our node in the WireGuard GRPC streamer. It's not the address of the actual WireGuard interface. |
<a name="resource/definitions/storage/storage.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="talos.resource.definitions.storage.LVMLogicalVolumeSpecSpec"></a>
LVMLogicalVolumeSpecSpec is the spec for LVMLogicalVolumeSpec resource.
| Field | Type | Label | Description |
|---|---|---|---|
| vg_name | string | VGName is the parent volume group name. | |
| name | string | Name is the logical volume name. | |
| type | talos.resource.definitions.enums.StorageLVMLogicalVolumeType | Type is the LV layout. | |
| size_bytes | uint64 | SizeBytes is the absolute LV size in bytes; used when SizePercentVG is zero. | |
| size_percent_vg | uint32 | SizePercentVG, when non-zero, sizes the LV as a percentage of the VG. | |
| mirrors | uint32 | Mirrors is the mirror count for raid1/raid10 layouts. | |
| stripes | uint32 | Stripes is the stripe count for raid0/raid10 layouts; 0 means "all PVs", resolved by the reconcile controller. |
<a name="talos.resource.definitions.storage.LVMLogicalVolumeStatusSpec"></a>
LVMLogicalVolumeStatusSpec mirrors selected lvs columns.
| Field | Type | Label | Description |
|---|---|---|---|
| path | string | Path is the LV path (lv_path), e.g. /dev/vg0/data. Empty for hidden LVs. | |
| dm_path | string | DMPath is the device-mapper path (lv_dm_path), always populated when active. | |
| name | string | Name is the LV short name (lv_name). | |
| full_name | string | FullName is the qualified LV name (lv_full_name), e.g. "vg0/data". | |
| vg_name | string | VGName is the parent volume group name (vg_name). | |
| uuid | string | UUID is the stable LV identifier (lv_uuid). | |
| layout | string | Layout is the LV layout (lv_layout), e.g. "linear", "raid1", "thin,pool". | |
| role | string | Role is the LV role (lv_role), e.g. "public", "private,thin,pool,data". | |
| permissions | string | Permissions reflects lv_permissions. | |
| allocation_policy | string | AllocationPolicy reflects lv_allocation_policy. | |
| allocation_locked | string | AllocationLocked is the raw lv_allocation_locked column ("locked" / ""). | |
| fixed_minor | string | FixedMinor is the raw lv_fixed_minor column ("fixed" / ""). | |
| active | string | Active is the raw lv_active column ("active" / "" / "unknown"). | |
| active_locally | string | ActiveLocally is the raw lv_active_locally column ("active locally" / "" / "unknown"). | |
| active_remotely | string | ActiveRemotely is the raw lv_active_remotely column ("active remotely" / "" / "unknown"). | |
| active_exclusively | string | ActiveExclusively is the raw lv_active_exclusively column ("active exclusively" / "" / "unknown"). | |
| suspended | string | Suspended is the raw lv_suspended column ("suspended" / "" / "unknown"). | |
| device_open | string | DeviceOpen is the raw lv_device_open column ("open" / "" / "unknown"). | |
| skip_activation | string | SkipActivation is the raw lv_skip_activation column ("skip activation" / ""). | |
| merging | string | Merging is the raw lv_merging column ("merging" / ""). | |
| converting | string | Converting is the raw lv_converting column ("converting" / ""). | |
| size | string | Size is the raw lv_size column in bytes. | |
| metadata_size | string | MetadataSize is the raw lv_metadata_size column in bytes ("" when not applicable). | |
| read_ahead | string | ReadAhead is the raw lv_read_ahead column ("auto" or a byte count). | |
| kernel_major | string | KernelMajor is the raw lv_kernel_major column ("-1" when inactive, otherwise a number). | |
| kernel_minor | string | KernelMinor is the raw lv_kernel_minor column ("-1" when inactive, otherwise a number). | |
| origin | string | Origin is the LV name this LV is a snapshot/thin clone of (origin); empty otherwise. | |
| origin_size | string | OriginSize is the raw origin_size column in bytes ("" when not applicable). | |
| pool_lv | string | PoolLV is the parent thin/cache pool name (pool_lv); empty when not pool-backed. | |
| data_lv | string | DataLV is the data sub-LV name (data_lv); empty when not applicable. | |
| metadata_lv | string | MetadataLV is the metadata sub-LV name (metadata_lv); empty when not applicable. | |
| move_pv | string | MovePV is the source PV of an in-progress pvmove (move_pv); empty otherwise. | |
| convert_lv | string | ConvertLV is the target LV of an in-progress lvconvert (convert_lv); empty otherwise. | |
| when_full | string | WhenFull reflects lv_when_full ("error" / "queue" / ""). | |
| tags | string | repeated | Tags is the list of tags attached to the LV (lv_tags). |
| pretty_size | string | PrettySize is the human-readable rendering of Size; empty when Size is not a byte count. |
<a name="talos.resource.definitions.storage.LVMPhysicalVolumeSpecSpec"></a>
LVMPhysicalVolumeSpecSpec is the spec for LVMPhysicalVolumeSpec resource.
| Field | Type | Label | Description |
|---|---|---|---|
| device | string | Device is the block-device path to initialize as a PV. | |
| vg_name | string | VGName is the target volume group name. |
<a name="talos.resource.definitions.storage.LVMPhysicalVolumeStatusSpec"></a>
LVMPhysicalVolumeStatusSpec mirrors selected pvs columns.
Raw strings preserve LVM sentinel values.
| Field | Type | Label | Description |
|---|---|---|---|
| device | string | Device is the block-device path backing the PV (pv_name). | |
| vg_name | string | VGName is the parent volume group name; empty if the PV is not in a VG. | |
| uuid | string | UUID is the stable PV identifier written to the PV label (pv_uuid). | |
| format | string | Format is the on-disk metadata format (pv_fmt), e.g. "lvm2". | |
| allocatable | string | Allocatable is the raw pv_allocatable column ("allocatable" / ""). | |
| exported | string | Exported is the raw pv_exported column ("exported" / ""). | |
| missing | string | Missing is the raw pv_missing column ("missing" / ""). | |
| in_use | string | InUse is the raw pv_in_use column ("used" / ""). | |
| size | string | Size is the raw pv_size column in bytes. | |
| device_size | string | DeviceSize is the raw dev_size column in bytes. | |
| free | string | Free is the raw pv_free column in bytes. | |
| used | string | Used is the raw pv_used column in bytes. | |
| pe_count | string | PECount is the raw pv_pe_count column. | |
| pe_alloc_count | string | PEAllocCount is the raw pv_pe_alloc_count column. | |
| major | string | Major is the raw pv_major column ("-1" for orphan PVs, otherwise the kernel major). | |
| minor | string | Minor is the raw pv_minor column ("-1" for orphan PVs, otherwise the kernel minor). | |
| tags | string | repeated | Tags is the list of tags attached to the PV (pv_tags). |
| pretty_size | string | PrettySize is the human-readable rendering of Size. | |
| pretty_device_size | string | PrettyDeviceSize is the human-readable rendering of DeviceSize. | |
| pretty_free | string | PrettyFree is the human-readable rendering of Free. |
<a name="talos.resource.definitions.storage.LVMRefreshRequestSpec"></a>
LVMRefreshRequestSpec is the spec for LVMRefreshRequest.
| Field | Type | Label | Description |
|---|---|---|---|
| request | int64 |
<a name="talos.resource.definitions.storage.LVMValidationErrorSpec"></a>
LVMValidationErrorSpec is the spec for LVMValidationError resource.
| Field | Type | Label | Description |
|---|---|---|---|
| vg_name | string | VGName is the volume group the error relates to. | |
| message | string | Message describes the validation error. |
<a name="talos.resource.definitions.storage.LVMVolumeGroupSpecSpec"></a>
LVMVolumeGroupSpecSpec is the spec for LVMVolumeGroupSpec resource.
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | Name is the volume group name. | |
| physical_volumes | string | repeated | PhysicalVolumes is the list of PV device paths. |
<a name="talos.resource.definitions.storage.LVMVolumeGroupStatusSpec"></a>
LVMVolumeGroupStatusSpec mirrors selected vgs columns.
Raw strings preserve LVM sentinel values.
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | Name is the volume group name (vg_name). | |
| uuid | string | UUID is the stable VG identifier (vg_uuid). | |
| format | string | Format is the on-disk metadata format (vg_fmt), e.g. "lvm2". | |
| permissions | string | Permissions reflects vg_permissions ("writeable" / "read-only" / "unknown" / ""). | |
| extendable | string | Extendable is the raw vg_extendable column ("extendable" / ""). | |
| exported | string | Exported is the raw vg_exported column ("exported" / ""). | |
| partial | string | Partial is the raw vg_partial column ("partial" / ""). | |
| allocation_policy | string | AllocationPolicy reflects vg_allocation_policy. | |
| clustered | string | Clustered is the raw vg_clustered column ("clustered" / ""). | |
| shared | string | Shared is the raw vg_shared column ("shared" / ""). | |
| size | string | Size is the raw vg_size column in bytes. | |
| free | string | Free is the raw vg_free column in bytes. | |
| extent_size | string | ExtentSize is the raw vg_extent_size column in bytes. | |
| extent_count | string | ExtentCount is the raw vg_extent_count column. | |
| free_extent_count | string | FreeExtentCount is the raw vg_free_count column. | |
| max_lv | string | MaxLV is the raw max_lv column; "0" means no limit. | |
| max_pv | string | MaxPV is the raw max_pv column; "0" means no limit. | |
| lv_count | string | LVCount is the raw lv_count column. | |
| pv_count | string | PVCount is the raw pv_count column. | |
| snap_count | string | SnapCount is the raw snap_count column. | |
| missing_pv_count | string | MissingPVCount is the raw vg_missing_pv_count column. | |
| seq_no | string | SeqNo is the raw vg_seqno column. | |
| lock_type | string | LockType is the raw vg_lock_type column. | |
| system_id | string | SystemID is the system_id stamped into VG metadata (vg_systemid). | |
| tags | string | repeated | Tags is the list of tags attached to the VG (vg_tags). |
| pretty_size | string | PrettySize is the human-readable rendering of Size. | |
| pretty_free | string | PrettyFree is the human-readable rendering of Free. |
<a name="talos.resource.definitions.storage.MDArraySpecSpec"></a>
MDArraySpecSpec is the spec for MDArraySpec resource.
| Field | Type | Label | Description |
|---|---|---|---|
| level | talos.resource.definitions.enums.StorageMDLevel | Level is the RAID level. | |
| volume_selector | google.api.expr.v1alpha1.CheckedExpr | VolumeSelector matches the member volumes of the array. | |
| metadata | talos.resource.definitions.enums.StorageMDMetadata | Metadata is the on-disk MD metadata format. |
<a name="talos.resource.definitions.storage.MDArrayStatusSpec"></a>
MDArrayStatusSpec is the spec for MDArrayStatus resource.
| Field | Type | Label | Description |
|---|---|---|---|
| level | talos.resource.definitions.enums.StorageMDLevel | Level is the RAID level. | |
| device | string | Device is the stable by-id device path of the array. | |
| members | string | repeated | Members is the list of member device paths. |
| error | string | Error is the last provisioning error, if any. | |
| status | talos.resource.definitions.enums.StorageMDArrayPhase | Status is the provisioning/sync state of the array. | |
| raid_devices | int64 | RaidDevices is the observed active RAID device count. | |
| uuid | string | UUID is the stable MD array UUID. | |
| name | string | Name is the metadata-stamped array name. | |
| metadata | string | Metadata is the MD metadata format/version. | |
| array_state | string | ArrayState is the current sysfs array_state value. | |
| sync_action | string | SyncAction is the current sysfs sync_action value. |
<a name="talos.resource.definitions.storage.MDRefreshRequestSpec"></a>
MDRefreshRequestSpec is the spec for MDRefreshRequest.
| Field | Type | Label | Description |
|---|---|---|---|
| request | int64 |
<a name="resource/definitions/time/time.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="talos.resource.definitions.time.AdjtimeStatusSpec"></a>
AdjtimeStatusSpec describes Linux internal adjtime state.
| Field | Type | Label | Description |
|---|---|---|---|
| offset | google.protobuf.Duration | ||
| frequency_adjustment_ratio | double | ||
| max_error | google.protobuf.Duration | ||
| est_error | google.protobuf.Duration | ||
| status | string | ||
| constant | int64 | ||
| sync_status | bool | ||
| state | string |
<a name="talos.resource.definitions.time.NTPStatusSpec"></a>
NTPStatusSpec describes the state of the NTP client.
| Field | Type | Label | Description |
|---|---|---|---|
| spike_detected | bool | SpikeDetected indicates that the last time measurement was discarded by the spike filter. |
A discarded measurement is not applied to the clock at all, so a filter which keeps rejecting looks exactly like a clock which is never corrected. | | consecutive_spikes | int64 | | ConsecutiveSpikes is the number of time measurements discarded in a row by the spike filter. |
<a name="talos.resource.definitions.time.StatusSpec"></a>
StatusSpec describes time sync state.
This spec is used as a reconcile trigger by other controllers (most notably the
certificate generating ones in the secrets package), so it should only ever carry
fields which change rarely: anything which changes on every NTP poll belongs in
[NTPStatusSpec] instead.
| Field | Type | Label | Description |
|---|---|---|---|
| synced | bool | Synced indicates whether time is in sync. | |
| epoch | int64 | Epoch is incremented every time clock jumps more than 15min. | |
| sync_disabled | bool | SyncDisabled indicates if time sync is disabled. |
<a name="resource/definitions/v1alpha1/v1alpha1.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="talos.resource.definitions.v1alpha1.ServiceSpec"></a>
ServiceSpec describe service state.
| Field | Type | Label | Description |
|---|---|---|---|
| running | bool | ||
| healthy | bool | ||
| unknown | bool |
<a name="resource/network/device_config.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="resource.network.DeviceConfigSpecSpec"></a>
DeviceConfigSpecSpec is the spec for the network.DeviceConfigSpec resource.
| Field | Type | Label | Description |
|---|---|---|---|
| yaml_marshalled | bytes | Contains YAML marshalled device config (as part of the machine config). |
<a name="security/security.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="securityapi.CertificateRequest"></a>
The request message containing the certificate signing request.
| Field | Type | Label | Description |
|---|---|---|---|
| csr | bytes | Certificate Signing Request in PEM format. |
<a name="securityapi.CertificateResponse"></a>
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. |
<a name="securityapi.SecurityService"></a>
The security service definition.
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| Certificate | CertificateRequest | CertificateResponse |
<a name="signer/signer.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="signerapi.CertificateResponse"></a>
CertificateResponse is returned by GetCertificate.
| Field | Type | Label | Description |
|---|---|---|---|
| cert_pem | bytes | PEM-encoded X.509 certificate. |
<a name="signerapi.PublicKeyResponse"></a>
PublicKeyResponse is returned by GetPublicKey.
| Field | Type | Label | Description |
|---|---|---|---|
| pub_key_pem | bytes | PEM-encoded SubjectPublicKeyInfo (PKIX). |
<a name="signerapi.SignRequest"></a>
SignRequest is sent for the Sign RPC.
| Field | Type | Label | Description |
|---|---|---|---|
| digest | bytes | Precomputed digest of the data to sign. Length must match hash. | |
| hash | Hash | Hash algorithm used to produce digest. | |
| scheme | Scheme | Signature scheme the signer should produce. |
<a name="signerapi.SignResponse"></a>
SignResponse is returned by the Sign RPC.
| Field | Type | Label | Description |
|---|---|---|---|
| signature | bytes | Raw signature bytes, modulus-sized. |
<a name="signerapi.Hash"></a>
Hash identifies the digest algorithm used to produce SignRequest.digest.
| Name | Number | Description |
|---|---|---|
| HASH_UNSPECIFIED | 0 | |
| HASH_SHA256 | 1 | |
| HASH_SHA384 | 2 | |
| HASH_SHA512 | 3 |
<a name="signerapi.Scheme"></a>
Scheme identifies the signature algorithm the signer should produce.
| Name | Number | Description |
|---|---|---|
| SCHEME_UNSPECIFIED | 0 | |
| SCHEME_RSA_PKCS1V15 | 1 | |
| SCHEME_RSA_PSS | 2 |
<a name="signerapi.SignerService"></a>
SignerService is implemented by an out-of-process SecureBoot/PCR signer.
The Talos imager opens a gRPC client connection to the signer's Unix socket and calls these RPCs to fetch the signing certificate / public key and to sign digests of the artifacts being built.
A YubiKey-based example implementation is available at: https://github.com/jaakkonen/talos-secureboot
Conventions:
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetCertificate | .google.protobuf.Empty | CertificateResponse | GetCertificate returns the X.509 certificate associated with the signing key, PEM-encoded. |
| GetPublicKey | .google.protobuf.Empty | PublicKeyResponse | GetPublicKey returns the public key associated with the signing key, PEM-encoded as a SubjectPublicKeyInfo (PKIX) block. |
| Sign | SignRequest | SignResponse | Sign produces a signature over the supplied digest. |
<a name="storage/storage.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="storage.BlockDeviceWipe"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata |
<a name="storage.BlockDeviceWipeDescriptor"></a>
BlockDeviceWipeDescriptor represents a single block device to be wiped.
The device can be either a full disk (e.g. vda) or a partition (vda5). The device should not be used in any of active volumes. The device should not be used as a secondary (e.g. part of LVM).
| Field | Type | Label | Description |
|---|---|---|---|
| device | string | Device name to wipe (e.g. sda or sda5). |
The name should be submitted without /dev/ prefix. |
| method | BlockDeviceWipeDescriptor.Method | | Wipe method to use. |
| skip_volume_check | bool | | Skip the volume in use check. |
| skip_secondary_check | bool | | Skip the secondary disk check (e.g. underlying disk for RAID or LVM). |
| drop_partition | bool | | Drop the partition (only applies if the device is a partition). |
<a name="storage.BlockDeviceWipeRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| devices | BlockDeviceWipeDescriptor | repeated |
<a name="storage.BlockDeviceWipeResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | BlockDeviceWipe | repeated |
<a name="storage.Disk"></a>
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. | |
| subsystem | string | Subsystem is the symlink path in the /sys/block/<dev>/subsystem. | |
| readonly | bool | Readonly specifies if the disk is read only. |
<a name="storage.Disks"></a>
DisksResponse represents the response of the Disks RPC.
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| disks | Disk | repeated |
<a name="storage.DisksResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| messages | Disks | repeated |
<a name="storage.BlockDeviceWipeDescriptor.Method"></a>
| Name | Number | Description |
|---|---|---|
| FAST | 0 | Fast wipe - wipe only filesystem signatures. |
| ZEROES | 1 | Zeroes wipe - wipe by overwriting with zeroes (might be slow depending on the disk size and available hardware features). |
<a name="storage.Disk.DiskType"></a>
| Name | Number | Description |
|---|---|---|
| UNKNOWN | 0 | |
| SSD | 1 | |
| HDD | 2 | |
| NVME | 3 | |
| SD | 4 | |
| CD | 5 |
<a name="storage.StorageService"></a>
StorageService represents the storage service.
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| Disks | .google.protobuf.Empty | DisksResponse | |
| BlockDeviceWipe | BlockDeviceWipeRequest | BlockDeviceWipeResponse | BlockDeviceWipe performs a wipe of the blockdevice (partition or disk). |
The method doesn't require a reboot, and it can only wipe blockdevices which are not being used as volumes at the moment. Wiping of volumes requires a different API. |
<!-- end services --><a name="time/time.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="time.Time"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | common.Metadata | ||
| server | string | ||
| localtime | google.protobuf.Timestamp | ||
| remotetime | google.protobuf.Timestamp |
<a name="time.TimeRequest"></a>
The response message containing the ntp server
| Field | Type | Label | Description |
|---|---|---|---|
| server | string |
<a name="time.TimeResponse"></a>
The response message containing the ntp server, time, and offset
| Field | Type | Label | Description |
|---|---|---|---|
| messages | Time | repeated |
<a name="time.TimeService"></a>
The time service definition.
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| Time | .google.protobuf.Empty | TimeResponse | |
| TimeCheck | TimeRequest | TimeResponse |
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
|---|---|---|---|---|---|---|---|---|
| <a name="double" /> double | double | double | float | float64 | double | float | Float | |
| <a name="float" /> float | float | float | float | float32 | float | float | Float | |
| <a name="int32" /> 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) |
| <a name="int64" /> 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 |
| <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
| <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
| <a name="sint32" /> 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) |
| <a name="sint64" /> 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 |
| <a name="fixed32" /> 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) |
| <a name="fixed64" /> 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 |
| <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| <a name="bool" /> bool | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | |
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |