Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Guide: Pre-checks Before Escalating Turbot Guardrails Console Access Issues as #Critical ticket #106

Open
17 tasks
rajlearner17 opened this issue Sep 30, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation guide stale

Comments

@rajlearner17
Copy link
Contributor

rajlearner17 commented Sep 30, 2024

Note:

  1. Will contain sample steps as applicable to check various aspects
  2. Seggregate a section for SaaS vs Enterprise?

Runbook: Pre-checks Before Escalating Turbot Guardrails Console Access Issues

Description

This runbook should outline the steps to perform before raising a critical ticket when experiencing issues accessing the Turbot Guardrails console. It helps identify and troubleshoot common issues to avoid unnecessary escalations.

Pre-checks to Perform

  1. Confirm Console Accessibility

    • Attempt to access the Turbot Guardrails console from:
      • Different browsers (clear cache and cookies)
      • Different devices
      • Different networks (e.g., bypass VPN, switch to another network)
  2. Check Turbot Guardrails Service Status ( if SaaS Customer)

    • Verify if there are any ongoing issues on the Turbot Service Status page (link to status page, if available).
    • Review recent notifications or maintenance alerts from Turbot regarding scheduled downtimes or incidents.
  3. Network and Connectivity Check

    • Ensure that there are no local network issues by confirming:
      • No ongoing VPN issues
      • Firewall rules or proxy settings aren't blocking access
    • Ping the Guardrails endpoint or use a network monitoring tool to check for connectivity problems.
      (- Provide sample commands for curl, nslookup etc)
  4. AWS Infrastructure Health Check

    • Verify the status of critical AWS resources supporting Turbot Guardrails, such as:
      • EC2 instances
      • RDS databases
      • Networking components (VPC, subnets, routes)
    • Use AWS CloudWatch or your monitoring tools to identify any resource failures or outages.
  5. Turbot CLI Access

    • Test whether the issue is specific to the console by attempting access via Turbot CLI.
    • Run basic commands (e.g., list guardrails or check AWS account configurations) to ensure Turbot services are still responsive.
  6. Browser Console & Network Logs

    • Inspect browser console logs (F12 or right-click > Inspect) for any errors related to access.
    • Check for failed network requests in the Network tab of your browser developer tools.

Criteria for Raising a Critical Ticket

If all the above pre-checks are completed and access to the console remains unavailable, escalate the issue by opening a critical ticket with the following details:

  • Description of the issue (e.g., console access failure, timeout, blank page)
  • Results of the pre-checks (attach logs, error messages, screenshots, etc.)
  • Affected AWS accounts or regions (if relevant)
  • Time and date of the issue onset

Escalation Path

  • Contact the internal team responsible for AWS/Guardrails monitoring.
  • Raise a critical ticket with Turbot Support, attaching all pre-check logs and diagnostic information.
@rajlearner17 rajlearner17 self-assigned this Sep 30, 2024
@rajlearner17 rajlearner17 added the documentation Improvements or additions to documentation label Sep 30, 2024
@rajlearner17 rajlearner17 changed the title Runbook: Pre-checks Before Escalating Turbot Guardrails Console Access Issues as #Critical ticket Guide: Pre-checks Before Escalating Turbot Guardrails Console Access Issues as #Critical ticket Oct 25, 2024
Copy link

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 30 days.

@github-actions github-actions bot added the stale label Dec 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation guide stale
Projects
None yet
Development

No branches or pull requests

1 participant