def __init__(self):
super(HostsController, self).__init__()
self._audit = AuditHelper(self, "<org_name> <env_name> <res_name>")
# subcontrollers
self._register_subcontroller(["settings"], HostSettingsController())
self._register_subcontroller(["instance"], InstancesController())
self._register_subcontroller(["applications"], ApplicationContextController())
self._register_subcontroller(["distribution"], DistributionContextController())
self._register_subcontroller(["platform"], PlatformContextController())
self._register_subcontroller(["compliance"], ComplianceController())
self._register_subcontroller(["changes"], ChangeController())
self._register_subcontroller(["alerts"], MonitoringAlertController())
self._register_subcontroller(["live"], LiveController())
# actions
self._register(["provision"], self._provision, self._print_entity_completions)
self._register(["render-tree"], self._render_tree, self._print_tree_completions)
self._register(["clone"], self._clone, self._print_entity_completions)
self._register(["audit"], self._audit.audit, self._print_entity_completions)
self._register(["vnc"], self._vnc, self._print_entity_completions)
self._doc = "Hosts handling."
self._update_action_doc_params("list", "<org_name> <env_name>")
self._update_action_doc_params("add", "<org_name> <env_name>")
self._update_action_doc_params("delete", "<org_name> <env_name> <res_name>")
self._update_action_doc_params("update", "<org_name> <env_name> <res_name>")
self._update_action_doc_params("show", "<org_name> <env_name> <res_name>")
self._register_action_doc(self._provision_doc())
self._register_action_doc(self._render_tree_doc())
self._register_action_doc(self._clone_doc())
self._register_action_doc(self._audit.audit_doc())
self._register_action_doc(self._vnc_doc())
def __init__(self):
super(OrganizationsController, self).__init__()
self._audit = AuditHelper(self, "<res_name>")
# actions
self._register(["import"], self._import,
self._print_import_completions)
self._register(["export"], self._export,
self._print_export_completions)
self._register(["reset-secret"], self._reset_secret,
self._print_entity_completions)
self._register(["audit"], self._audit.audit,
self._print_entity_completions)
self._register_action_doc(self._audit.audit_doc())
self._register_action_doc(self._export_doc())
self._register_action_doc(self._import_doc())
self._register_action_doc(self._reset_secret_doc())
self._register_action_doc(self._audit.audit_doc())
# subcontrollers
self._register_subcontroller(["settings"],
OrganizationSettingsController())
self._register_subcontroller(["groups"], GroupsController())
self._doc = "Organizations handling."
def __init__(self):
super(EnvironmentsController, self).__init__()
self._audit = AuditHelper(self, "<org_name> <res_name>")
# subcontrollers
self._register_subcontroller(["settings"], EnvironmentSettingsController())
# actions
self._register(["import"], self._import, self._print_import_completions)
self._register(["audit-logs"], self._audit.audit, self._print_entity_completions)
self._register_action_doc(self._audit.audit_doc())
self._notificationLog = NotificationLogHelper(self, "<org_name> <res_name>")
self._register(["notification-logs"], self._notificationLog.notification_log, self._print_entity_completions)
self._register_action_doc(self._notificationLog.notification_log_doc())
self._agentLog = AgentLogHelper(self, "<org_name> <res_name>")
self._register(["agent-logs"], self._agentLog.agent_log, self._print_entity_completions)
self._register_action_doc(self._agentLog.agent_log_doc())
self._otherLog = OtherLogHelper(self, "<org_name> <res_name>")
self._register(["other-logs"], self._otherLog.other_log, self._print_entity_completions)
self._register_action_doc(self._otherLog.other_log_doc())
self._register_subcontroller(["groups"], EnvironmentGroupsController())
self._register_action_doc(self._import_doc())
self._doc = "Environments handling."
def __init__(self):
super(HostsController, self).__init__()
self._audit = AuditHelper(self, "<org_name> <env_name> <res_name>")
# subcontrollers
self._register_subcontroller(["settings"], HostSettingsController())
self._register_subcontroller(["instance"], InstancesController())
self._register_subcontroller(["applications"], ApplicationContextController())
self._register_subcontroller(["distribution"], DistributionContextController())
self._register_subcontroller(["platform"], PlatformContextController())
self._register_subcontroller(["compliance"], ComplianceController())
self._register_subcontroller(["changes"], ChangeController())
self._register_subcontroller(["alerts"], MonitoringAlertController())
self._register_subcontroller(["live"], LiveController())
# actions
self._register(["provision"], self._provision, self._print_entity_completions)
self._register(["render-tree"], self._render_tree, self._print_tree_completions)
self._register(["clone"], self._clone, self._print_entity_completions)
self._register(["audit"], self._audit.audit, self._print_entity_completions)
self._register(["vnc"], self._vnc, self._print_entity_completions)
self._doc = "Hosts handling."
self._update_action_doc_params("list", "<org_name> <env_name>")
self._update_action_doc_params("add", "<org_name> <env_name>")
self._update_action_doc_params("delete", "<org_name> <env_name> <res_name>")
self._update_action_doc_params("update", "<org_name> <env_name> <res_name>")
self._update_action_doc_params("show", "<org_name> <env_name> <res_name>")
self._register_action_doc(self._provision_doc())
self._register_action_doc(self._render_tree_doc())
self._register_action_doc(self._clone_doc())
self._register_action_doc(self._audit.audit_doc())
self._register_action_doc(self._vnc_doc())
def __init__(self):
super(OrganizationsController, self).__init__()
self._audit = AuditHelper(self, "<res_name>")
self._notificationLog = NotificationLogHelper(self, "<res_name>")
self._agentLog = AgentLogHelper(self, "<res_name>")
self._otherLog = OtherLogHelper(self, "<res_name>")
# actions
self._register(["import"], self._import, self._print_import_completions)
self._register(["export"], self._export, self._print_export_completions)
self._register(["reset-secret"], self._reset_secret, self._print_entity_completions)
self._register(["audit-logs"], self._audit.audit, self._print_entity_completions)
self._register(["notification-logs"], self._notificationLog.notification_log, self._print_entity_completions)
self._register(["agent-logs"], self._agentLog.agent_log, self._print_entity_completions)
self._register(["other-logs"], self._otherLog.other_log, self._print_entity_completions)
self._register_action_doc(self._audit.audit_doc())
self._register_action_doc(self._export_doc())
self._register_action_doc(self._import_doc())
self._register_action_doc(self._reset_secret_doc())
self._register_action_doc(self._audit.audit_doc())
self._register_action_doc(self._notificationLog.notification_log_doc())
self._register_action_doc(self._agentLog.agent_log_doc())
self._register_action_doc(self._otherLog.other_log_doc())
# subcontrollers
self._register_subcontroller(["settings"], OrganizationSettingsController())
self._register_subcontroller(["groups"], GroupsController())
self._register_subcontroller(["jobs"], JobsController())
self._register_subcontroller(["notification-channels"], NotificationsController())
self._register_subcontroller(["application-keys"], ApplicationKeysController())
self._register_subcontroller(["orchestrations"], OrchestrationsController())
self._doc = "Organizations handling."
def __init__(self):
super(EnvironmentsController, self).__init__()
self._audit = AuditHelper(self, "<org_name> <res_name>")
# subcontrollers
self._register_subcontroller(["settings"], EnvironmentSettingsController())
# actions
self._register(["audit-logs"], self._audit.audit, self._print_entity_completions)
self._register_action_doc(self._audit.audit_doc())
self._notificationLog = NotificationLogHelper(self, "<org_name> <res_name>")
self._register(["notification-logs"], self._notificationLog.notification_log, self._print_entity_completions)
self._register_action_doc(self._notificationLog.notification_log_doc())
self._agentLog = AgentLogHelper(self, "<org_name> <res_name>")
self._register(["agent-logs"], self._agentLog.agent_log, self._print_entity_completions)
self._register_action_doc(self._agentLog.agent_log_doc())
self._otherLog = OtherLogHelper(self, "<org_name> <res_name>")
self._register(["other-logs"], self._otherLog.other_log, self._print_entity_completions)
self._register_action_doc(self._otherLog.other_log_doc())
self._doc = "Environments handling."
class EnvironmentsController(OrganizationEntityController):
_template = "environment.json"
def __init__(self):
super(EnvironmentsController, self).__init__()
self._audit = AuditHelper(self, "<org_name> <res_name>")
# subcontrollers
self._register_subcontroller(["settings"], EnvironmentSettingsController())
# actions
self._register(["audit"], self._audit.audit, self._print_entity_completions)
self._register_action_doc(self._audit.audit_doc())
self._doc = "Environments handling."
def _get_collection(self, org_name):
return self._client.environments(org_name)
def _prune_json_update(self, json_wrapper):
super(EnvironmentsController, self)._prune_json_update(json_wrapper)
json_wrapper._del_field("settings")
json_wrapper._del_field("hosts")
json_wrapper._del_field("organization")
def __init__(self):
super(OrganizationsController, self).__init__()
self._audit = AuditHelper(self, "<res_name>")
self._notificationLog = NotificationLogHelper(self, "<res_name>")
self._agentLog = AgentLogHelper(self, "<res_name>")
self._otherLog = OtherLogHelper(self, "<res_name>")
# actions
self._register(["import"], self._import,
self._print_import_completions)
self._register(["export"], self._export,
self._print_export_completions)
self._register(["reset-secret"], self._reset_secret,
self._print_entity_completions)
self._register(["audit-logs"], self._audit.audit,
self._print_entity_completions)
self._register(["notification-logs"],
self._notificationLog.notification_log,
self._print_entity_completions)
self._register(["agent-logs"], self._agentLog.agent_log,
self._print_entity_completions)
self._register(["other-logs"], self._otherLog.other_log,
self._print_entity_completions)
self._register_action_doc(self._audit.audit_doc())
self._register_action_doc(self._export_doc())
self._register_action_doc(self._import_doc())
self._register_action_doc(self._reset_secret_doc())
self._register_action_doc(self._audit.audit_doc())
self._register_action_doc(self._notificationLog.notification_log_doc())
self._register_action_doc(self._agentLog.agent_log_doc())
self._register_action_doc(self._otherLog.other_log_doc())
# subcontrollers
self._register_subcontroller(["settings"],
OrganizationSettingsController())
self._register_subcontroller(["groups"],
OrganizationGroupsController())
self._register_subcontroller(["jobs"], JobsController())
self._register_subcontroller(["notification-channels"],
NotificationsController())
self._register_subcontroller(["application-keys"],
ApplicationKeysController())
self._register_subcontroller(["orchestrations"],
OrchestrationsController())
self._doc = "Organizations handling."
def __init__(self):
super(EnvironmentsController, self).__init__()
self._audit = AuditHelper(self, "<org_name> <res_name>")
# subcontrollers
self._register_subcontroller(["settings"], EnvironmentSettingsController())
# actions
self._register(["audit"], self._audit.audit, self._print_entity_completions)
self._register_action_doc(self._audit.audit_doc())
self._doc = "Environments handling."
class EnvironmentsController(OrganizationEntityController):
_template = "environment.json"
def __init__(self):
super(EnvironmentsController, self).__init__()
self._audit = AuditHelper(self, "<org_name> <res_name>")
# subcontrollers
self._register_subcontroller(["settings"],
EnvironmentSettingsController())
# actions
self._register(["audit-logs"], self._audit.audit,
self._print_entity_completions)
self._register_action_doc(self._audit.audit_doc())
self._notificationLog = NotificationLogHelper(self,
"<org_name> <res_name>")
self._register(["notification-logs"],
self._notificationLog.notification_log,
self._print_entity_completions)
self._register_action_doc(self._notificationLog.notification_log_doc())
self._agentLog = AgentLogHelper(self, "<org_name> <res_name>")
self._register(["agent-logs"], self._agentLog.agent_log,
self._print_entity_completions)
self._register_action_doc(self._agentLog.agent_log_doc())
self._otherLog = OtherLogHelper(self, "<org_name> <res_name>")
self._register(["other-logs"], self._otherLog.other_log,
self._print_entity_completions)
self._register_action_doc(self._otherLog.other_log_doc())
self._doc = "Environments handling."
def _get_collection(self, org_name):
return self._client.environments(org_name)
def _prune_json_update(self, json_wrapper):
super(EnvironmentsController, self)._prune_json_update(json_wrapper)
json_wrapper._del_field("settings")
json_wrapper._del_field("hosts")
json_wrapper._del_field("organization")
def __init__(self):
super(OrganizationsController, self).__init__()
self._audit = AuditHelper(self, "<res_name>")
# actions
self._register(["import"], self._import, self._print_import_completions)
self._register(["export"], self._export, self._print_export_completions)
self._register(["reset-secret"], self._reset_secret, self._print_entity_completions)
self._register(["audit"], self._audit.audit, self._print_entity_completions)
self._register_action_doc(self._audit.audit_doc())
self._register_action_doc(self._export_doc())
self._register_action_doc(self._import_doc())
self._register_action_doc(self._reset_secret_doc())
self._register_action_doc(self._audit.audit_doc())
# subcontrollers
self._register_subcontroller(["settings"], OrganizationSettingsController())
self._register_subcontroller(["groups"], GroupsController())
self._doc = "Organizations handling."
class OrganizationsController(RootEntityController):
_template = "organization.json"
def __init__(self):
super(OrganizationsController, self).__init__()
self._audit = AuditHelper(self, "<res_name>")
# actions
self._register(["import"], self._import,
self._print_import_completions)
self._register(["export"], self._export,
self._print_export_completions)
self._register(["reset-secret"], self._reset_secret,
self._print_entity_completions)
self._register(["audit"], self._audit.audit,
self._print_entity_completions)
self._register_action_doc(self._audit.audit_doc())
self._register_action_doc(self._export_doc())
self._register_action_doc(self._import_doc())
self._register_action_doc(self._reset_secret_doc())
self._register_action_doc(self._audit.audit_doc())
# subcontrollers
self._register_subcontroller(["settings"],
OrganizationSettingsController())
self._register_subcontroller(["groups"], GroupsController())
self._doc = "Organizations handling."
def get_collection(self, argv):
return self._client.organizations()
def _prune_json_update(self, json_wrapper):
super(OrganizationsController, self)._prune_json_update(json_wrapper)
json_wrapper._del_field("settings")
json_wrapper._del_field("groups")
json_wrapper._del_field("environments")
def _reset_secret(self, argv):
org = self._get_entity(argv)
org.reset_secret()
def _reset_secret_doc(self):
return ActionDoc(
"reset-secret", self._list_params(), """
Resets the secret key associated to the organization.""")
# Import/export
def __set_root_folder(self, argv):
if len(argv) < 1:
raise ArgumentException("Wrong number of arguments")
self._root = argv[
0] # By default, use organization name as folder name
if len(argv) > 1:
self._root = argv[1]
def _print_export_completions(self, param_num, argv):
if param_num == 0:
self._print_entity_completions(param_num, argv)
elif param_num == 1:
completions.print_dir_completions()
def _export(self, argv):
self._options = globals.options
self.__set_root_folder(argv)
org = self._client.get_organization(argv[0])
export = Export(globals.options.force)
export.export_organization(org, self._root)
def _export_doc(self):
return ActionDoc(
"export", "<org_name> [<output_folder>] [--force]", """
Export organization onto disk. --force option causes existing files to
be overwritten.""")
def _print_import_completions(self, param_num, argv):
if param_num == 0:
completions.print_dir_completions()
def _import(self, argv):
"""
Pushes local data to comodit server. Data may include applications,
distributions, platforms, organizations, environments and hosts.
Local data are automatically imported if no collision with remote data
is detected. In case of collision, 'force' option can be used to still
import data.
"""
self._options = globals.options
if len(argv) < 1:
raise ArgumentException("Wrong number of arguments")
self._root = argv[0]
importer = Import(globals.options.skip_conflict, True)
importer.import_organization(self._client, self._root)
if (importer.no_conflict() or
globals.options.skip_conflict) and not globals.options.dry_run:
importer.execute_queue()
else:
importer.display_queue(show_only_conflicts=True)
def _import_doc(self):
return ActionDoc(
"import", "<src_folder>] [--skip-conflict] [--dry-run]", """
Import organization from disk. With --skip-conflict, conflicting actions
are skipped. With --dry-run, actions are displayed but not applied.""")
class EnvironmentsController(OrganizationEntityController):
_template = "environment.json"
def __init__(self):
super(EnvironmentsController, self).__init__()
self._audit = AuditHelper(self, "<org_name> <res_name>")
# subcontrollers
self._register_subcontroller(["settings"], EnvironmentSettingsController())
# actions
self._register(["import"], self._import, self._print_import_completions)
self._register(["audit-logs"], self._audit.audit, self._print_entity_completions)
self._register_action_doc(self._audit.audit_doc())
self._notificationLog = NotificationLogHelper(self, "<org_name> <res_name>")
self._register(["notification-logs"], self._notificationLog.notification_log, self._print_entity_completions)
self._register_action_doc(self._notificationLog.notification_log_doc())
self._agentLog = AgentLogHelper(self, "<org_name> <res_name>")
self._register(["agent-logs"], self._agentLog.agent_log, self._print_entity_completions)
self._register_action_doc(self._agentLog.agent_log_doc())
self._otherLog = OtherLogHelper(self, "<org_name> <res_name>")
self._register(["other-logs"], self._otherLog.other_log, self._print_entity_completions)
self._register_action_doc(self._otherLog.other_log_doc())
self._register_subcontroller(["groups"], EnvironmentGroupsController())
self._register_action_doc(self._import_doc())
self._doc = "Environments handling."
def _get_collection(self, org_name):
return self._client.environments(org_name)
def _prune_json_update(self, json_wrapper):
super(EnvironmentsController, self)._prune_json_update(json_wrapper)
json_wrapper._del_field("settings")
json_wrapper._del_field("hosts")
json_wrapper._del_field("organization")
def _import(self, argv):
"""
Pushes local data to comodit server. Data may include applications,
distributions, platforms, organizations, environments and hosts.
Local data are automatically imported if no collision with remote data
is detected. In case of collision, 'force' option can be used to still
import data.
"""
self._options = self._config.options
org = self._client.organizations().get(argv[0])
if len(argv) < 2:
raise ArgumentException("Wrong number of arguments")
importer = Import(self._config.options.skip_conflict, queue_actions=True,
with_instances=self._config.options.with_instances)
importer.import_full_env(org, argv[1])
if self._config.options.dry_run:
importer.display_queue(show_only_conflicts = False)
elif (importer.no_conflict() or self._config.options.skip_conflict):
importer.execute_queue()
else:
importer.display_queue(show_only_conflicts = True)
print ("Impossible to import environment. There are conflicts. Use --skip-conflict to force")
def _print_import_completions(self, param_num, argv):
if param_num < 1:
self._print_entity_completions(param_num, argv)
elif param_num == 1:
completions.print_dir_completions()
def _import_doc(self):
return ActionDoc("import", "<src_folder> [--dry-run]", """
Import environment from disk. With --dry-run, actions are displayed but not applied.""")
class HostsController(EntityController):
_template = "host.json"
def __init__(self):
super(HostsController, self).__init__()
self._audit = AuditHelper(self, "<org_name> <env_name> <res_name>")
# subcontrollers
self._register_subcontroller(["settings"], HostSettingsController())
self._register_subcontroller(["instance"], InstancesController())
self._register_subcontroller(["applications"], ApplicationContextController())
self._register_subcontroller(["distribution"], DistributionContextController())
self._register_subcontroller(["platform"], PlatformContextController())
self._register_subcontroller(["compliance"], ComplianceController())
self._register_subcontroller(["changes"], ChangeController())
self._register_subcontroller(["alerts"], MonitoringAlertController())
self._register_subcontroller(["live"], LiveController())
# actions
self._register(["provision"], self._provision, self._print_entity_completions)
self._register(["render-tree"], self._render_tree, self._print_tree_completions)
self._register(["clone"], self._clone, self._print_entity_completions)
self._register(["audit"], self._audit.audit, self._print_entity_completions)
self._register(["vnc"], self._vnc, self._print_entity_completions)
self._doc = "Hosts handling."
self._update_action_doc_params("list", "<org_name> <env_name>")
self._update_action_doc_params("add", "<org_name> <env_name>")
self._update_action_doc_params("delete", "<org_name> <env_name> <res_name>")
self._update_action_doc_params("update", "<org_name> <env_name> <res_name>")
self._update_action_doc_params("show", "<org_name> <env_name> <res_name>")
self._register_action_doc(self._provision_doc())
self._register_action_doc(self._render_tree_doc())
self._register_action_doc(self._clone_doc())
self._register_action_doc(self._audit.audit_doc())
self._register_action_doc(self._vnc_doc())
def get_collection(self, argv):
if len(argv) < 2:
raise ArgumentException("Wrong number of arguments");
return self._client.hosts(argv[0], argv[1])
def _print_collection_completions(self, param_num, argv):
if param_num == 0:
completions.print_identifiers(self._client.organizations())
elif len(argv) > 0 and param_num == 1:
completions.print_identifiers(self._client.environments(argv[0]))
def _print_entity_completions(self, param_num, argv):
if param_num < 2:
self._print_collection_completions(param_num, argv)
elif len(argv) > 1 and param_num == 2:
completions.print_identifiers(self.get_collection(argv))
def _complete_template(self, argv, template_json):
if len(argv) < 2:
raise ArgumentException("Wrong number of arguments");
template_json["organization"] = argv[0]
template_json["environment"] = argv[1]
def _get_name_argument(self, argv):
if len(argv) < 3:
raise ArgumentException("Wrong number of arguments");
return argv[2]
def _delete(self, argv):
host = self._get_entity(argv)
if self._config.options.force or (prompt.confirm(prompt = "Delete " + host.get_name() + " ?", resp = False)) :
host.delete()
def _print_file_completions(self, param_num, argv):
if param_num < 3:
self._print_entity_completions(param_num, argv)
elif len(argv) > 2 and param_num == 3:
completions.print_identifiers(self._client.get_host(argv[0], argv[1], argv[2]).applications())
elif len(argv) > 3 and param_num == 4:
completions.print_identifiers(self._client.get_application(argv[0], argv[3]).files())
def _print_tree_completions(self, param_num, argv):
if param_num < 3:
self._print_entity_completions(param_num, argv)
elif param_num == 3:
completions.print_dir_completions()
def _render_tree(self, argv):
if len(argv) != 4:
raise MissingException("This action takes 4 arguments")
org_name = argv[0]
env_name = argv[1]
host_name = argv[2]
root_dir = argv[3]
renderer = TreeRenderer(self._client, org_name, env_name, host_name)
options = self._config.options
renderer.render(root_dir, options.skip_chmod, options.skip_chown)
def _render_tree_doc(self):
return ActionDoc("render-tree", "<org_name> <env_name> <res_name> <output_folder>", """
Render configuration files of given host.""")
def _clone(self, argv):
if len(argv) != 3:
raise MissingException("This action takes 3 arguments")
host = self._get_entity(argv)
host.clone()
def _clone_doc(self):
return ActionDoc("clone", "<org_name> <env_name> <res_name>", """
Clone a given host.""")
def _provision_doc(self):
return ActionDoc("provision", "<org_name> <env_name> <res_name>", """
Provision a host.""")
def _provision(self, argv):
host = self._get_entity(argv)
host.provision()
def _prune_json_update(self, json_wrapper):
super(HostsController, self)._prune_json_update(json_wrapper)
json_wrapper._del_field("organization")
json_wrapper._del_field("settings")
json_wrapper._del_field("distribution")
json_wrapper._del_field("platform")
json_wrapper._del_field("state")
def _vnc(self, argv):
if len(argv) != 3:
raise MissingException("This action takes 3 arguments")
host = self._get_entity(argv)
vnc_params = host.instance().get().vnc
# Get VNC viewer call string
config = Config()
viewer_call_template = config.get_vnc_viewer_call(self._config.options.profile_name)
if viewer_call_template is None or viewer_call_template == "":
raise ControllerException("VNC viewer is not configured")
# Call viewer
hostname = vnc_params.hostname
port = vnc_params.port
if hostname != None and port != None:
call = viewer_call_template.replace("%h", hostname).replace("%p", port)
subprocess.call(call, shell = True)
else:
raise ControllerException("Could not retrieve VNC server host and/or port")
def _vnc_doc(self):
return ActionDoc("vnc", "<org_name> <env_name> <res_name>", """
Executes configured VNC viewer for host's instance.""")
class HostsController(EntityController):
_template = "host.json"
def __init__(self):
super(HostsController, self).__init__()
self._audit = AuditHelper(self, "<org_name> <env_name> <res_name>")
self._notificationLog = NotificationLogHelper(
self, "<org_name> <env_name> <res_name>")
self._agentLog = AgentLogHelper(self,
"<org_name> <env_name> <res_name>")
self._otherLog = OtherLogHelper(self,
"<org_name> <env_name> <res_name>")
# subcontrollers
self._register_subcontroller(["settings"], HostSettingsController())
self._register_subcontroller(["instance"], InstancesController())
self._register_subcontroller(["applications"],
ApplicationContextController())
self._register_subcontroller(["distribution"],
DistributionContextController())
self._register_subcontroller(["platform"], PlatformContextController())
self._register_subcontroller(["compliance"], ComplianceController())
self._register_subcontroller(["changes"], ChangeController())
self._register_subcontroller(["alerts"], MonitoringAlertController())
self._register_subcontroller(["actions"], ActionController())
self._register_subcontroller(["groups"], HostGroupsController())
# actions
self._register(["provision"], self._provision,
self._print_entity_completions)
self._register(["render-tree"], self._render_tree,
self._print_tree_completions)
self._register(["clone"], self._clone, self._print_entity_completions)
self._register(["audit"], self._audit.audit,
self._print_entity_completions)
self._register(["notification-logs"],
self._notificationLog.notification_log,
self._print_entity_completions)
self._register(["agent-logs"], self._agentLog.agent_log,
self._print_entity_completions)
self._register(["other-logs"], self._otherLog.other_log,
self._print_entity_completions)
self._register(["import"], self._import,
self._print_import_completions)
self._register(["vnc"], self._vnc, self._print_entity_completions)
self._doc = "Hosts handling."
self._update_action_doc_params("list", "<org_name> <env_name>")
self._update_action_doc_params("add", "<org_name> <env_name>")
self._update_action_doc_params("delete",
"<org_name> <env_name> <res_name>")
self._update_action_doc_params("update",
"<org_name> <env_name> <res_name>")
self._update_action_doc_params("show",
"<org_name> <env_name> <res_name>")
self._register_action_doc(self._provision_doc())
self._register_action_doc(self._render_tree_doc())
self._register_action_doc(self._clone_doc())
self._register_action_doc(self._audit.audit_doc())
self._register_action_doc(self._notificationLog.notification_log_doc())
self._register_action_doc(self._agentLog.agent_log_doc())
self._register_action_doc(self._otherLog.other_log_doc())
self._register_action_doc(self._vnc_doc())
self._register_action_doc(self._import_doc())
def get_collection(self, argv):
if len(argv) < 2:
raise ArgumentException("Wrong number of arguments")
return self._client.hosts(argv[0], argv[1])
def _print_collection_completions(self, param_num, argv):
if param_num == 0:
completions.print_identifiers(self._client.organizations())
elif len(argv) > 0 and param_num == 1:
completions.print_identifiers(self._client.environments(argv[0]))
def _print_entity_completions(self, param_num, argv):
if param_num < 2:
self._print_collection_completions(param_num, argv)
elif len(argv) > 1 and param_num == 2:
completions.print_identifiers(self.get_collection(argv))
def _complete_template(self, argv, template_json):
if len(argv) < 2:
raise ArgumentException("Wrong number of arguments")
template_json["organization"] = argv[0]
template_json["environment"] = argv[1]
def _get_name_argument(self, argv):
if len(argv) < 3:
raise ArgumentException("Wrong number of arguments")
return argv[2]
def _get_value_argument(self, argv):
if len(argv) < 4:
return None
return argv[3]
def _delete(self, argv):
host = self._get_entity(argv)
if self._config.options.force or (prompt.confirm(
prompt="Delete " + host.name + " ?", resp=False)):
host.delete()
def _print_file_completions(self, param_num, argv):
if param_num < 3:
self._print_entity_completions(param_num, argv)
elif len(argv) > 2 and param_num == 3:
completions.print_identifiers(
self._client.get_host(argv[0], argv[1],
argv[2]).applications())
elif len(argv) > 3 and param_num == 4:
completions.print_identifiers(
self._client.get_application(argv[0], argv[3]).files())
def _print_tree_completions(self, param_num, argv):
if param_num < 3:
self._print_entity_completions(param_num, argv)
elif param_num == 3:
completions.print_dir_completions()
def _print_import_completions(self, param_num, argv):
if param_num < 2:
self._print_entity_completions(param_num, argv)
elif param_num == 2:
completions.print_dir_completions()
def _render_tree(self, argv):
if len(argv) != 4:
raise MissingException("This action takes 4 arguments")
org_name = argv[0]
env_name = argv[1]
host_name = argv[2]
root_dir = argv[3]
renderer = TreeRenderer(self._client, org_name, env_name, host_name)
options = self._config.options
renderer.render(root_dir, options.skip_chmod, options.skip_chown)
def _render_tree_doc(self):
return ActionDoc(
"render-tree", "<org_name> <env_name> <res_name> <output_folder>",
"""
Render configuration files of given host.""")
def _clone(self, argv):
if len(argv) != 3:
raise MissingException("This action takes 3 arguments")
host = self._get_entity(argv)
host.clone()
def _clone_doc(self):
return ActionDoc("clone", "<org_name> <env_name> <res_name>", """
Clone a given host.""")
def _provision_doc(self):
return ActionDoc("provision", "<org_name> <env_name> <res_name>", """
Provision a host.""")
def _provision(self, argv):
host = self._get_entity(argv)
host.provision()
def _prune_json_update(self, json_wrapper):
super(HostsController, self)._prune_json_update(json_wrapper)
json_wrapper._del_field("organization")
json_wrapper._del_field("settings")
json_wrapper._del_field("distribution")
json_wrapper._del_field("platform")
json_wrapper._del_field("state")
def _vnc(self, argv):
if len(argv) != 3:
raise MissingException("This action takes 3 arguments")
host = self._get_entity(argv)
vnc_params = host.instance().get().vnc
# Get VNC viewer call string
config = Config()
viewer_call_template = config.get_vnc_viewer_call(
self._config.options.profile_name)
if viewer_call_template is None or viewer_call_template == "":
raise ControllerException("VNC viewer is not configured")
# Call viewer
hostname = vnc_params.hostname
port = vnc_params.port
if hostname != None and port != None:
call = viewer_call_template.replace("%h",
hostname).replace("%p", port)
subprocess.call(call, shell=True)
else:
raise ControllerException(
"Could not retrieve VNC server host and/or port")
def _vnc_doc(self):
return ActionDoc(
"vnc", "<org_name> <env_name> <res_name>", """
Executes configured VNC viewer for host's instance.""")
def _import(self, argv):
"""
Pushes local data to comodit server. Data may include applications,
distributions, platforms, organizations, environments and hosts.
Local data are automatically imported if no collision with remote data
is detected. In case of collision, 'force' option can be used to still
import data.
"""
self._options = self._config.options
org = self._client.organizations().get(argv[0])
env = self._client.environments(argv[0]).get(argv[1])
if len(argv) < 3:
raise ArgumentException("Wrong number of arguments")
importer = Import(self._config.options.skip_conflict,
queue_actions=True,
with_instances=self._config.options.with_instances)
importer.import_full_host(org, env, argv[2])
if self._config.options.dry_run:
importer.display_queue(show_only_conflicts=False)
elif (importer.no_conflict() or self._config.options.skip_conflict):
importer.execute_queue()
else:
importer.display_queue(show_only_conflicts=True)
print(
"Impossible to import host. There are conflicts. Use --skip-conflict to force"
)
def _import_doc(self):
return ActionDoc(
"import", "<src_folder> [--dry-run]", """
Import host from disk. With --dry-run, actions are displayed but not applied."""
)
class HostsController(EntityController):
_template = "host.json"
def __init__(self):
super(HostsController, self).__init__()
self._audit = AuditHelper(self, "<org_name> <env_name> <res_name>")
self._notificationLog = NotificationLogHelper(self, "<org_name> <env_name> <res_name>")
self._agentLog = AgentLogHelper(self, "<org_name> <env_name> <res_name>")
self._otherLog = OtherLogHelper(self, "<org_name> <env_name> <res_name>")
# subcontrollers
self._register_subcontroller(["settings"], HostSettingsController())
self._register_subcontroller(["instance"], InstancesController())
self._register_subcontroller(["applications"], ApplicationContextController())
self._register_subcontroller(["distribution"], DistributionContextController())
self._register_subcontroller(["platform"], PlatformContextController())
self._register_subcontroller(["compliance"], ComplianceController())
self._register_subcontroller(["changes"], ChangeController())
self._register_subcontroller(["alerts"], MonitoringAlertController())
self._register_subcontroller(["actions"], ActionController())
# actions
self._register(["provision"], self._provision, self._print_entity_completions)
self._register(["render-tree"], self._render_tree, self._print_tree_completions)
self._register(["clone"], self._clone, self._print_entity_completions)
self._register(["audit"], self._audit.audit, self._print_entity_completions)
self._register(["notification-logs"], self._notificationLog.notification_log, self._print_entity_completions)
self._register(["agent-logs"], self._agentLog.agent_log, self._print_entity_completions)
self._register(["other-logs"], self._otherLog.other_log, self._print_entity_completions)
self._register(["vnc"], self._vnc, self._print_entity_completions)
self._doc = "Hosts handling."
self._update_action_doc_params("list", "<org_name> <env_name>")
self._update_action_doc_params("add", "<org_name> <env_name>")
self._update_action_doc_params("delete", "<org_name> <env_name> <res_name>")
self._update_action_doc_params("update", "<org_name> <env_name> <res_name>")
self._update_action_doc_params("show", "<org_name> <env_name> <res_name>")
self._register_action_doc(self._provision_doc())
self._register_action_doc(self._render_tree_doc())
self._register_action_doc(self._clone_doc())
self._register_action_doc(self._audit.audit_doc())
self._register_action_doc(self._notificationLog.notification_log_doc())
self._register_action_doc(self._agentLog.agent_log_doc())
self._register_action_doc(self._otherLog.other_log_doc())
self._register_action_doc(self._vnc_doc())
def get_collection(self, argv):
if len(argv) < 2:
raise ArgumentException("Wrong number of arguments");
return self._client.hosts(argv[0], argv[1])
def _print_collection_completions(self, param_num, argv):
if param_num == 0:
completions.print_identifiers(self._client.organizations())
elif len(argv) > 0 and param_num == 1:
completions.print_identifiers(self._client.environments(argv[0]))
def _print_entity_completions(self, param_num, argv):
if param_num < 2:
self._print_collection_completions(param_num, argv)
elif len(argv) > 1 and param_num == 2:
completions.print_identifiers(self.get_collection(argv))
def _complete_template(self, argv, template_json):
if len(argv) < 2:
raise ArgumentException("Wrong number of arguments");
template_json["organization"] = argv[0]
template_json["environment"] = argv[1]
def _get_name_argument(self, argv):
if len(argv) < 3:
raise ArgumentException("Wrong number of arguments");
return argv[2]
def _delete(self, argv):
host = self._get_entity(argv)
if self._config.options.force or (prompt.confirm(prompt = "Delete " + host.get_name() + " ?", resp = False)) :
host.delete()
def _print_file_completions(self, param_num, argv):
if param_num < 3:
self._print_entity_completions(param_num, argv)
elif len(argv) > 2 and param_num == 3:
completions.print_identifiers(self._client.get_host(argv[0], argv[1], argv[2]).applications())
elif len(argv) > 3 and param_num == 4:
completions.print_identifiers(self._client.get_application(argv[0], argv[3]).files())
def _print_tree_completions(self, param_num, argv):
if param_num < 3:
self._print_entity_completions(param_num, argv)
elif param_num == 3:
completions.print_dir_completions()
def _render_tree(self, argv):
if len(argv) != 4:
raise MissingException("This action takes 4 arguments")
org_name = argv[0]
env_name = argv[1]
host_name = argv[2]
root_dir = argv[3]
renderer = TreeRenderer(self._client, org_name, env_name, host_name)
options = self._config.options
renderer.render(root_dir, options.skip_chmod, options.skip_chown)
def _render_tree_doc(self):
return ActionDoc("render-tree", "<org_name> <env_name> <res_name> <output_folder>", """
Render configuration files of given host.""")
def _clone(self, argv):
if len(argv) != 3:
raise MissingException("This action takes 3 arguments")
host = self._get_entity(argv)
host.clone()
def _clone_doc(self):
return ActionDoc("clone", "<org_name> <env_name> <res_name>", """
Clone a given host.""")
def _provision_doc(self):
return ActionDoc("provision", "<org_name> <env_name> <res_name>", """
Provision a host.""")
def _provision(self, argv):
host = self._get_entity(argv)
host.provision()
def _prune_json_update(self, json_wrapper):
super(HostsController, self)._prune_json_update(json_wrapper)
json_wrapper._del_field("organization")
json_wrapper._del_field("settings")
json_wrapper._del_field("distribution")
json_wrapper._del_field("platform")
json_wrapper._del_field("state")
def _vnc(self, argv):
if len(argv) != 3:
raise MissingException("This action takes 3 arguments")
host = self._get_entity(argv)
vnc_params = host.instance().get().vnc
# Get VNC viewer call string
config = Config()
viewer_call_template = config.get_vnc_viewer_call(self._config.options.profile_name)
if viewer_call_template is None or viewer_call_template == "":
raise ControllerException("VNC viewer is not configured")
# Call viewer
hostname = vnc_params.hostname
port = vnc_params.port
if hostname != None and port != None:
call = viewer_call_template.replace("%h", hostname).replace("%p", port)
subprocess.call(call, shell = True)
else:
raise ControllerException("Could not retrieve VNC server host and/or port")
def _vnc_doc(self):
return ActionDoc("vnc", "<org_name> <env_name> <res_name>", """
Executes configured VNC viewer for host's instance.""")
class OrganizationsController(RootEntityController):
_template = "organization.json"
def __init__(self):
super(OrganizationsController, self).__init__()
self._audit = AuditHelper(self, "<res_name>")
self._notificationLog = NotificationLogHelper(self, "<res_name>")
self._agentLog = AgentLogHelper(self, "<res_name>")
self._otherLog = OtherLogHelper(self, "<res_name>")
# actions
self._register(["import"], self._import, self._print_import_completions)
self._register(["export"], self._export, self._print_export_completions)
self._register(["reset-secret"], self._reset_secret, self._print_entity_completions)
self._register(["audit-logs"], self._audit.audit, self._print_entity_completions)
self._register(["notification-logs"], self._notificationLog.notification_log, self._print_entity_completions)
self._register(["agent-logs"], self._agentLog.agent_log, self._print_entity_completions)
self._register(["other-logs"], self._otherLog.other_log, self._print_entity_completions)
self._register_action_doc(self._audit.audit_doc())
self._register_action_doc(self._export_doc())
self._register_action_doc(self._import_doc())
self._register_action_doc(self._reset_secret_doc())
self._register_action_doc(self._audit.audit_doc())
self._register_action_doc(self._notificationLog.notification_log_doc())
self._register_action_doc(self._agentLog.agent_log_doc())
self._register_action_doc(self._otherLog.other_log_doc())
# subcontrollers
self._register_subcontroller(["settings"], OrganizationSettingsController())
self._register_subcontroller(["groups"], GroupsController())
self._register_subcontroller(["jobs"], JobsController())
self._register_subcontroller(["notification-channels"], NotificationsController())
self._register_subcontroller(["application-keys"], ApplicationKeysController())
self._register_subcontroller(["orchestrations"], OrchestrationsController())
self._doc = "Organizations handling."
def get_collection(self, argv):
return self._client.organizations()
def _prune_json_update(self, json_wrapper):
super(OrganizationsController, self)._prune_json_update(json_wrapper)
json_wrapper._del_field("settings")
json_wrapper._del_field("groups")
json_wrapper._del_field("environments")
def _reset_secret(self, argv):
org = self._get_entity(argv)
org.reset_secret()
def _reset_secret_doc(self):
return ActionDoc("reset-secret", self._list_params(), """
Resets the secret key associated to the organization.""")
# Import/export
def __set_root_folder(self, argv):
if len(argv) < 1:
raise ArgumentException("Wrong number of arguments")
self._root = argv[0] # By default, use organization name as folder name
if len(argv) > 1:
self._root = argv[1]
def _print_export_completions(self, param_num, argv):
if param_num == 0:
self._print_entity_completions(param_num, argv)
elif param_num == 1:
completions.print_dir_completions()
def _export(self, argv):
self._options = self._config.options
self.__set_root_folder(argv)
org = self._client.get_organization(argv[0])
export = Export(self._config.options.force)
export.export_organization(org, self._root)
def _export_doc(self):
return ActionDoc("export", "<org_name> [<output_folder>] [--force]", """
Export organization onto disk. --force option causes existing files to
be overwritten.""")
def _print_import_completions(self, param_num, argv):
if param_num == 0:
completions.print_dir_completions()
def _import(self, argv):
"""
Pushes local data to comodit server. Data may include applications,
distributions, platforms, organizations, environments and hosts.
Local data are automatically imported if no collision with remote data
is detected. In case of collision, 'force' option can be used to still
import data.
"""
self._options = self._config.options
if len(argv) < 1:
raise ArgumentException("Wrong number of arguments")
self._root = argv[0]
importer = Import(self._config.options.skip_conflict, queue_actions=True, with_instances=self._config.options.with_instances)
importer.import_organization(self._client, self._root)
if (importer.no_conflict() or self._config.options.skip_conflict) and not self._config.options.dry_run:
importer.execute_queue()
else:
importer.display_queue(show_only_conflicts = True)
def _import_doc(self):
return ActionDoc("import", "<src_folder>] [--skip-conflict] [--dry-run]", """
Import organization from disk. With --skip-conflict, conflicting actions
are skipped. With --dry-run, actions are displayed but not applied.""")