Welcome to the Admin Toolkit documentation!
The purpose of the toolkit is to:
Execute checks to verify health of Domino deployment
Provide information to assist troubleshooting
Help running some remediation actions
The Admin Toolkit is an always-on application deployed alongside Domino within the Kubernetes cluster. This tool enables Domino administrators to conduct a system scan on the Domino deployment, facilitating the following actions:
Validate the health of core services
Get information to assist troubleshooting, run remediation actions, or provide context about issues affecting the deployment
Provide the toolkit report to Domino Support as part of an incident
The toolkit has a toolkit UI provided at https://<your-domino-url>/toolkit/ where you can view scan reports and initiate new scans. There is also a CLI tool to initiate scans.
You can run scans as many times as necessary because the checks performed by the toolkit do not perform any system modifications. You can run a scan during any of these stages:
After a new Domino install
At the start of an incident
In the midst of an incident
After incident resolution to verify health
Before and after a Domino upgrade
Before and after a Domino migration
Checks
The links below offer explanations for each check, as well as resources for potential remediation steps should a check indicate a failure.
There are currently three different types of checks in the toolkit:
Informational checks just provide information about a deployment and can usually be ignored in a troubleshooting scenario.
They will never fail but may warn.
Pre-upgrade checks that are mostly useful when preparing for an upgrade of the deployment and provide checks that look for common problems that can stop upgrades from being successful.
They can pass, warn and fail.
Pre-migration checks that are mostly useful when preparing for a migration and provide checks that look for common problems that can stop upgrades from being successful.
They can pass, warn and fail.
All other checks are intended to check functionality of the deployment and these are the most useful when troubleshooting. Failures and warnings of these checks should be investigated.
They can pass, warn and fail.
Toolkit Checks: