###### Tasks ###### Tasks are functions which are called when an object is created (POST) updated (PATCH) or deleted (DELETE). These tasks are called via database event hooks, and they perform changes to the underlying filesystem, corresponding to the database change being performed. For example, when a template is deleted, a ``TemplateDeleter`` task will remove the corresponding template files from the filesystem. Tasks are executed via the configured Job Engine - see PixStor Schedulers. API Documentation ================== ORM Task --------- ``ORMTask`` is the base class for all tasks which affect objects on the filesystem. .. automodule:: arcapix.management.tasks.ormtask :inherited-members: :members: Exposer Tasks -------------- .. automodule:: arcapix.management.tasks.exposertasks :inherited-members: :members: Profile Tasks -------------- .. automodule:: arcapix.management.tasks.profiletasks :inherited-members: :members: Provider Tasks -------------- .. automodule:: arcapix.management.tasks.providertasks :inherited-members: :members: Replica Tasks -------------- .. automodule:: arcapix.management.tasks.replicatasks :inherited-members: :members: Space Tasks ------------ .. automodule:: arcapix.management.tasks.spacetasks :inherited-members: :members: Snapshots Tasks --------------- .. automodule:: arcapix.management.tasks.snapshottasks :inherited-members: :members: Template Tasks --------------- .. automodule:: arcapix.management.tasks.templatetasks :inherited-members: :members: Template Tools ______________ The following are command line tools which are used by tasks. They need to be run as root to be able to manipulate templates, regardless of the permissions of the objects in the templates. .. important:: Ideally, these scripts should be added to the sudoers file for the user which runs the management REST server (i.e. the user that tasks are run as). Copy Template ^^^^^^^^^^^^^ .. automodule:: arcapix.management.tasks.copy_template :inherited-members: :members: Delete Template ^^^^^^^^^^^^^^^ .. automodule:: arcapix.management.tasks.delete_template :inherited-members: :members: Move Template ^^^^^^^^^^^^^ .. automodule:: arcapix.management.tasks.move_template :inherited-members: :members: Uninstall Template ^^^^^^^^^^^^^^^^^^ .. automodule:: arcapix.management.tasks.uninstall_template :inherited-members: :members: Populate Tasks -------------- These are methods for populating or reconciling the database based on the current state of the filesystem. .. hint:: Use the ``adminctl populate`` tool to perform populate operations .. automodule:: arcapix.management.tasks.populatetasks :inherited-members: :members: