github.com/cloudwan/edgelq-sdk@v1.15.4/devices/proto/v1/device.proto

syntax = "proto3";

package ntt.devices.v1;

import "edgelq-sdk/common/api/healthcheck.proto";
import "edgelq-sdk/iam/proto/v1/common.proto";
import "google/api/resource.proto";
import "google/protobuf/duration.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
import "google/type/latlng.proto";
import "goten-sdk/types/meta.proto";

option go_package = "github.com/cloudwan/edgelq-sdk/devices/resources/v1/device;device";
option java_multiple_files = true;
option java_outer_classname = "DeviceProto";
option java_package = "com.ntt.devices.pb.v1";

// Device Resource
message Device {
  option (google.api.resource) = {
    type : "devices.edgelq.com/Device"
    pattern : "projects/{project}/regions/{region}/devices/{device}"
  };

  // Name of Device
  // When creating a new instance, this field is optional and if not provided,
  // it will be generated automatically. Last ID segment must conform to the
  // following regex: [a-z][a-z0-9\\-]{0,28}[a-z0-9]
  string name = 1;

  // Metadata is an object with information like create, update and delete time
  // (for async deleted resources), has user labels/annotations, sharding
  // information, multi-region syncing information and may have non-schema
  // owners (useful for taking ownership of resources belonging to lower level
  // services by higher ones).
  goten.types.Meta metadata = 2;

  // Display name for the device
  string display_name = 6;

  // Optional. Description of the Device.
  string description = 7;

  // Spec holds the expected state of the Device, meaning configurations.
  Spec spec = 3;

  // Status of the Device reported from the actual device.
  Status status = 4;

  PublicListingSpec public_listing_spec = 5;

  message Spec {
    // The associated service account to the Device.
    // The agents in the device uses a key from this service account
    // when they issue any requests to our endpoints for authoroization and
    // authentication. `ProvisionServiceAccountToDevice` creates a new service
    // account and a key for the Device and asign the account to this fileld. If
    // you change the value of this field, the existing device would lose the
    // access to the resources in our services, that means you can revoke the
    // permissions from the device. You can manually set an empty value to do
    // so, or call `RemoveServiceAccountFromDevice`.
    string service_account = 1;

    // Logging bucket associated with device
    string log_bucket = 14;

    // Monitoring metrics bucket associated with device
    string metrics_bucket = 15;

    // The expected OS version in string (e.g. 1.0.2).
    // The device will automatically download the OS image and upgrade itself
    // with it. You can stack the OS upgrade progress in the Condition named
    // `OSReady` in Status.Conditions.
    string os_version = 2;

    string netplan_yaml_config = 17;

    NetworkConfigMode netplan_api_config_mode = 12;

    // The URL is dynamically constructed once the device is created or updated.
    // The URL will be based on the device hardware information
    // URL format: base_url/dedicated_path/iso_version/architecture/os_type
    string os_image_url = 5;

    SSHConfig ssh_config = 6;

    AttestationConfig attestation_config = 7;

    // Disables the daemon on the device for device auto discovery on the
    // network. When it's enabled, avahi-daemon is launched on the device which
    // listens at UDP 5353. This daemon is useful to locate the device that
    // acquires an IP address with DHCP.
    bool disable_device_discovery = 8;

    LoggingConfig logging_config = 9;

    ProxyConfig proxy_config = 10;

    Location location = 13;

    USBGuard usb_guard = 16;

    // Custom Health checks for device
    repeated ntt.api.HealthCheckSpec health_checks = 18;

    // If enabled, the default network configuration that was part of the
    // initial disk image will never be used. This needs to be used with caution
    // because clearing this flag would require access to device over console
    // port or by connecting a Monitor to it.
    bool disable_network_config_fallback = 19;

    // SSHConfig defines the ssh configuration for the Device.
    message SSHConfig {
      bool disable_ssh_server = 1;

      bool disable_ssh_password = 2;

      repeated AuthKey ssh_authorized = 3;

      repeated string ip_allow_list = 4;

      repeated string ip_deny_list = 5;

      google.protobuf.Duration reject_period = 6;

      bool disable_ssh_authkey = 7;

      message AuthKey {
        string ssha_key = 1;

        bool cert_authority = 2;

        string command = 3;

        string environment = 4;

        string from = 5;

        bool no_agent_forwarding = 6;

        bool no_port_forwarding = 7;

        bool no_pty = 8;

        bool no_user_rc = 9;

        bool no_x11_forwarding = 10;

        string permitopen = 11;

        string principals = 12;

        string tunnel = 13;

        bool restrict = 14;
      }
    }

    message AttestationConfig {
      // If true, the droplet will try to attest itself.
      bool attestation_expected = 1;

      // Attestation domain for device attestation.
      string attestation_domain = 2;

      reserved 3;
    }

    message LoggingConfig {
      // Log priority as understood by systemd (0 - emergency, 1 - alert, 2 -
      // critical, 3 - error, 4 - warning, 5 - notice, 6 - informational, 7 -
      // debug). Journal logs with this priority and higher will be uploaded to
      // the server.
      int32 priority = 1;

      // List of systemd unit names to monitor for logs, e.g.
      // NetworkManager.service, docker.service.
      // Leave empty to export all journald logs.
      repeated string units = 2;

      // Whether the journald log exporter is enabled.
      bool enable_journal_export = 3;

      ContainerLoggingConfig container_logging_config = 4;

      // Configuration to control how container log export is handled
      // Only enable option is available now
      message ContainerLoggingConfig {
        // Enable container log export. Default is disabled
        bool enable_container_log_export = 1;
      }
    }

    message ProxyConfig {
      string http_proxy = 1;

      string https_proxy = 2;

      string no_proxy = 3;

      // By default proxy is applicable for all interfaces
      // configuring proxy_interfaces allows to restrict proxy setting to be
      // used only with specific interfaces At present this is only used for
      // Control Plane (for eg LTE fallback)
      repeated string proxy_interfaces = 4;
    }

    // Device location of the device.
    message Location {
      string address = 1;

      string placement = 2;
    }

    // USB Guard. When enable is not set, USB guard service will not be started.
    // When it is enabled, we can specify allowed device white list with
    // WhiteList. Each device can be specified one of Device Name, Device ID or
    // connected port number. We can specify multiple parameter for a device.
    message USBGuard {
      // Enable USB Guard service on the device.
      bool enable = 1;

      // This is array of white list of the USB devices.
      repeated WhiteList white_list = 2;

      // USB match operator for "via-port".
      message Port {
        repeated string equals = 1;

        repeated string one_of = 2;
      }

      // USB match operator for "with-interface".
      message Interface {
        repeated string equals = 1;

        repeated string one_of = 2;
      }

      // This is array of white list of the USB devices.
      message WhiteList {
        // USB device name to be allowed to connect.
        string device_name = 1;

        // USB device id to be allowed to connect.
        string device_id = 2;

        // USB port to be allowed to connect.
        Port via_port = 3;

        // USB interface to be allowed to connect.
        Interface with_interface = 4;

        // USB connect type to be allowed to connect.
        string with_connect_type = 5;
      }
    }

    // MERGE or REPLACE the api netplan_config with the baked in config in the
    // device. REPLACE - The desired configuration must be input in full. The
    // default config in disk will not be used. MERGE - Replaces level keys such
    // as ethernet, modems, wifis etc that are defined in API config. Merge
    // makes it easier to add new types of configuration - for example if the
    // default configuration does not have wifis, it is easier to just add wifi
    // config alone in API and use config mode merge. However, if the goal is to
    // add to or replace a specific configuration in a section that already
    // exists in the default configuration, then the API config should have the
    // entire section and not just the changes for example if the default config
    // on disk has eno1, eno2 under ethernet section and the goal is to replace
    // the eno2 on disk, then the API configuration should specify both eno1 and
    // eno2. This is because the merge mode still replaces whole sections that
    // are defined in the API config
    enum NetworkConfigMode {
      MERGE = 0;

      REPLACE = 1;
    }

    reserved 11, 4;
  }

  message Status {
    // List of network addresses.
    repeated Address addresses = 1;

    // List of conditions of the Device.
    repeated Condition conditions = 2;

    NetworkConfigState network_config_state = 105;

    ProxyConfigStatus proxy_config_status = 106;

    // Device detailed information
    DeviceInfo device_info = 3;

    repeated ntt.iam.v1.PCR attestation_status = 4;

    // Normalized Address.
    NormalizedAddress normalized_address = 5;

    ConnectionStatus connection_status = 6;

    // Last change of connection_status
    google.protobuf.Timestamp connection_status_change_time = 7;

    // Interface addresses of the Device.
    message Address {
      // IPv4 or IPv6 address such as `203.0.113.5` (no suffix for subnet)
      string address = 1;

      // Always `InternalIP`
      string type = 2;
    }

    // Condition holds status of each sub component or module of the device.
    message Condition {
      // The message describes the status.
      string message = 1;

      // The reason for the status.
      string reason = 2;

      // The status name.
      string status = 3;

      // Type name of the status.
      string type = 4;

      // When the status has been updated last time.
      // Deprecated
      google.protobuf.Timestamp last_heart_beat_time = 5;

      // When the status has tuned into the current value.
      google.protobuf.Timestamp last_transition_time = 6;
    }

    message NetworkConfigState {
      NetworkConfigSource active_network_config_source = 1;

      NetworkConfigSource desired_network_config_source = 2;

      string desired_network_config_error = 3;

      string default_netplan_config = 7;

      string active_netplan_config = 8;

      string desired_netplan_config = 9;

      enum NetworkConfigSource {
        UNKNOWN = 0;

        DEFAULT_CONFIG = 1;

        API_CONFIG = 2;

        MERGED_DEFAULT_AND_API_CONFIG = 3;

        PREVIOUS_MERGED_DEFAULT_AND_API_CONFIG = 4;

        PREVIOUS_API_CONFIG = 5;
      }

      reserved 4, 5, 6;
    }

    message ProxyConfigStatus {
      ProxyConfigSource active_config_source = 1;

      ProxyConfigSource desired_config_source = 2;

      string proxy_config_error = 3;

      Spec.ProxyConfig default_config = 4;

      Spec.ProxyConfig active_config = 5;

      Spec.ProxyConfig api_config = 6;

      enum ProxyConfigSource {
        NO_CONFIG = 0;

        DEFAULT_CONFIG = 1;

        API_CONFIG = 2;
      }
    }

    // Device Information
    message DeviceInfo {
      // The architecture of the CPU (and the software compilied for) (e.g.
      // `arm64`)
      string architecture = 1;

      // The platform hardware (e.g. `raspberry`, `generic`)
      string hardware = 7;

      // Base OS name (e.g. `Linux`)
      string operating_system = 2;

      // OS kernel version
      string kernel_version = 3;

      // OS base Image name
      string os_image = 4;

      // Not used
      string container_runtime_version = 5;

      // Liquid OS version currently used.
      string os_version = 6;

      // Container driver name (e.g. `/var/lib/droplet/compose`)
      string driver = 101;

      HardwareInformation hardware_information = 102;

      map<string, NetworkInterface> network_interfaces = 103;

      ControlPlaneInterfaceInfo control_plane_interface_info = 104;

      message HardwareInformation {
        OS os = 1;

        BIOS bios = 2;

        System system = 3;

        CPU cpu = 4;

        Block block = 5;

        Network network = 6;

        GPU gpu = 7;

        MemoryInfo memory_info = 23;

        HailoInfo hailo_info = 20;

        NvidiaInfo nvidia_info = 21;

        repeated ModemStatus modem_status = 22;

        message Capability {
          string name = 1;

          string description = 2;
        }

        message OS {
          string operating_system = 1;

          string kernel_version = 2;

          string os_image = 3;

          string container_runtime_version = 4;
        }

        // TODO: Add capabilities and size
        message BIOS {
          string vendor = 1;

          string bios_version = 2;

          string release_date = 3;
        }

        message System {
          string manufacturer = 1;

          string product_name = 2;

          string version = 3;

          string serial_number = 4;

          Configuration configuration = 5;

          message Configuration {
            string chassis = 1;

            string uuid = 2;

            string sku_number = 3;

            string family = 4;
          }
        }

        message CPU {
          repeated Processor processors = 1;

          message Processor {
            string vendor = 1;

            string model = 2;

            repeated Capability capabilities = 3;

            uint32 num_threads = 4;

            uint32 num_cores = 5;

            uint32 num_enabled_cores = 6;

            string name = 7;

            string serial = 8;

            int64 frequency_mhz = 9;

            int64 max_frequency_mhz = 10;

            repeated Cache cache_info = 11;

            string driver = 12;

            int64 latency = 13;

            int64 clock = 14;

            message Cache {
              string type = 1;

              int64 size_bytes = 2;
            }
          }
        }

        message Block {
          repeated Disk disks = 1;

          message Disk {
            string name = 1;

            int64 size_bytes = 2;

            string drive_type = 3;

            string vendor = 4;

            string model = 5;

            string serial_number = 6;

            string wwn = 7;

            repeated Partition partitions = 8;

            message Partition {
              string name = 1;

              int64 size_bytes = 2;

              string mount_point = 3;

              string type = 4;
            }
          }
        }

        message Network {
          repeated NIC nics = 1;

          message NIC {
            string name = 1;

            string mac_address = 2;

            bool virtual = 3;

            string description = 4;

            string product_name = 5;

            string vendor = 6;

            string subvendor = 7;

            map<string, string> setting = 8;
          }
        }

        message GPU {
          repeated GraphicCard graphic_cards = 1;

          message GraphicCard {
            int64 index = 1;

            PCIDevice device = 2;
          }
        }

        // Revisit: May be just device ??
        message PCIDevice {
          string address = 1;

          string vendor = 2;

          string product = 3;

          string name = 4;

          string subvendor = 5;
        }

        message MemoryInfo {
          string description = 1;

          int64 size_bytes = 2;

          repeated MemoryBank memory_banks = 3;

          message MemoryBank {
            string description = 1;

            string product = 2;

            string vendor = 3;

            string serial = 4;

            string slot = 5;

            int64 size_bytes = 6;

            int64 frequency_hz = 7;

            int32 width_bits = 8;
          }
        }

        message HailoInfo {
          string status = 1;

          string cli_version = 2;

          repeated HailoModuleInfo modules = 10;

          message HailoModuleInfo {
            string dev_id = 1;

            string control_proto_version = 2;

            string firmware_version = 3;

            string logger_version = 4;

            string board_name = 5;

            string serial_number = 6;

            string part_number = 7;

            string product_name = 8;

            string neural_network_core_clock_rate = 9;
          }
        }

        message NvidiaInfo {
          string status = 1;

          string driver_version = 2;

          string cuda_version = 3;

          repeated GpuInfo gpus = 10;

          message GpuInfo {
            string id = 1;

            string product_name = 2;
          }
        }

        message ModemStatus {
          Modem modem = 1;

          message RegistrationSettings {
            string drx_cycle = 1;

            string mico_mode = 2;
          }

          message FiveGNr { RegistrationSettings registration_settings = 1; }

          message Settings {
            string apn = 1;

            string ip_type = 2;

            string password = 3;

            string user = 4;
          }

          message InitialBearer {
            string dbus_path = 1;

            Settings settings = 2;
          }

          message Eps {
            InitialBearer initial_bearer = 1;

            string ue_mode_operation = 2;
          }

          message ThreeGpp {
            FiveGNr fiveg_nr = 1;

            repeated string enabled_locks = 2;

            Eps eps = 3;

            string imei = 4;

            string operator_code = 5;

            string operator_name = 6;

            string packet_service_state = 7;

            string pco = 8;

            string registration_state = 9;
          }

          message Cdma {
            string activation_state = 1;

            string cdma1x_registration_state = 2;

            string esn = 3;

            string evdo_registration_state = 4;

            string meid = 5;

            string nid = 6;

            string sid = 7;
          }

          message SignalQuality {
            string recent = 1;

            string value = 2;
          }

          message Generic {
            repeated string access_technologies = 1;

            repeated string bearers = 2;

            string carrier_configuration = 3;

            string carrier_configuration_revision = 4;

            repeated string current_bands = 5;

            repeated string current_capabilities = 6;

            string current_modes = 7;

            string device = 8;

            string device_identifier = 9;

            repeated string drivers = 10;

            string equipment_identifier = 11;

            string hardware_revision = 12;

            string manufacturer = 13;

            string model = 14;

            repeated string own_numbers = 15;

            string plugin = 16;

            repeated string ports = 17;

            string power_state = 18;

            string primary_port = 19;

            string primary_sim_slot = 20;

            string revision = 21;

            SignalQuality signal_quality = 22;

            string sim = 23;

            repeated string sim_slots = 24;

            string state = 25;

            string state_failed_reason = 26;

            repeated string supported_bands = 27;

            repeated string supported_capabilities = 28;

            repeated string supported_ip_families = 29;

            repeated string supported_modes = 30;

            string unlock_required = 31;

            repeated string unlock_retries = 32;
          }

          message SimStatus {
            string dbus_path = 1;

            string active = 2;

            string eid = 3;

            repeated string emergency_numbers = 4;

            string esim_status = 5;

            string gid1 = 6;

            string gid2 = 7;

            string iccid = 8;

            string imsi = 9;

            string operator_code = 10;

            string operator_name = 11;

            string removability = 12;

            string sim_type = 13;
          }

          message Modem {
            ThreeGpp three_g_pp = 1;

            Cdma cdma = 2;

            string dbus_path = 3;

            Generic generic = 4;

            map<string, SimStatus> sim_status = 7;

            reserved 5, 6;
          }
        }

        reserved 8;
      }

      // Network Interface
      message NetworkInterface {
        string interface_name = 1;

        repeated string ip_address_v4 = 2;

        repeated string external_ip_address_v4 = 3;

        repeated string ip_address_v6 = 4;

        repeated string external_ip_address_v6 = 5;

        // Asinfo describes the ISP (ASN) details for the interface
        // This is resolved automatically from the external_ip_address.
        ASInfo as_info = 10;

        // Carrier.
        Carrier carrier = 14;

        message ASInfo {
          // AS Number string example AS7018
          string asn = 1;

          // AS Owner name example AT&T Services, Inc.
          string name = 2;

          // Domain name example att.com
          string domain = 3;

          // Routes exported from this ASN example 12.128.0.0/9
          repeated string routes = 4;

          // ASN Owner type example isp(AT&T) / hosting(google)/ business
          // (Amazon)
          string asn_type = 5;
        }

        message Carrier {
          // Mobile network carrier name example AT&T
          string name = 1;

          // Mobile country code example 214
          string mobile_country_code = 2;

          // Mobile network code example 7
          string mobile_network_code = 3;

          // Mobile location area code example 2862
          string location_area_code = 4;
        }
      }

      message ControlPlaneInterfaceInfo {
        string active_control_plane_interface = 1;

        bool usesProxy = 2;

        // is_fallback would be true if droplet could not connect using the best
        // default route and explicitly uses this interface to connect to api
        // endpoint
        bool is_fallback = 3;
      }
    }

    message NormalizedAddress {
      // Postal code
      string postal_code = 1;

      // Country code example US, JP
      string country_code = 2;

      // Continent, e.g. North America, Asia
      string continent = 3;

      string continent_id = 4;

      // Country name example United States, Japan
      string country = 5;

      string country_id = 6;

      // Probe Location Administrative Area level 1 name, e.g. California
      // (state), Chiba (prefecture)
      string admin_area1 = 7;

      string admin_area1_id = 8;

      // Probe Location Administrative Area level 2 name, e.g. Santa Clara
      // (county), Tateyama (town)
      string admin_area2 = 9;

      string admin_area2_id = 10;

      // Probe Location Administrative Area level 3 name, e.g. Sunnyvale (city)
      string admin_area3 = 11;

      string admin_area3_id = 12;

      // Probe Location Administrative Area level 4 name, e.g. Sunnyvale (city)
      string admin_area4 = 13;

      string admin_area4_id = 14;

      // Original address.
      string address = 15;

      // coordinates
      google.type.LatLng coordinates = 16;

      // location accuracy in meters
      double accuracy = 17;
    }

    enum ConnectionStatus {
      CONNECTION_STATUS_UNSPECIFIED = 0;

      CONNECTED = 1;

      DISCONNECTED = 2;
    }
  }

  message PublicListingSpec {
    bool enabled = 1;

    google.protobuf.FieldMask field_mask = 2;
  }
}