Tom Smykowski Documentation

Welcome to the official documentation for Tom Smykowski, your Network Automation Broker.

Introduction

• What is Tom? - Overview, architecture summary, and design philosophy

Getting Started

• Getting Started Sensibly - Setup with Vault and Redis TLS
• Getting Started Irresponsibly Fast - 5-minute minimal setup
• Tutorial: Tom with Nautobot - Connect Tom to your existing Nautobot instance

Core Concepts

• Architecture - How Tom's components work together
• Configuration - Config files, environment variables, and validation
• Adapters and Drivers - Supported network platforms (Netmiko, Scrapli)
• Parsing - TextFSM and TTP parsing

Inventory

• Inventory Overview - How inventory works
• YAML Inventory - File-based inventory
• NetBox - NetBox integration
• Nautobot - Nautobot integration
  • Nautobot Device Setup - Configure devices in Nautobot for Tom
• SolarWinds - SolarWinds NPM integration

Authentication

• Authentication Overview - Auth modes and options
• API Keys - Simple key-based auth
• JWT/OAuth - SSO with OAuth providers

Credentials

• Vault Credentials - HashiCorp Vault integration (default, recommended)
• AWS Secrets Manager - AWS Secrets Manager integration
• YAML Credentials - File-based credential store (development only)

Getting Help

• Slack - #tom_smykowski_nab channel on Network to Code Slack
• GitHub Issues - Bug reports and feature requests