hardware.proto

syntax = "proto3";

option go_package = "hardware";

package github.com.tinkerbell.tink.protos.hardware;

import "google/api/annotations.proto";

service HardwareService {
	rpc Push (PushRequest) returns (Empty) {
		option (google.api.http) = {
            post: "/v1/hardware"
            body: "*"
        };
	};
	rpc ByMAC(GetRequest) returns (Hardware) {
		option (google.api.http) = {
            post: "/v1/hardware/mac"
            body: "*"
        };
	};
	rpc ByIP(GetRequest) returns (Hardware) {
		option (google.api.http) = {
            post: "/v1/hardware/ip"
            body: "*"
        };
	};
	rpc ByID(GetRequest) returns (Hardware) {
		option (google.api.http) = {
            get: "/v1/hardware/{id}"
        };
	};
	rpc All(Empty) returns (stream Hardware) {
		option (google.api.http) = {
            get: "/v1/hardware"
        };
	};
	rpc Watch(GetRequest) returns (stream Hardware);
	rpc Delete(DeleteRequest) returns (Empty);
}

message PushRequest {
	Hardware data = 1;
}

message Empty {
}

message GetRequest {
	string mac = 1;
	string ip = 2;
	string id = 3;
}

message Hardware {
	message DHCP {
		message IP {
			string address = 1;
			string netmask = 2;
			string gateway = 3;
			int64 family = 4;
		}
		string mac = 1;
		string OBSOLETE_ip = 2; // obsolete
		string hostname = 3;
		int64 lease_time = 4;
		repeated string name_servers = 5;
		repeated string time_servers = 6;
		string OBSOLETE_gateway = 7; // obsolete
		string arch = 8;
		bool uefi = 9;
		string iface_name = 10;
		IP ip = 11;
	}
	message Netboot {
		message IPXE {
			string url = 1;
			string contents = 2;
		}
		message Bootstrapper { // obsolete
		}
		message Osie {
			string base_url = 1;
			string kernel = 2;
			string initrd = 3;
		}

		bool allow_pxe = 1;
		bool allow_workflow = 2;
		IPXE ipxe = 3;
		Bootstrapper OBSOLETE_bootstrapper = 4; // obsolete
		Osie osie = 5;
	}
	message Network {
		message Interface {
			DHCP dhcp = 1;
			Netboot netboot = 2;
		}
		DHCP OBSOLETE_dhcp = 1; // obsolete
		Netboot OBSOLETE_netboot = 2; // obsolete
		repeated Interface interfaces = 3;
		Interface OBSOLETE_default = 4; // obsolete
	}
	message Metadata {
		message Manufacturer {
			string id = 1;
			string slug = 2;
		}
		message Instance {
			message OperatingSystem {
				string slug = 1;
				string distro = 2;
				string version = 3;
				string image_tag = 4;
				string os_slug = 5;
			}
			message IP {
				string address = 1;
				string netmask = 2;
				string gateway = 3;
				int64 family = 4;
				bool public = 5;
				bool management = 6;
			}
			message Storage {
				message Disk {
					message Partition {
						string label = 1;
						int64 number = 2;
						int64 size = 3;
						int64 start = 4;
						string type_guid = 5;
					}

					string device = 1;
					bool wipe_table = 2;
					repeated Partition partitions = 3;
				}

				message File {
					string path = 1;
					string contents = 2;
					int64 mode = 3;
					int64 uid = 4;
					int64 gid = 5;
				}

				message Mount {
					message FilesystemOptions {
						bool force = 1;
						repeated string options = 2;
					}

					string device = 1;
					string format = 2;
					repeated File files = 3;
					FilesystemOptions create = 4;
					string point = 5;
				}

				message Filesystem {
					Mount mount = 1;
				}

				message RAID {
					string name = 1;
					string level = 2;
					repeated string devices = 3;
					int64 spare = 4;
				}

				repeated string OBSOLETE_disks = 1; // obsolete
				repeated string OBSOLETE_raid = 2; // obsolete
				repeated string OBSOLETE_filesystems = 3; // obsolete
				repeated Disk disks = 4;
				repeated RAID raid = 5;
				repeated Filesystem filesystems = 6;
			}

			string id = 1;
			string state = 2;
			string hostname = 3;
			bool allow_pxe = 4;
			bool rescue = 5;

			OperatingSystem operating_system_version = 6;
			bool always_pxe = 7;
			string ipxe_script_url = 8;
			repeated IP ips = 9;
			string userdata = 10;

			string crypted_root_password = 11;

			repeated string tags = 12;
			Storage storage = 13;
			repeated string ssh_keys = 14;
			bool network_ready = 15;
		}
		message Custom {
			Instance.OperatingSystem preinstalled_operating_system_version = 1;
			repeated string private_subnets = 2;
		}
		message Facility {
			string plan_slug = 1;
			string plan_version_slug = 2;
			string facility_code = 3;
		}

		string state = 1;
		int64 bonding_mode = 2;
		Manufacturer manufacturer = 3;
		Instance instance = 4;
		Custom custom = 5;
		Facility facility = 6;
	}

	string OBSOLETE_JSON = 1; // obsolete
	DHCP OBSOLETE_dhcp = 2; // obsolete
	Netboot OBSOLETE_netboot = 3; //obsolete
	repeated Network OBSOLETE_network = 4; // obsolete
	Metadata metadata = 5;
	Network network = 6;
	string id = 7;
	int64 version = 8;
}

message DeleteRequest {
	string ID = 1;
}