-
Notifications
You must be signed in to change notification settings - Fork 0
Proposed administrative operations for holium nodes
Note: ignore all descriptions for now, they are copy-pasted from a previous version that didn't account for spaces, will update at first opportunity, but need to document holium node functions (separate page) first
startup-all requires the name of the node to be started up. This command starts up the holium node identity service and its underlying urbit instance, followed by the startup of all spaces, and all spaces' support services that are marked as "durable".
startup-identity requires the name of the node to be started up, and the optional specification of one or more services. This command starts up the holium node identity service and its underlying urbit instance, followed by the startup of zero to n support services. If any specific services are specified, those services should be launched (this is the mechanism for starting specific ephemeral services (by naming them individually), as well as the mechanism for only starting up the identity instance (by specifying no support services)).
startup-space requires the name of the node to be started up, and the optional specification of one or more services. This command starts up the holium node identity service and its underlying urbit instance, followed by the startup of zero to n support services. If any specific services are specified, those services should be launched (this is the mechanism for starting specific ephemeral services (by naming them individually), as well as the mechanism for only starting up the identity instance (by specifying no support services)).
startup-space-services requires the name of the node to be started up, and the optional specification of one or more services. This command starts up the holium node identity service and its underlying urbit instance, followed by the startup of zero to n support services. If any specific services are specified, those services should be launched (this is the mechanism for starting specific ephemeral services (by naming them individually), as well as the mechanism for only starting up the identity instance (by specifying no support services)).
shutdown-all requires the name of the node to be shut down. This command shuts down all support services owned by this node, and then the holium node identity service and its underlying urbit instance.
shutdown-identity requires the name of the node to be shut down. This command shuts down all support services owned by this node, and then the holium node identity service and its underlying urbit instance.
shutdown-space requires the name of the node that owns one or more services to be shut down. This command shuts down the specific services that are named (this is the mechanism for stopping specific ephemeral services (or less commonly, durable services)).
shutdown-space-services requires the name of the node that owns one or more services to be shut down. This command shuts down the specific services that are named (this is the mechanism for stopping specific ephemeral services (or less commonly, durable services)).
verify-all requires the name of the node to be verified. This will return a report indicating the status of the identity service, the underlying urbit instance, and all currently running support services.
verify-identity requires the name of the node to be verified. This will return a report indicating the status of the identity service, the underlying urbit instance, and all currently running support services.
verify-space requires the name of the node to be verified. This will return a report indicating the status of the identity service, the underlying urbit instance, and all currently running support services.
verify-space-services requires the name of the node to be verified, and the optional specification of one or more services. This will return a report indicating the status of the identity service, the underlying urbit instance, and any named services specified in the command.
refresh-all requires the name of the node to be refreshed. Refreshing will update the holium node's cached information about identity and all support services from the underlying urbit instance as a source of truth.
refresh-identity requires the name of the node to be refreshed. Refreshing will update the holium node's cached information about identity and all support services from the underlying urbit instance as a source of truth.
refresh-space requires the name of the node to be refreshed. Refreshing will update the holium node's cached information about identity and all support services from the underlying urbit instance as a source of truth.
refresh-space-services requires the name of the node to be refreshed. Refreshing will update the holium node's cached information about identity and all support services from the underlying urbit instance as a source of truth.
clean runs maintenance operations on the urbit instance associated with a currently shut down holium node. There is never a need to run analogous procedures on the identity or support services, as these can all be reconstituted in full from the urbit data at any time (so use refresh or refresh-all).
configure-identity will create or replace a node's identity configuration with the contents of json_payload and restart it.
configure-space will create or replace a node's configuration for a specific not currently running service with the contents of json_payload. At some level, either in this command or outside of it (but I suspect inside), there will need to be some mechanism to enforce what services and configuration options are available for the named node.
configure-space-service will create or replace a node's configuration for a specific not currently running service with the contents of json_payload. At some level, either in this command or outside of it (but I suspect inside), there will need to be some mechanism to enforce what services and configuration options are available for the named node.