Your Runbook¶

Customer Managed Applies to customer-managed instances of Alation

Overview¶

As an Alation customer, you should have an admin runbook for Alation. This will enable your IT teams to effectively run your Alation installation. This document is an example of the type of information you will want to capture.

You can get a copy of this document in Microsoft Word format from the Alation Community.

System Architecture¶

Add a description of the architecture of your Alation environment

Example:

Information Access¶

List of people who have access to the Alation server
Steps to request access the Alation server
Steps to access the Alation server

Alation Components¶

Description of Alation components
- Link to Alation help: Alation Architecture
Stopping and starting services
- Link to Alation help: Alation Actions
Monitoring and accessing logs
- Link to Alation help: Monitoring Alation

System Build and Deploy¶

Description of your build and deployment environment, for example automation

Alation System Administration¶

New System Installation¶

Steps for installing a new system in your environment
- Link to Alation help: Server Installation

Software Update¶

Steps to update Alation software in your environment
- Include steps to access the Customer Portal, download the build, and transfer to the Alation server
- Link to Alation help: Updating Alation

Backup¶

Description of Alation’s backups
- Link to Alation help: Backup and Restore
Description of customer specific backups, for example VM Snapshots

Restore¶

Steps to restore an Alation backup in your environment
- Link to Alation help: Backup and Restore
Steps to restore customer specific backups, for example VM Snapshots

High Availability Setup¶

Steps to set up Alation HA in your environment
- Link to Alation help: High Availability
Include customer-specific steps if you have additional processes
Failover steps in your environment
- Link to Alation help: High Availability Failover

Customer-Specific Setup¶

Specific configuration steps for user authentication setup
HTTPS setup notes
Email setup notes

System Monitoring¶

Description of Alation monitoring options and how you use them in your environment
- Link to Alation help: Monitoring Alation
Description of customer-specific monitoring
Disk space monitoring processes in your environment
System expansion steps in your environment

Support Policies/SLAs¶

Description of internal issue reporting policies
Internal SLAs
Scheduled downtimes
Support ticket creation process
Shutdown notification process

Alation Reporting¶

Manual usage
License compliance reporting

Daily Checklist¶