@serve.zone/interfaces 32.51.0 → 32.52.0

package/ts/requests/node.ts

@@ -150,6 +150,13 @@ export interface IReq_Any_Cloudly_CreateNodeJumpCommand extends plugins.typedreq
     role?: IClusterNode['data']['role'];
     nodeType?: IClusterNode['data']['nodeType'];
     ttlMs?: number;
+    /**
+     * The new node's name (`data.isClusterNodeName`). The setup command names the host
+     * `cloudly-worker-<nodeName>` (`data.deriveDefaultClusterNodeHostname`) before it enrolls, so
+     * the node enrolls under its default hostname. Absent, the node keeps the hostname it has and
+     * its name is proposed from that (`data.proposeClusterNodeName`).
+     */
+    nodeName?: string;
   };
   response: {
     jumpCode: string;
@@ -356,6 +363,66 @@ export interface IReq_Any_Cloudly_SetClusterNodeCorestoreDatabaseEndpoint extend
   };
 }
 
+/**
+ * An administrator renames a node: the static hostname Cloudly wants it to carry
+ * (`IClusterNode.data.hostnameIntent.hostname`).
+ *
+ * The node's name stays as it is: the new intent keeps the name of the node's current intent. A
+ * node without an intent takes the name `data.proposeClusterNodeName(hostname)` (`foo` names the
+ * node `foo`, `cloudly-worker-grasberg` names it `grasberg`), and is refused `name-invalid` when
+ * that is `null`.
+ *
+ * Cloudly records the intent and answers at once; Spark applies the intent of the latest
+ * generation on the host and the node has converged when its report states the new hostname. A new
+ * intent may replace one the node has not converged to, whether it is still applying, failed or
+ * never reached the node. `expectedGeneration` is the generation of the node's current intent, `0`
+ * when it has none, and serializes concurrent changes. Every refusal is one of
+ * `data.clusterNodeHostnameRefusals` and changes nothing.
+ */
+export interface IReq_Any_Cloudly_SetClusterNodeHostname extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_Cloudly_SetClusterNodeHostname
+> {
+  method: 'setClusterNodeHostname';
+  request: {
+    identity: IIdentity;
+    nodeId: string;
+    expectedGeneration: number;
+    /** One lowercase RFC 1123 label (`data.isClusterNodeHostname`). */
+    hostname: string;
+  };
+  response: {
+    /** The node as it now stands, carrying the new intent. */
+    node: IClusterNode;
+  };
+}
+
+/**
+ * An administrator resets a node to the default scheme: hostname `cloudly-worker-<name>`
+ * (`data.deriveDefaultClusterNodeHostname`).
+ *
+ * `name` replaces the node's name when stated; absent, the name of the node's current intent is
+ * used, and a node without an intent is refused `name-invalid`. Recorded, applied and replaceable
+ * exactly like `setClusterNodeHostname`, with the same refusals.
+ */
+export interface IReq_Any_Cloudly_ResetClusterNodeHostname extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_Cloudly_ResetClusterNodeHostname
+> {
+  method: 'resetClusterNodeHostname';
+  request: {
+    identity: IIdentity;
+    nodeId: string;
+    expectedGeneration: number;
+    /** The node's name (`data.isClusterNodeName`). */
+    name?: string;
+  };
+  response: {
+    /** The node as it now stands, carrying the new intent. */
+    node: IClusterNode;
+  };
+}
+
 export interface IReq_Any_Cloudly_CreateNodeAction extends plugins.typedrequestInterfaces.implementsTR<
   plugins.typedrequestInterfaces.ITypedRequest,
   IReq_Any_Cloudly_CreateNodeAction