AETHER-3162 Remove magma leftover iptables rule from enodebd
AETHER-3198 Add REUSE compliant to enodebd
AETHER-3196 Support identify IP from X-Real IP in enodebd
AETHER-3229 Documentation of configuration and state machine for enodebd
AETHER-3292 Adding new parameter to support in enodebd Sercomm driver
AETHER-3311 Remove unused protobuf definition from enodebd
Change-Id: Ie69f0141eff70cb3d4447cd9575c8224d42dd5e3
diff --git a/proto_files/orc8r/protos/service303.proto b/proto_files/orc8r/protos/service303.proto
new file mode 100644
index 0000000..143af45
--- /dev/null
+++ b/proto_files/orc8r/protos/service303.proto
@@ -0,0 +1,132 @@
+// SPDX-FileCopyrightText: 2020 The Magma Authors.
+// SPDX-FileCopyrightText: 2022 Open Networking Foundation <support@opennetworking.org>
+//
+// SPDX-License-Identifier: BSD-3-Clause
+
+syntax = "proto3";
+package magma.orc8r;
+
+import "orc8r/protos/common.proto";
+import "orc8r/protos/metricsd.proto";
+import "google/protobuf/wrappers.proto";
+
+option go_package = "magma/orc8r/lib/go/protos";
+
+// --------------------------------------------------------------------------
+// Service status messages
+// --------------------------------------------------------------------------
+
+message EnodebdStatus {
+ // For bools, parameter is not set if result can't be determined
+ google.protobuf.BoolValue enodeb_connected = 1;
+ google.protobuf.BoolValue opstate_enabled = 2;
+ google.protobuf.BoolValue rf_tx_on = 3;
+ google.protobuf.BoolValue gps_connected = 4;
+ google.protobuf.BoolValue ptp_connected = 5;
+ google.protobuf.BoolValue mme_connected = 6;
+ google.protobuf.BoolValue enodeb_configured = 7;
+ google.protobuf.FloatValue gps_latitude = 8;
+ google.protobuf.FloatValue gps_longitude = 9;
+ google.protobuf.BoolValue rf_tx_desired = 10;
+}
+
+message ServiceStatus {
+ // Metadata from the services that will be sent to the cloud through checkin
+ map<string, string> meta = 2;
+}
+
+message ServiceInfo {
+ string name = 1;
+
+ string version = 2;
+
+ enum ServiceState {
+ UNKNOWN = 0;
+ STARTING = 1;
+ ALIVE = 2;
+ STOPPING = 3;
+ STOPPED = 4;
+ }
+ ServiceState state = 3;
+
+ ServiceStatus status = 4;
+
+ // Gives information about whether the application is usable. Though the
+ // process may have started, the connections may not be set up. APP_HEALTHY in
+ // this case means the application is entirely usable
+ enum ApplicationHealth {
+ APP_UNKNOWN = 0;
+ APP_UNHEALTHY = 1;
+ APP_HEALTHY = 2;
+ }
+ ApplicationHealth health = 5;
+
+ // Time when the service was started (in seconds since epoch)
+ uint64 start_time_secs = 6;
+}
+
+message LogLevelMessage {
+ LogLevel level = 1;
+}
+
+message LogVerbosity {
+ int32 verbosity = 1;
+}
+
+message ReloadConfigResponse {
+ enum ReloadConfigResult {
+ RELOAD_UNKNOWN = 0;
+ RELOAD_SUCCESS = 1;
+ RELOAD_FAILURE = 2;
+ RELOAD_UNSUPPORTED = 3;
+ }
+ ReloadConfigResult result = 1;
+}
+
+message State {
+ // Type determines how the value is deserialized and validated on the cloud service side
+ string type = 1;
+ string deviceID = 2;
+ // Value contains the operational state json-serialized.
+ bytes value = 3;
+ uint64 version = 4;
+}
+
+message GetOperationalStatesResponse {
+ repeated State states = 1;
+}
+
+// --------------------------------------------------------------------------
+// Service303 interface definition.
+//
+// Service303 is named after fb303, which was named after TB-303
+// https://en.wikipedia.org/wiki/Roland_TB-303.
+//
+// The Service303 interface implements a set of functionalities which
+// all Magma services expose.
+// --------------------------------------------------------------------------
+service Service303 {
+
+ // Returns the service level info like name, version, state, status, etc.
+ //
+ rpc GetServiceInfo (Void) returns (ServiceInfo) {}
+
+ // Request to stop the service gracefully.
+ //
+ rpc StopService (Void) returns (Void) {}
+
+ // Collects metrics from the service
+ rpc GetMetrics (Void) returns (MetricsContainer) {}
+
+ // Set logging level
+ rpc SetLogLevel (LogLevelMessage) returns (Void) {}
+
+ // Set logging verbosity The larger, the more verbose. default 0
+ rpc SetLogVerbosity (LogVerbosity) returns (Void) {}
+
+ // Requests service reloads config files loaded on startup (<servicename>.yml)
+ rpc ReloadServiceConfig (Void) returns (ReloadConfigResponse) {}
+
+ // Returns the operational states of devices managed by this service.
+ rpc GetOperationalStates (Void) returns (GetOperationalStatesResponse) {}
+}