Troubleshooting playbooks
Learn about troubleshooting playbooks.
🤓 Who can do this? You need to be an admin user in Atlan to create playbooks.
Here are a few things to know about setting up playbooks:
What are known limitations of domain actions?
Following are the known issues or limitations when using the domain action:
- Atlan doesn't currently support adding glossaries, categories, and terms to domains.
- If you don't have read permission on the assets you want to add to a domain, those assets are removed from the playbook workflow during processing.
- If you don't have update permission on the assets you want to add to a domain, the playbook workflow fails. However, some assets may still be linked to the domain before the failure occurs.
What type of infrastructure costs can I expect to incur?
Atlan uses Elasticsearch to run playbooks, so expect infrastructure costs to be minimal and not a determining factor for utilizing playbooks.
How many playbooks can I run?
Atlan recommends building no more than 20 rules per playbook. However, the total number of playbooks that can be run is still to be determined. From a technical standpoint, playbooks leverage the workflow infrastructure, which means there are no hard limits. Depending on the number of playbooks that need to be run, the infrastructure has to be scaled accordingly.
Do I also need to have update permissions for playbooks?
Yes. You need to have the permission to update assets in Atlan in order to run playbooks for updating them. If you don't have the permission to update an asset, you can't update it using playbooks.
Additionally, Atlan uses the permissions of the playbook creator in determining the assets to be updated and not that of the user who runs the playbook. Your user permissions are used to determine the bulk updates you can make, so that playbooks can't affect assets beyond your scope of access.
Can I automate requests for updates through playbooks?
No, Atlan doesn't currently support automating asset update requests through playbooks.
Can I undo updates made through playbooks?
Currently, there is no button to undo asset updates. However, you can modify your existing playbooks. You can either turn off the filters or add new rules to reverse the updates.
Can I view or download reports of updated assets from previous playbook runs?
Currently, no. You can monitor your existing playbooks to view a high-level summary of asset updates from previous playbook runs. Observability of results is on the roadmap.
Can I get email notifications for playbook run successes or failures?
Currently, no. However, you can set up Slack or Microsoft Teams alerts for your playbook runs in Atlan.
How do I handle offload node status is not supported errors?
If you encounter an offload node status is not supported error message, the playbook workflow may have exceeded the EtcD size limit. Playbooks use Argo workflow templates, which are stored as Kubernetes resources. This creates a limit to their size.
To handle this error, Atlan recommends the following:
- Reduce the number of rules in your playbook
- Optimize filters for asset selection
Why was my custom metadata value cut off after my playbook ran?
In a playbook action, single-value custom metadata properties, such as Text, URL, and SQL, accept up to 200 characters. Text pasted past the limit is cut off without a warning, and the playbook writes the shortened value to every asset the rule matches, on every run.
To fix the affected assets:
- Edit the playbook so that the next run doesn't overwrite your fix: shorten the action value to 200 characters or less, or remove the action.
- Find the affected assets: in discovery, filter on the custom metadata property and look for the shortened value.
- Set the full value on those assets from the asset profile, a spreadsheet, or the Atlan API or SDK.