Detailed explanation of the tags available in the Ansible kit
|
Generic |
|
|
Run without tag |
Anjana + persistence stores are deployed without sample data. |
|
anjana-sample |
Deploys Anjana + persistence stores with sample data. |
|
platform |
Prepares the machine with everything needed for anjana to work correctly, 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 the software to have been downloaded beforehand. This tag allows downloading everything.
It is run in manager mode and downloads jars, datasets, software, and utilities that Anjana requires, to be copied to another Ansible node without internet connectivity and deploy Anjana in local mode. |
|
ansible-user |
Allows creating a user with a group and key on all nodes, authorizing its use, specific for running ansible.
A user with administrator permissions to access directories and files (like root) is required to run this tag. |
|
Microservices |
|
|
portuno kerno zeus drittesta minerva viator hermes tot horus marketplace |
Deploys the selected microservice.
Among the tasks performed are backing up, deleting and downloading the jars, and creating or overwriting the existing service descriptor. |
|
anjana-ui
|
Deploys Apache2 with the / and /configpanel front ends. Creates or overwrites the Apache configuration files for both front ends. |
|
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 are backing up, deleting and downloading the jars, and creating or overwriting the existing service descriptor. |
|
tot-plugins |
Deploys all plugins enabled in import_roles in all.yaml |
|
Updates |
|
|
update |
Runs all update tasks for the jars, front ends and CDN. |
|
update-config |
Updates/deploys the microservices' configuration files. 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 Anjana's microservices. Replaces all the 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 update-marketplace |
Updates the jar of the selected microservice. |
|
update-anjana-ui |
Updates the / and /configpanel front ends, 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 selected plugin. |
|
Persistence stores |
|
|
persistences |
Installs all the persistence stores selected in all.yml. |
|
persistences-sample |
Installs all the persistence stores + sample data selected in all.yml. Running this tag involves a controlled stop of all microservices. |
|
delete-persistences |
Deletes the installed persistence stores selected in all.yml This action also deletes all the content of each persistence store; a prior backup/export is required. |
|
delete-minio |
Deletes the minio installation along with its data. This action also deletes all of minio's content; a prior backup/export is required. |
|
delete-solrzk |
Deletes the solr and zookeeper installation along with the collections. |
|
update-persistences |
Deletes the installed persistence stores selected in all.yml and then installs the latest version indicated in the variable files of each persistence store. This action also deletes all the content of each persistence store; a prior backup/export is required. |
|
postgresql zookeeper solr minio valkey mongodb rabbitmq |
Installs the chosen persistence store. |
|
export import |
Runs the export and import of data for an Anjana environment (MinIO and DB). The default directory for export and import is /opt/export-import. Running this tag involves a controlled stop of all microservices. |
|
import-bbdd import-s3 |
Runs the import of data into an Anjana environment for the selected persistence stores. Running this tag involves a controlled stop of all microservices. |
|
backup-dump |
Runs a dump of the persistence stores + config and uploads it to the specified anjanabackups bucket. Running this tag involves a controlled stop of all microservices. |
|
restore-dump |
Allows restoring a dump available in the anjanabackups bucket, choosing from the available ones. Running this tag involves a controlled stop of all microservices. |
|
dump-cron |
Deploys a cron job that will automatically run ansible with the backup-dump tag. It is configurable in persistencesutilityhosts.yml. |
|
clone deploy |
Clone runs the export of data for an Anjana environment, generating a .tgz archive. Deploy deploys the cloned data from an existing archive.
Includes persistence stores (MinIO and DB) and the configuration. Running this tag involves a controlled stop of all microservices. |
|
deploy-bbdd deploy-s3 deploy-config |
Runs the deployment of data into an Anjana environment for the selected persistence stores and/or configuration Running this tag involves a controlled stop of all microservices. |
|
skip-backup |
It is used by launching it with skip-tags (--skip-tags skip-backup), to prevent a backup from being made during the ansible run. |
|
backup backup-persistences backup-config |
Performs the backup of the configuration and the persistence stores' data. It can be run together, or configuration and persistence stores separately. Cannot be combined with export or deploy. |
|
restore restore-s3 restore-bbdd restore-config |
Allows restoring the chosen persistence store and/or configuration from the latest available backup.
If no backup is available, a warning will be shown and execution will stop. Running this tag involves a controlled stop of all microservices. |
|
delete delete-bbdd delete-s3 delete-solr delete-config |
Allows deleting the data of the chosen persistence store and/or configuration
Running this tag involves a controlled stop of all microservices. |
|
insert insert-bbdd insert-s3 |
An insert is performed with the dataset chosen in all.yml into MinIO and the DB for the selected persistence stores. Running this tag involves a controlled stop of all microservices. |
|
reset reset-bbdd reset-s3 |
Performs a deletion with a prior backup and reinsertion of data for the chosen persistence stores. Running this tag involves a controlled stop 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 anjana.sh installer script to update the ansible kit. |
|
clean |
Deletes what was downloaded in the temporary folder. |
|
aliases |
Allows updating the system aliases controlled by ansible, needed for microservice communication. |
|
check-connection |
Checks Anjana's connection to the persistence stores. |
|
check-repository |
Checks the connection to Anjana's artifact repository. |
|
post-upgrade-cleanup |
Deletes all discontinued services, folders, files, etc. Recommended once the upgrade to 25.2 has finished successfully |
|
start |
Starts all microservices in an orderly fashion. |
|
stop |
Stops the entire Anjana installation in an orderly fashion, starting with the microservices that depend on others and ending with the persistence stores. |
|
restart |
Performs an orderly stop and then start of all of Anjana. |
|
restart-microservices |
Restarts Anjana's services without ordering. |
|
start-zookeeper start-postgresql start-minio start-solr start-mongodb start-rabbitmq start-valkey start-portuno start-zeus start-kerno start-minerva start-horus start-marketplace 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, first selectively and in order starting all the microservices and persistence stores it needs to function. |
|
stop-zookeeper stop-postgresql stop-minio stop-solr stop-mongodb stop-rabbitmq stop-valkey stop-portuno stop-zeus stop-kerno stop-minerva stop-horus stop-marketplace 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, first selectively and in order stopping all the microservices that depend on it. |
|
uninstall |
Proceeds with a complete uninstallation of Anjana, including any third-party software that has been deployed with the kit, in the selected inventory.
The Ansible folder is not deleted because it would prevent the run from finishing. Existing backups and exports are kept. |
|
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 access IPs without deploying the entire front end. |
|
certificate-deploy |
Allows deploying the renewed certificate for the microservices, front ends and persistence stores. The new certificate must be located at /opt/common/anjana-certs, available before running this tag. |
|
Logs and Audit |
|
|
export-log |
Exports the logs of Anjana's 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 in the /opt/anjana-logs folder and uploads them to the anjanalogs bucket configured in all.yml. This means that the 'export-log' tag must have been run beforehand |
|
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 the dashboards and datasources for visualizing metrics on the governed data. |
|
update-dashboards |
Allows updating Grafana's dashboards from the templates without redeploying Grafana. Replaces all existing dashboards with the templates present in the inventory. |