Home

Catchpoint Configurator

Welcome to the Catchpoint Configurator WIKI! This documentation will guide you through using our powerful Infrastructure-as-Code (IaC) tool for deploying and managing Catchpoint monitoring configurations.

Overview

Catchpoint Configurator is a Python-based tool that enables you to define, deploy, and manage your Catchpoint monitoring configurations as code. It provides a robust framework for creating and maintaining various types of Catchpoint tests, dashboards, and alerts using YAML or JSON configuration files.

Key Features

• Configuration as Code: Define all Catchpoint configurations using YAML/JSON
• Template System: Reusable configuration templates for common monitoring patterns
• Comprehensive Test Support:
  • Web Tests
  • API Tests
  • Transaction Tests
  • DNS Tests
  • Traceroute Tests
• Automated Deployment: Streamlined deployment process with validation
• Version Control Integration: Team collaboration through Git
• CI/CD Ready: Seamless integration with popular CI/CD platforms

Quick Links

• Getting Started
• Installation Guide
• Configuration Guide
• CLI Reference
• API Reference
• Best Practices
• Troubleshooting

Project Status

• Version: 1.0.0
• License: MIT
• Python Versions: 3.9+
• CI/CD: GitHub Actions
• Documentation Status: Active

Community and Support

• GitHub Issues - Bug reports and feature requests
• GitHub Discussions - Community discussions
• Contributing Guide - How to contribute to the project

Quick Start

# Install the package
pip install catchpoint-configurator

# Set up credentials
export CATCHPOINT_CLIENT_ID='your-client-id'
export CATCHPOINT_CLIENT_SECRET='your-client-secret'

# Deploy your first configuration
catchpoint-configurator deploy config.yaml

For detailed instructions, visit our Getting Started Guide.