Detailed explanation of the available tags in the Ansible kit
|
Generic |
|
|
Execution without tag |
Deploys Anjana + persistences without sample data. |
|
anjana-sample |
Deploys Anjana + persistences with sample data. |
|
platform |
Prepares the machine with everything needed for the correct functioning of anjana, such as creating the user and group, creating the temporary folder, adjusting the /etc/hosts aliases, installing jq/unzip/iproute2 and checking the connection to the repository. |
|
download |
Local mode requires all software to be downloaded beforehand. This tag allows downloading everything.
It is launched in manager mode and downloads jars, datasets, software, utilities that Anjana requires to be copied to another Ansible node without internet connectivity and deploy Anjana in local mode. |
|
ansible-user |
Allows the creation of a user with group and key on all nodes, authorizing its use, specifically for the execution of ansible.
A user with administrator permissions to access directories and files (like root) is required to launch this tag. |
|
Microservices |
|
|
portuno kerno zeus drittesta minerva viator hermes tot horus |
Deploys the selected microservice.
Among the tasks performed, these include backing up, deleting and downloading the jars, and creating or overwriting the existing service descriptor. |
|
anjana-ui
|
Deploys Apache2 with the frontends / and /configpanel. Creates or overwrites the Apache configuration files for both frontends. |
|
Plugins |
|
|
tot-plugin-aws-glue tot-plugin-aws-iam tot-plugin-aws-s3 tot-plugin-azure-ad tot-plugin-azure-storage tot-plugin-gcp-bigquery tot-plugin-gcp-iam tot-plugin-gcp-storage tot-plugin-jdbc tot-plugin-jdbc-denodo tot-plugin-jdbc-oracle tot-plugin-jdbc-redshift tot-plugin-jdbc-snowflake tot-plugin-jdbc-sqlserver tot-plugin-ldap tot-plugin-aqtiva tot-plugin-powerbi tot-plugin-ranger tot-plugin-tableau |
Deploys the selected plugin.
Among the tasks performed, these include backing up, deleting and downloading the jars, and creating or overwriting the existing service descriptor. |
|
tot-plugins |
Deploys all plugins enabled in import_roles of the all.yaml |
|
Updates |
|
|
update |
Executes all update tasks for the jars, frontends and cdn. |
|
update-config |
Updates/deploys the configuration files of the microservices. Replaces all existing configurations with the templates present in the inventory. |
|
update-vhosts |
Updates/deploys the Apache2 configuration files. Replaces the apache2 configuration with the templates present in the inventory. |
|
update-services |
Updates/deploys the service descriptors of the Anjana microservices. Replaces all service descriptors with the templates present in the inventory. |
|
update-portuno update-kerno update-zeus update-drittesta update-minerva update-viator update-hermes update-tot update-horus |
Updates the jar of the chosen microservice. |
|
update-anjana-ui |
Updates the frontends / and /configpanel, and downloads the cdn without overwriting if any conflict is found. |
|
update-tot-plugin-aws-glue update-tot-plugin-aws-iam update-tot-plugin-aws-s3 update-tot-plugin-azure-ad update-tot-plugin-azure-storage update-tot-plugin-gcp-bigquery update-tot-plugin-gcp-iam update-tot-plugin-gcp-storage update-tot-plugin-jdbc update-tot-plugin-jdbc-denodo update-tot-plugin-jdbc-oracle update-tot-plugin-jdbc-redshift update-tot-plugin-jdbc-snowflake update-tot-plugin-jdbc-sqlserver update-tot-plugin-ldap update-tot-plugin-aqtiva update-tot-plugin-powerbi update-tot-plugin-ranger update-tot-plugin-tableau |
Updates the jar of the chosen plugin. |
|
Persistences |
|
|
persistences |
Installs all the persistences selected in all.yml. |
|
persistences-sample |
Installs all the persistences + sample data selected in all.yml. The execution of this tag implies a controlled shutdown of all microservices. |
|
delete-persistences |
Deletes the installed persistences selected in all.yml This action also deletes all content of each persistence, a prior backup/export is required. |
|
update-persistences |
Deletes the installed persistences selected in all.yml and then installs the latest version indicated in the variable files of each persistence. This action also deletes all content of each persistence, a prior backup/export is required. |
|
postgresql zookeeper solr minio |
Installs all the chosen persistence. |
|
export import |
Executes the export and import of data from an Anjana environment (MinIO and DB). The default directory for export and import is /opt/export-import. The execution of this tag implies a controlled shutdown of all microservices. |
|
import-bbdd import-s3 |
Executes the data import in an Anjana Data environment for the selected persistences. The execution of this tag implies a controlled shutdown of all microservices. |
|
backup-dump |
Executes a dump of the persistences + config and uploads it to the specified anjanabackups bucket. The execution of this tag implies a controlled shutdown of all microservices. |
|
restore-dump |
Allows restoring a dump available in the anjanabackups bucket by choosing from among those available. The execution of this tag implies a controlled shutdown of all microservices. |
|
dump-cron |
Deploys a cron that will automatically execute ansible with the backup-dump tag. It is configurable in persistencesutilityhosts.yml. |
|
clone deploy |
Clone executes the data export from an Anjana environment, generating a .tgz compressed file. Deploy deploys the cloned data from an existing compressed file.
Includes persistences (MinIO and DB) and the configuration. The execution of this tag implies a controlled shutdown of all microservices. |
|
deploy-bbdd deploy-s3 deploy-config |
Executes the data deployment in an Anjana environment for the selected persistences and/or configuration The execution of this tag implies a controlled shutdown of all microservices. |
|
skip-backup |
Used by launching it with skip-tags (--skip-tags skip-backup), to prevent a backup from being made during the ansible execution. |
|
backup backup-persistences backup-config |
Performs the backup of the configuration and persistence data. Can be launched together, or configuration and persistences separately. Not combinable with export or deploy. |
|
restore restore-s3 restore-bbdd restore-config |
Allows restoring the chosen persistence and/or configuration from the last available backup.
If no backup is available, a notice will be shown and execution will be stopped. The execution of this tag implies a controlled shutdown of all microservices. |
|
delete delete-bbdd delete-s3 delete-solr delete-config |
Allows deleting the data from the chosen persistence and/or configuration
The execution of this tag implies a controlled shutdown of all microservices. |
|
insert insert-bbdd insert-s3 |
An insert is performed with the dataset chosen in all.yml into MinIO and DB for the selected persistences. The execution of this tag implies a controlled shutdown of all microservices. |
|
reset reset-bbdd reset-s3 |
Performs a deletion with prior backup and re-insertion of data from the chosen persistences. The execution of this tag implies a controlled shutdown of all microservices. |
|
Utilities |
|
|
ansible |
Deploys or updates the ansible kit. Installs the necessary collections and dependencies. Discontinued tag. It is recommended to use the installer script anjana.sh to update the ansible kit. |
|
clean |
Deletes what was downloaded in the temporary folder. |
|
aliases |
Allows updating the system aliases controlled by ansible, necessary for the communication of the microservices. |
|
check-connection |
Checks the connection of Anjana with the persistences. |
|
check-repository |
Checks the connection against the Anjana artifact repository. |
|
post-upgrade-cleanup |
Deletes all discontinued services, folders, files, etc… Recommended once the update to 25.2 has been successfully completed |
|
start |
Starts all microservices in an orderly manner. |
|
stop |
Stops the entire Anjana installation in an orderly manner, starting with the microservices that depend on others and ending with the persistences. |
|
restart |
Performs an orderly shutdown and then an orderly startup of all of Anjana. |
|
restart-microservices |
Restarts Anjana services without ordering. |
|
start-zookeeper start-postgresql start-minio start-solr start-portuno start-zeus start-kerno start-minerva start-horus start-viator start-hermes start-tot start-anjana-ui start-tot-plugin-aws-glue start-tot-plugin-aws-iam start-tot-plugin-aws-s3 start-tot-plugin-azure-ad start-tot-plugin-azure-storage start-tot-plugin-gcp-bigquery start-tot-plugin-gcp-iam start-tot-plugin-gcp-storage start-tot-plugin-jdbc start-tot-plugin-jdbc-denodo start-tot-plugin-jdbc-oracle start-tot-plugin-jdbc-redshift start-tot-plugin-jdbc-snowflake start-tot-plugin-jdbc-sqlserver start-tot-plugin-ldap start-tot-plugin-aqtiva start-tot-plugin-powerbi start-tot-plugin-ranger start-tot-plugin-tableau |
Starts the selected microservice by first selectively and orderly starting all the microservices and persistences it needs to function. |
|
stop-zookeeper stop-postgresql stop-minio stop-solr stop-portuno stop-zeus stop-kerno stop-minerva stop-horus stop-viator stop-hermes stop-tot stop-anjana-ui stop-tot-plugin-aws-glue stop-tot-plugin-aws-iam stop-tot-plugin-aws-s3 stop-tot-plugin-azure-ad stop-tot-plugin-azure-storage stop-tot-plugin-gcp-bigquery stop-tot-plugin-gcp-iam stop-tot-plugin-gcp-storage stop-tot-plugin-jdbc stop-tot-plugin-jdbc-denodo stop-tot-plugin-jdbc-oracle stop-tot-plugin-jdbc-redshift stop-tot-plugin-jdbc-snowflake stop-tot-plugin-jdbc-sqlserver stop-tot-plugin-ldap stop-tot-plugin-aqtiva stop-tot-plugin-powerbi stop-tot-plugin-ranger stop-tot-plugin-tableau |
Stops the selected microservice by first selectively and orderly stopping all the microservices that depend on it. |
|
uninstall |
Proceeds to a complete uninstallation of Anjana, including the third-party software that was deployed with the kit, in the selected inventory.
The Ansible folder is not deleted because it would prevent the completion of the execution. Existing backups and exports are preserved. |
|
unlock-schemas |
Unlocks the Anjana schemas that are in the Waiting for changelog lock state. |
|
swap |
Allows configuring a 4GB swap file to extend memory. |
|
Security |
|
|
update-whitelist |
Allows updating the list of allowed IPs for access without deploying the entire frontend. |
|
certificate-deploy |
Allows the deployment of the renewed certificate for the microservices, frontends and persistences. The new certificate must be located in /opt/common/anjana-certs available before the execution of this tag. |
|
Logs and Audit |
|
|
export-log |
Exports the logs of Anjana microservices to the folder /opt/anjana-logs/<microservice>.log.
By default the last 5 days but configurable at runtime with -e '{"log": {"since": "2 day ago"}}' |
|
export-log-s3 |
Collects the logs already available from the folder /opt/anjana-logs and uploads them to the anjanalogs bucket configured in all.yml. This means that the 'export-log' tag must have been previously executed |
|
log-rotate |
Allows adjusting the maximum system log size to 2GB and the maximum number of files to 2 to save disk space. Applied by default by anjana-platform. |
|
Extras |
|
|
grafana |
Deploys Grafana along with dashboards and datasources for the visualization of metrics on governed data. |
|
update-dashboards |
Allows updating Grafana dashboards from templates without redeploying Grafana. Replaces all existing dashboards with the templates present in the inventory. |