Snipeit Servers - Ubuntu - MEDAZR-D4T-707

If this article is covering dev / test / production severs within one article, then each environment may have any differences specified within in each category below. Some sections may need multiple outside resources created and added to this page (e.g. a Visio diagram for each environment).

Index

  1. Overview - Executive Summary
  2. How to access
    1. Administrative access
    2. Customer access
  3. Compliance
    1. Copy of Data Use Agreement
    2. FSU Data Classification Level
    3. Compliance Standards this system must meet
  4. Setup and Configuration
    1. Prerequisites
    2. Server(s) Configuration
    3. Server Requirements
    4. Networking
    5. Installing Roles / Features / Applications
    6. Security
    7. Scheduled Jobs
    8. Data Protection
  5. Functionality and Monitoring
    1. Functionality of the system
    2. Service Health
    3. Monitoring
  6. Support
    1. Links to relevant MED KB articles (in TDX)
    2. Links to online support documents from vendors
    3. Initial Procurement Info (if not on the TDX Asset Pages)
    4. Support contact information
  7. Troubleshooting
    1. Common issues to look out for and resolutions to them
  8. Ongoing Maintenance Needs
    1. Special Considerations for OS Updates
    2. Vendor Updates
    3. Is other recurring work required to have this system function optimally?

 

Overview - Executive Summary

Who is the system primarily designed for?

 

What is this system designed to accomplish?

 

How to access

Administrative access

 

Customer access

 

Compliance

Copy of Data Use Agreement

 

FSU Data Classification Level

 

Compliance Standards this system must meet

 

Setup and Configuration

Prerequisites

  1. What needs to exist before this document can be used to fully recreate this application / server?

Server(s) Configuration

Follow the standard procedure for servers, physical or virtual - KBs exist for both

  1. List of Assets Involved in the Application
    1. Links to MED Asset Records (in TDX)
  2. What is the function of each part of the system?
    1.  
  3. Link to code repo

Server Requirements

  1. Hardware requirements for the server(s)
    1. CPU / RAM / Disk space
  2. Vendor Requirements document(s)

Diagrams

  1. Insert relevant diagrams about how the systems interact
    1. network, server, storage, logical, etc.
    2. You may choose to use Draw.io, Visio, or other compatible tool to create the diagrams.
    3. Please store the originals in Microsoft Teams.

Networking

  1. Load Balancing in Use?
    1. Load Balancer Name
    2. VIP IP / name / DNS
    3. Load Balanced Servers
    4. Type of load balancer
  2. DNS Names and IP address information if different than the server's name
  3. Be sure the load balancer information is displayed in the system diagram

Installing Roles / Features / Applications

  1. What needs to be installed and what is the purpose?
  2. How to install each item

Security

  1. User Permissions
    1. Customer permissions
      1. AD Groups and what they have access to
    2. Administrative permissions
      1. AD Groups and what they have access to
      2. What passwords / keys are used? Link to Secret Server secrets.
  2. Logging
    1. Where are logs stored?
    2. Who can access them?
  3. Necessary Firewall Rule Documentation
    1. Rules needed for Windows firewall
    2. Rules needed for external (Sophos) firewall

Scheduled Jobs

  1. What jobs or tasks have been configured to run to ensure that this system functions optimally, and at what frequency?

Data Protection

  1. Backup Process
    1. Where are backups stored?
    2. How often are backups run?
  2. Restore Process
    1. How long of an outage (approximately) does it take to restore?

Functionality and Monitoring

Functionality of the system

  1. What are the key functions that customers rely on for this system?
  2. How are these functions configured in technical detail?

Service Health

  • How do we function test the system to ensure that it is working as intended?
    • Service validation
    • Program validation
    • Website validation

Monitoring

  1. What special monitoring needs does this system have?
  2. What special alerting needs does this system have?

Support

Links to relevant MED KB articles (in TDX)

 

Links to online support documents from vendors

 

Initial Procurement Info (if not on the TDX Asset Pages)

 

Downtime Policy

Define uptime requirements, who to notify, and how to request unscheduled downtime

Support contact information

  1. How to enter support requests
  2. Technical Account Manager
  3. Key support contacts
  4. How to onboard new team members with support

Troubleshooting

What can we do to troubleshoot during the day

  • Simply describe the criticality of the system so a determination can be made for troubleshooting
  • Do we need approval for a therapeutic reboot
    • Individual or team that can provide authorization
      • include a contact method, i.e. distro or teams channel
    • Are there special steps needed to ensure the reboot doesn't break things or to bring the server back up

Common issues to look out for and resolutions to them

 

Ongoing Maintenance Needs

Special Considerations for OS Updates

Vendor (application) Updates

  1. Name of software
  2. Downtime estimate for an update
  3. release cadence of Vendor Updates
  4. Steps to Install Vendor Updates

Is other recurring work required to have this system function optimally?

  1. Downtime estimate
  2. Frequency of the work
  3. Steps to complete the activities
  4. Does the system need a scheduled reboot
Print Article