How to onboard
This document outlines the process for onboarding users to our MAS. Successful onboarding requires collaboration between the MAS team and the Service Owner.
I. Pre-Onboarding Requirements ¶
Before onboarding begins, the following prerequisites must be met:
- Service Definition & Documentation: A comprehensive description of the target service, including its architecture, critical components, and expected performance metrics. This should include: - Network Diagram: A clear visual representation of the service's network topology, including all relevant endpoints and connections. - Connectivity Details: Specific information on how the monitoring system will connect to the target service (e.g., IP addresses, ports, protocols). Include firewall rules and any necessary network configurations. - Service Dependencies: A list of all services the target service depends on, and vice-versa. This helps identify potential cascading failures and ensures comprehensive monitoring. - Data Sources: Identification of all data sources that will be monitored (e.g., logs, metrics, traces).
- Scope Definition: Clearly define the scope of monitoring. This includes:
- Number of Endpoints: The total number of endpoints to be monitored. - Number of Docker Images (if applicable): The number of Docker images requiring monitoring. - Alerting Thresholds: Define acceptable thresholds for each metric, triggering alerts when exceeded.
- Resource Allocation: Determine the necessary resources for monitoring, including compute, storage, and network bandwidth. This should be agreed upon by both MAS and the Service Owner.
II. Onboarding Process ¶
The onboarding process varies slightly depending on the type of monitoring required (API, Docker, UI). However, all types share common elements.
A. Common Onboarding Tasks:
| Task | Description | Ownership | Due Date (Example) | Notes |
|---|---|---|---|---|
| Initial Meeting | Kick-off meeting to review service definition, scope, and expectations. | MAS + Service Owner | Within 1 week | Establish clear communication channels and expectations. |
| Credential Provisioning | Securely exchange necessary credentials for accessing the target service. | Service Owner | Within 2 weeks | Emphasize security best practices. Consider using secrets management tools. |
| MCT Check Template Review | Review and finalize the MCT to ensure it accurately reflects the service's requirements. | MAS + Service Owner | Within 1 week | This template should be standardized and include all necessary checks (interval, user account, credentials, alerting rules, core features). |
| Testing & Validation | Thoroughly test the monitoring system to ensure it accurately captures the defined metrics and triggers alerts appropriately. | MAS + Service Owner | Within 1 week | Define clear acceptance criteria and notification audience |
| Go-Live & Handover | Transition the monitoring system to production and provide training to the Service Owner on monitoring dashboards and alert management. | MAS | Within 2 weeks | Document all procedures and provide ongoing support. |
B. Specific Onboarding Tasks by Monitoring Type:
1. API Monitoring:
| Item Name | Description | Ownership | Due Date (Example) |
|---|---|---|---|
| API Guide | Detailed guide on how to register the API checks in to MCT | MAS | Within 1 week |
| Infra YAML (optional) | If applicable, YAML configuration for infrastructure related to API monitoring. | Service Owner | Within 2 weeks |
2. Docker Monitoring:
| Item Name | Description | Ownership | Due Date (Example) |
|---|---|---|---|
| Docker Monitoring Guide (input and output) | Guide on configuring and using the Docker container monitoring. | MAS | Within 1 week |
| Docker Image Link | Link to the Docker image(s) to be monitored. | Service Owner | Immediately |
| Setting YAML | YAML configuration for docker monitoring settings. | Service Owner | Within 2 weeks |
| Secret & Config Repo | Link to the repository containing secrets and configuration files for Docker monitoring. | Service Owner | Immediately |
3. UI Monitoring:
| Item Name | Description | Ownership | Due Date (Example) |
|---|---|---|---|
| UI Monitor Guide | Guide on configuring and using the UI monitoring tools. | MAS | Within 1 week |
| Windows Server Management | MAS will manage the Windows server required for UI monitoring. Additional resource requests need negotiation. | MAS to manage Need negotiation if extra resource needed | Within 2-4 weeks |
| Test User Account | Service Owner provides test user accounts for UI monitoring. | Service Owner | Within 1 week |
| Test Cases | Service Owner provides test cases for validating UI monitoring. | Service Owner | Within 2 weeks |
This guidance provides a framework for onboarding users. Specific details may need adjustment based on individual service requirements. Regular communication and collaboration between MAS and the Service Owner are crucial for a successful onboarding experience.