CP-54476 Merge ntp disable/enable to ntp mode (#6765)

As the doc PR #6745 shows,
the enable/disable ntp APIs and host.ntp_enabled field can be merged
into host.ntp_mode.
Now, the ntp modes are DHCP, Custom, Factory and Disabled.
This PR also updates the datamodel lifecycle and bumps up the schema.

Author: changlei-li

doc/content/design/host-ntp-time.md

@@ -38,8 +38,7 @@ cache for the getter APIs.
 
 New fields:  
 `host.ntp_mode`, enum host_ntp_mode(DHCP, Custom, Factory, Disabled)  
-`host.ntp_custom_servers`, string set  
-`host.ntp_enabled`, bool  
+`host.ntp_custom_servers`, string set
 
 New APIs: `host.set_ntp_mode`, `host.set_ntp_custom_servers`, `host.get_ntp_mode`,
 `host.get_ntp_custom_servers`, `host.get_ntp_servers_status`
@@ -201,7 +200,6 @@ host.timezone
 host.set_timezone
 host.list_timezones
 host.get_timezone
-host.get_ntp_enabled
 host.get_ntp_synchronized
 host.set_ntp_mode
 host.get_ntp_mode

ocaml/idl/datamodel_common.ml

@@ -10,7 +10,7 @@ open Datamodel_roles
               to leave a gap for potential hotfixes needing to increment the schema version.*)
 let schema_major_vsn = 5
 
-let schema_minor_vsn = 791
+let schema_minor_vsn = 792
 
 (* Historical schema versions just in case this is useful later *)
 let rio_schema_major_vsn = 5

ocaml/idl/datamodel_host.ml

@@ -2579,11 +2579,10 @@ let host_ntp_mode =
   Enum
     ( "host_ntp_mode"
     , [
-        ("ntp_mode_dhcp", "Using NTP servers assigned by DHCP to sync time")
-      ; ( "ntp_mode_custom"
-        , "Using custom NTP servers configured by user to sync time"
-        )
-      ; ("ntp_mode_default", "Using default NTP servers to sync time")
+        ("DHCP", "Using NTP servers assigned by DHCP to sync time")
+      ; ("Custom", "Using custom NTP servers configured by user to sync time")
+      ; ("Factory", "Using built-in NTP servers to sync time")
+      ; ("Disabled", "NTP is disabled on the host")
       ]
     )
 
@@ -2606,16 +2605,6 @@ let set_ntp_custom_servers =
       ]
     ~allowed_roles:_R_POOL_OP ()
 
-let disable_ntp =
-  call ~name:"disable_ntp" ~lifecycle:[] ~doc:"Disable NTP on the host"
-    ~params:[(Ref _host, "self", "The host")]
-    ~allowed_roles:_R_POOL_OP ()
-
-let enable_ntp =
-  call ~name:"enable_ntp" ~lifecycle:[] ~doc:"Enable NTP on the host"
-    ~params:[(Ref _host, "self", "The host")]
-    ~allowed_roles:_R_POOL_OP ()
-
 let get_ntp_servers_status =
   call ~name:"get_ntp_servers_status" ~lifecycle:[]
     ~doc:"Get the NTP servers status on the host"
@@ -2822,8 +2811,6 @@ let t =
       ; set_max_cstate
       ; set_ntp_mode
       ; set_ntp_custom_servers
-      ; disable_ntp
-      ; enable_ntp
       ; get_ntp_servers_status
       ; set_timezone
       ; list_timezones
@@ -3297,15 +3284,12 @@ let t =
             ~default_value:(Some (VBool false)) "secure_boot"
             "Whether the host has booted in secure boot mode"
         ; field ~qualifier:DynamicRO ~lifecycle:[] ~ty:host_ntp_mode
-            ~default_value:(Some (VEnum "ntp_mode_dhcp")) "ntp_mode"
+            ~default_value:(Some (VEnum "Factory")) "ntp_mode"
             "Indicates NTP servers are assigned by DHCP, or configured by \
-             user, or the default servers"
+             user, or the factory servers, or NTP is disabled"
         ; field ~qualifier:DynamicRO ~lifecycle:[] ~ty:(Set String)
             ~default_value:(Some (VSet [])) "ntp_custom_servers"
-            "The set of NTP servers configured for the host"
-        ; field ~qualifier:DynamicRO ~lifecycle:[] ~ty:Bool
-            ~default_value:(Some (VBool false)) "ntp_enabled"
-            "Reflects whether NTP is enabled on the host"
+            "Custom NTP servers configured by users, used in Custom NTP mode"
         ; field ~qualifier:DynamicRO ~lifecycle:[] ~ty:String
             ~default_value:(Some (VString "UTC")) "timezone"
             "The time zone identifier as defined in the IANA Time Zone Database"

ocaml/idl/datamodel_lifecycle.ml

@@ -97,8 +97,16 @@ let prototyped_of_field = function
       Some "22.26.0"
   | "SM", "host_pending_features" ->
       Some "24.37.0"
+  | "host", "timezone" ->
+      Some "25.37.0-next"
+  | "host", "ntp_custom_servers" ->
+      Some "25.37.0-next"
+  | "host", "ntp_mode" ->
+      Some "25.37.0-next"
   | "host", "secure_boot" ->
       Some "25.31.0"
+  | "host", "max_cstate" ->
+      Some "25.37.0-next"
   | "host", "ssh_auto_mode" ->
       Some "25.27.0"
   | "host", "console_idle_timeout" ->
@@ -225,6 +233,22 @@ let prototyped_of_message = function
       Some "22.26.0"
   | "VTPM", "create" ->
       Some "22.26.0"
+  | "host", "set_servertime" ->
+      Some "25.37.0-next"
+  | "host", "get_ntp_synchronized" ->
+      Some "25.37.0-next"
+  | "host", "list_timezones" ->
+      Some "25.37.0-next"
+  | "host", "set_timezone" ->
+      Some "25.37.0-next"
+  | "host", "get_ntp_servers_status" ->
+      Some "25.37.0-next"
+  | "host", "set_ntp_custom_servers" ->
+      Some "25.37.0-next"
+  | "host", "set_ntp_mode" ->
+      Some "25.37.0-next"
+  | "host", "set_max_cstate" ->
+      Some "25.37.0-next"
   | "host", "update_firewalld_service_status" ->
       Some "25.34.0"
   | "host", "get_tracked_user_agents" ->

ocaml/idl/schematest.ml

@@ -3,7 +3,7 @@ let hash x = Digest.string x |> Digest.to_hex
 (* BEWARE: if this changes, check that schema has been bumped accordingly in
    ocaml/idl/datamodel_common.ml, usually schema_minor_vsn *)
 
-let last_known_schema_hash = "c72edb27945bceb074de3fa54381ddd4"
+let last_known_schema_hash = "d8cb04ccddfd91ca3f0f9074dcf7c219"
 
 let current_schema_hash : string =
   let open Datamodel_types in

ocaml/tests/common/test_common.ml

@@ -224,8 +224,8 @@ let make_host2 ~__context ?(ref = Ref.make ()) ?(uuid = make_uuid ())
     ~pending_guidances_recommended:[] ~pending_guidances_full:[]
     ~last_update_hash:"" ~ssh_enabled:true ~ssh_enabled_timeout:0L
     ~ssh_expiry:Date.epoch ~console_idle_timeout:0L ~ssh_auto_mode:false
-    ~max_cstate:"" ~secure_boot:false ~ntp_mode:`ntp_mode_dhcp
-    ~ntp_custom_servers:[] ~ntp_enabled:false ~timezone:"UTC" ;
+    ~max_cstate:"" ~secure_boot:false ~ntp_mode:`Factory ~ntp_custom_servers:[]
+    ~timezone:"UTC" ;
   ref
 
 let make_pif ~__context ~network ~host ?(device = "eth0")

ocaml/xapi-cli-server/cli_frontend.ml

@@ -1098,24 +1098,6 @@ let rec cmdtable_data : (string * cmd_spec) list =
       ; flags= [Neverforward]
       }
     )
-  ; ( "host-enable-ntp"
-    , {
-        reqd= []
-      ; optn= []
-      ; help= "Enable ntp service on the host."
-      ; implementation= No_fd Cli_operations.host_enable_ntp
-      ; flags= [Host_selectors]
-      }
-    )
-  ; ( "host-disable-ntp"
-    , {
-        reqd= []
-      ; optn= []
-      ; help= "Disable ntp service on the host."
-      ; implementation= No_fd Cli_operations.host_disable_ntp
-      ; flags= [Host_selectors]
-      }
-    )
   ; ( "patch-upload"
     , {
         reqd= ["file-name"]

ocaml/xapi-cli-server/cli_operations.ml

@@ -7820,26 +7820,6 @@ let host_disable_ssh _printer rpc session_id params =
        params []
     )
 
-let host_enable_ntp _printer rpc session_id params =
-  ignore
-    (do_host_op rpc session_id
-       (fun _ host ->
-         let host = host.getref () in
-         Client.Host.enable_ntp ~rpc ~session_id ~self:host
-       )
-       params []
-    )
-
-let host_disable_ntp _printer rpc session_id params =
-  ignore
-    (do_host_op rpc session_id
-       (fun _ host ->
-         let host = host.getref () in
-         Client.Host.disable_ntp ~rpc ~session_id ~self:host
-       )
-       params []
-    )
-
 module SDN_controller = struct
   let introduce printer rpc session_id params =
     let port =

ocaml/xapi-cli-server/records.ml

@@ -3423,9 +3423,6 @@ let host_record rpc session_id host =
                 )
           )
           ()
-      ; make_field ~name:"ntp_enabled"
-          ~get:(fun () -> string_of_bool (x ()).API.host_ntp_enabled)
-          ()
       ; make_field ~name:"timezone"
           ~get:(fun () -> (x ()).API.host_timezone)
           ~set:(fun value ->

ocaml/xapi/message_forwarding.ml

@@ -4152,18 +4152,6 @@ functor
         let remote_fn = Client.Host.set_ntp_custom_servers ~self ~value in
         do_op_on ~local_fn ~__context ~host:self ~remote_fn
 
-      let enable_ntp ~__context ~self =
-        info "Host.enable_ntp: host='%s'" (host_uuid ~__context self) ;
-        let local_fn = Local.Host.enable_ntp ~self in
-        let remote_fn = Client.Host.enable_ntp ~self in
-        do_op_on ~local_fn ~__context ~host:self ~remote_fn
-
-      let disable_ntp ~__context ~self =
-        info "Host.disable_ntp: host='%s'" (host_uuid ~__context self) ;
-        let local_fn = Local.Host.disable_ntp ~self in
-        let remote_fn = Client.Host.disable_ntp ~self in
-        do_op_on ~local_fn ~__context ~host:self ~remote_fn
-
       let get_ntp_servers_status ~__context ~self =
         info "Host.get_ntp_servers_status: host = '%s'"
           (host_uuid ~__context self) ;
@@ -4195,7 +4183,7 @@ functor
         info "Host.set_servertime : host = '%s'; value = '%s'"
           (host_uuid ~__context self)
           (Clock.Date.to_rfc3339 value) ;
-        if Db.Host.get_ntp_enabled ~__context ~self then
+        if Db.Host.get_ntp_mode ~__context ~self <> `Disabled then
           raise
             (Api_errors.Server_error
                (Api_errors.not_allowed_when_ntp_is_enabled, [Ref.string_of self])