domino_admin_toolkit.checks.test_domino_filesystem module

pydantic model domino_admin_toolkit.checks.test_domino_filesystem.DominoFileSystemAnalyzer

Bases: AnalyzerBase

Validates Domino File System meets availability and functionality requirements.

Evaluates:

  • File system service health status

  • Project README file accessibility

  • MongoDB and API connectivity

Fields:
field expected_healthy_status: bool = True

Expected healthy status

analyze(data)

Analyze Domino File System health data from DominoFileSystemClient.

Return type:

list[CheckResult]

Args:
data: DataFrame containing filesystem check results with columns:

  • service_name: Name of the service being checked

  • status: “green” or “red” from ServiceCheckResult

  • message: Detailed message from the check

  • is_healthy: Boolean indicating if filesystem is healthy

Returns:

List of CheckResult objects indicating filesystem health

name: ClassVar[str] = 'DominoFileSystemAnalyzer'
domino_admin_toolkit.checks.test_domino_filesystem.filesystem_data()

Retrieves Domino File System health data using DominoFileSystemClient

domino_admin_toolkit.checks.test_domino_filesystem.test_domino_filesystem(filesystem_data)
Purpose:

Validates Domino File System functionality by testing project file accessibility. Verifies that the file system can serve project files by attempting to retrieve README files.

Services Involved:

  • nucleus-frontend: Domino’s main API service

  • MongoDB: Project metadata storage

  • Domino Git Server: Project file versioning

  • Authentication services (Keycloak): API request authorization

Failure Conditions:

  • MongoDB connection failures preventing project enumeration

  • nucleus-frontend API connectivity issues blocking file retrieval

  • Authentication service problems preventing API authorization

  • Git server or file storage backend connectivity issues

  • Network connectivity problems between services

Troubleshooting Steps:

  1. Check MongoDB service status and logs for connection issues

  2. Verify nucleus-frontend service health and recent logs

  3. Review authentication service (Keycloak) status for API authorization issues

  4. Check Domino Git Server connectivity and storage backend health

  5. Review network policies and service connectivity between components