III.A tasks for ml‐config - kghmanuel/ml-gradle GitHub Wiki

In general, tasks pre-fixed with 're', e.g. mlRedeploy, mlReloadModules, mlReloadSchemas, would involve running the undeploy tasks of its subfolders (if applicable) followed by the deploy task.

All changes to files under configuration can be deployed using a single command: mlDeploy. However, some may prefer to only deploy what was changed and avoid having the system / cluster restart unnecessarily.

The following tables provides a listing of tasks and folders

Sub-folder	Deploy Task	Undeploy Task
alert	mlDeployAlerting	mlDeleteAllAlertConfigs
cpf	mlDeployCpf mlRedeployCpf mlLoadDefaultPipelines
databases	mlDeployDatabases
flexrep	mlDeployFlexrep mlDeployFlexrepAtPath	mlDeleteAllFlexrepConfigs
forests	mlDeployCustomForests mlDeployForestReplicas
groups	mlDeployGroups
mimetypes	mlDeployMimetypes
security	mlDeploySecurity	mlUndeploySecurity
servers	mlDeployServers	mlUndeployOtherServers
tasks	mlDeployTasks	mlUndeployTasks mlDeleteAllTasks
temporal	mlDeployTemporal
triggers	mlDeployTriggers
view-schemas	mlDeployViewSchemas

Security sub folder is a bit more detailed and would require a separate list as shown below

Sub-folder	Deploy Task	Undeploy Task
amps	mlDeployAmps	mlUndeployAmps
certificate-authorities	mlDeployCertificateAuthorities
certificate-templates	mlDeployCertificateTemplates	mlUndeployCertificateTemplates
external-security	mlDeployExternalSecurity	mlUndeployExternalSecurity
privileges	mlDeployPrivileges	mlUndeployPrivileges
protected-paths	mlDeployProtectedPaths	mlUndeployProtectedPaths
protected-collections	mlDeployProtectedCollections	mlUndeployProtectedCollections
query-role-sets	mlDeployQueryRolesets	mlUndeployQueryRolesets
roles	mlDeployRoles	mlUndeployRoles
users	mlDeployUsers	mlUndeployUsers

Task	Description
mlPostDeploy	Add dependsOn to this task to add tasks at the end of mlDeploy
mlPostUndeploy	Add dependsOn to this task to add tasks at the end of mlUndeploy
mlRedeploy	Clears the modules database and then deploys the application
mlUndeploy	Undeploys all application resources in the configuration directory and allows for additional steps via mlPostUndeploy.dependsOn; requires -Pconfirm=true to be set so this isn't accidentally executed

Task	Description
mlClearContentDatabase	Deletes all documents in the content database; requires -Pconfirm=true to be set so this isn't accidentally executed
mlClearDatabase	Deletes all documents in a database specified by -Pdatabase=(name); requires -Pconfirm=true to be set so this isn't accidentally executed
mlClearModulesDatabase	Deletes potentially all of the documents in the modules database; has a property for excluding documents from deletion
mlClearSchemasDatabase	Deletes all documents in the schemas database
mlClearTriggersDatabase	Deletes all documents in the triggers database
mlMergeContentDatabase	Merge the database named by mlAppConfig.contentDatabaseName
mlMergeDatabase	Merge the database named by the project property dbName; e.g. gradle mlMergeDatabase -PdbName=my-database
mlReindexContentDatabase	Reindex the database named by mlAppConfig.contentDatabaseName
mlReindexDatabase	Reindex the database named by the project property dbName; e.g. gradle mlReindexDatabase -PdbName=my-database
mlSetContentUpdatesAllowed	Sets updated-allowed on each primary forest for the content database; must set the mode via e.g. -Pmode=flash-backup

Task	Description
mlDisableAllFlexrepTargets	Disable every target on every flexrep config
mlEnableAllFlexrepTargets	Enable every target on every flexrep config

Task	Description
mlSetTraceEvents	Set trace events via a comma-delimited string - e.g. -Pevents=event1,event2

Task	Description
mlDisableAllTasks	Disable each scheduled task in the group identified by the mlGroupName property, which defaults to 'Default'
mlEnableAllTasks	Enable each scheduled task in the group identified by the mlGroupName property, which defaults to 'Default'
mlWaitForTaskServer	Wait for the task server to not have any requests in progress