| |
| |
| |
| |
| <!DOCTYPE html> |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>Traffic Control — Traffic Control 2.2-dev documentation </title> |
| |
| |
| |
| |
| <link rel="shortcut icon" href="_static/favicon.ico"/> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |
| |
| |
| |
| <link rel="stylesheet" href="_static/theme_overrides.css" type="text/css" /> |
| |
| |
| |
| <link rel="index" title="Index" |
| href="genindex.html"/> |
| <link rel="search" title="Search" href="search.html"/> |
| <link rel="top" title="Traffic Control 2.2-dev documentation" href="#"/> |
| <link rel="next" title="CDN Basics" href="basics/index.html"/> |
| |
| |
| <script src="_static/js/modernizr.min.js"></script> |
| |
| </head> |
| |
| <body class="wy-body-for-nav" role="document"> |
| |
| <div class="wy-grid-for-nav"> |
| |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-nav-search"> |
| |
| |
| |
| <a href="/" class="icon icon-home"> Traffic Control |
| |
| |
| |
| |
| <img src="_static/tc_logo_c_only.png" class="logo" /> |
| |
| </a> |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="basics/index.html">CDN Basics</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="basics/content_delivery_networks.html">Content Delivery Networks</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="basics/http_11.html">HTTP 1.1</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="basics/caching_proxies.html">Caching Proxies</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li> |
| </ul> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="overview/index.html">Traffic Control Overview</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="overview/introduction.html">Introduction</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="overview/traffic_ops.html">Traffic Ops</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="overview/traffic_portal.html">Traffic Portal</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="overview/traffic_router.html">Traffic Router</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="overview/traffic_monitor.html">Traffic Monitor</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="overview/traffic_stats.html">Traffic Stats</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="overview/traffic_vault.html">Traffic Vault</a></li> |
| </ul> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="admin/index.html">Administrator’s Guide</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/using.html">Traffic Ops - Using</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_portal/installation.html">Traffic Portal Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_router.html">Traffic Router Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_stats.html">Traffic Stats Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_server.html">Traffic Server Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_vault.html">Traffic Vault Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/quick_howto/index.html">Quick How To Guides</a></li> |
| </ul> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="development/index.html">Developer’s Guide</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="development/building.html">Building Traffic Control</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="development/traffic_ops.html">Traffic Ops</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="development/traffic_portal.html">Traffic Portal</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="development/traffic_router.html">Traffic Router</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="development/traffic_monitor.html">Traffic Monitor Golang</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="development/traffic_stats.html">Traffic Stats</a></li> |
| </ul> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="api/index.html">APIs</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="api/traffic_ops_api.html">API Overview</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/routes.html">API Routes</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/v11/index.html">API 1.1 Reference</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/v12/index.html">API 1.2 Reference</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/v13/index.html">API 1.3 Reference</a></li> |
| </ul> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="faq/index.html">FAQ</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="faq/general.html">General</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="faq/development.html">Development</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="faq/administration.html">Running a Traffic Control CDN</a></li> |
| </ul> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="#">Traffic Control</a> |
| </nav> |
| |
| |
| |
| <div class="wy-nav-content"> |
| <div class="rst-content"> |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="#">Traffic Control 2.2-dev</a> »</li> |
| |
| <li>Traffic Control</li> |
| <li class="wy-breadcrumbs-aside"> |
| |
| <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a> |
| |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="basics/index.html" class="btn btn-neutral float-right" title="CDN Basics">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| </div> |
| |
| <div role="main" class="document"> |
| |
| <div class="section" id="traffic-control"> |
| <h1>Traffic Control<a class="headerlink" href="#traffic-control" title="Permalink to this headline">¶</a></h1> |
| <p>The vast majority of today’s Internet traffic is media files being sent from a single source to many thousands or even millions of destinations. Content Delivery Networks make that one-to-many distribution possible in an economical way.</p> |
| <p>Traffic Control is an Open Source implementation of a Content Delivery Network.</p> |
| <p>The following documentation sections are available:</p> |
| <div class="section" id="cdn-basics"> |
| <h2>CDN Basics<a class="headerlink" href="#cdn-basics" title="Permalink to this headline">¶</a></h2> |
| <p>A review of the basic functionality of a Content Delivery Network.</p> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="basics/index.html">CDN Basics</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="basics/content_delivery_networks.html">Content Delivery Networks</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="basics/http_11.html">HTTP 1.1</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="basics/caching_proxies.html">Caching Proxies</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="section" id="traffic-control-overview"> |
| <h2>Traffic Control Overview<a class="headerlink" href="#traffic-control-overview" title="Permalink to this headline">¶</a></h2> |
| <p>An introduction to the Traffic Control architecture, components, and their integration.</p> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="overview/index.html">Traffic Control Overview</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="overview/introduction.html">Introduction</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="overview/traffic_ops.html">Traffic Ops</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="overview/traffic_ops.html#arrow-traffic-ops-extension"> Traffic Ops Extension</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="overview/traffic_portal.html">Traffic Portal</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="overview/traffic_router.html">Traffic Router</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="overview/traffic_router.html#arrow-delivery-service"> Delivery Service</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="overview/traffic_router.html#arrow-localization"> Localization</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="overview/traffic_router.html#arrow-dns-content-routing"> DNS Content Routing</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="overview/traffic_router.html#arrow-http-content-routing"> HTTP Content Routing</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="overview/traffic_monitor.html">Traffic Monitor</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="overview/traffic_monitor.html#arrow-cache-monitoring"> Cache Monitoring</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="overview/traffic_monitor.html#arrow-health-protocol"> Health Protocol</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="overview/traffic_stats.html">Traffic Stats</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="overview/traffic_vault.html">Traffic Vault</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="section" id="administrator-s-guide"> |
| <h2>Administrator’s Guide<a class="headerlink" href="#administrator-s-guide" title="Permalink to this headline">¶</a></h2> |
| <p>How to deploy and manage a Traffic Control CDN.</p> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="admin/index.html">Administrator’s Guide</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/installation.html">Traffic Ops - Installing</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/installation.html#system-requirements">System Requirements</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/installation.html#navigating-the-install">Navigating the Install</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/default_profiles.html#minimum-traffic-ops-profiles-needed">Minimum Traffic Ops Profiles needed</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/default_profiles.html#steps-to-import-a-profile">Steps to Import a Profile</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/migration_from_10_to_20.html#system-requirements">System Requirements</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/migration_from_10_to_20.html#setup-the-traffic-ops-db-directory">Setup the traffic_ops_db directory</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/migration_from_10_to_20.html#migration-preparation">Migration Preparation</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/migration_from_10_to_20.html#navigating-the-database-migration">Navigating the Database Migration</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/migration_from_20_to_22.html#per-deliveryservice-routing-names">Per-DeliveryService Routing Names</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/migration_from_20_to_22.html#apache-traffic-server-7-x-cachekey-plugin">Apache Traffic Server 7.x (Cachekey Plugin)</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/migration_from_20_to_22.html#apache-traffic-server-7-x-logging">Apache Traffic Server 7.x (Logging)</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/configuration.html#installing-the-ssl-cert">Installing the SSL Cert</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/configuration.html#content-delivery-networks">Content Delivery Networks</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/configuration.html#profile-parameters">Profile Parameters</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/configuration.html#regions-locations-and-cache-groups">Regions, Locations and Cache Groups</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/configuration.html#configuring-content-purge">Configuring Content Purge</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/configuration.html#configuring-the-go-application">Configuring the Go Application</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/using.html">Traffic Ops - Using</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/using.html#the-traffic-ops-menu">The Traffic Ops Menu</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/using.html#health">Health</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/using.html#server">Server</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/using.html#delivery-service">Delivery Service</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/using.html#parameters-and-profiles">Parameters and Profiles</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/using.html#tools">Tools</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/using.html#invalidate-content">Invalidate Content</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/using.html#manage-dnssec-keys">Manage DNSSEC Keys</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/extensions.html#example-cron-file">Example Cron File</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_portal/installation.html">Traffic Portal Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#dashboard">Dashboard</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#cdns">CDNs</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#monitor">Monitor</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#services">Services</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#configure">Configure</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#topology">Topology</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#tools">Tools</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#user-admin">User Admin</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#other">Other</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#id1">Monitor</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#id2">Services</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#id3">Configure</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#id4">Topology</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#id5">Tools</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#id6">User Admin</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#id7">Other</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_monitor.html#installing-traffic-monitor">Installing Traffic Monitor</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_monitor.html#configuring-traffic-monitor">Configuring Traffic Monitor</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_monitor.html#troubleshooting-and-log-files">Troubleshooting and log files</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_monitor_golang.html">Traffic Monitor Administration</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_monitor_golang.html#installing-traffic-monitor">Installing Traffic Monitor</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_monitor_golang.html#configuring-traffic-monitor">Configuring Traffic Monitor</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_monitor_golang.html#troubleshooting-and-log-files">Troubleshooting and log files</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_router.html">Traffic Router Administration</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_router.html#installing-traffic-router">Installing Traffic Router</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_router.html#configuring-traffic-router">Configuring Traffic Router</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_router.html#dnssec">DNSSEC</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_router.html#troubleshooting-and-log-files">Troubleshooting and log files</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_router.html#event-log-file-format">Event Log File Format</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_router.html#geolimit-failure-redirect-feature">GeoLimit Failure Redirect feature</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_router.html#deep-caching-deep-coverage-zone-topology">Deep Caching - Deep Coverage Zone Topology</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_router.html#steering-feature">Steering feature</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_router.html#https-for-http-type-delivery-services">HTTPS for Http Type Delivery Services</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_router.html#tuning-recommendations">Tuning Recommendations</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_stats.html">Traffic Stats Administration</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_stats.html#installation">Installation</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_stats.html#configuration">Configuration</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_stats.html#id1">InfluxDb Tools</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_server.html">Traffic Server Administration</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_server.html#installing-traffic-server">Installing Traffic Server</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_server.html#configuring-traffic-server">Configuring Traffic Server</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/traffic_vault.html">Traffic Vault Administration</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_vault.html#installing-traffic-vault">Installing Traffic Vault</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_vault.html#configuring-traffic-vault">Configuring Traffic Vault</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/traffic_vault.html#configuring-riak-search">Configuring Riak Search</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="admin/quick_howto/index.html">Quick How To Guides</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="admin/quick_howto/index.html#traffic-ops">Traffic Ops</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="admin/quick_howto/index.html#traffic-portal">Traffic Portal</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="section" id="developer-s-guide"> |
| <h2>Developer’s Guide<a class="headerlink" href="#developer-s-guide" title="Permalink to this headline">¶</a></h2> |
| <p>A guide to the various internal and external APIs, and an introduction for the Traffic Control developer.</p> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="development/index.html">Developer’s Guide</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="development/building.html">Building Traffic Control</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="development/building.html#build-using-pkg">Build using pkg</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/building.html#build-using-docker-compose">Build using docker-compose</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="development/traffic_ops.html">Traffic Ops</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_ops.html#introduction">Introduction</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_ops.html#software-requirements">Software Requirements</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_ops.html#traffic-ops-project-tree-overview">Traffic Ops Project Tree Overview</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_ops.html#perl-formatting-conventions">Perl Formatting Conventions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_ops.html#database-management">Database Management</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_ops.html#installing-the-developer-environment">Installing The Developer Environment</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_ops.html#test-cases">Test Cases</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_ops.html#extensions">Extensions</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="development/traffic_portal.html">Traffic Portal</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_portal.html#introduction">Introduction</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_portal.html#software-requirements">Software Requirements</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_portal.html#traffic-portal-project-tree-overview">Traffic Portal Project Tree Overview</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_portal.html#installing-the-traffic-portal-developer-environment">Installing The Traffic Portal Developer Environment</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_portal.html#notes">Notes</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="development/traffic_router.html">Traffic Router</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_router.html#introduction">Introduction</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_router.html#software-requirements">Software Requirements</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_router.html#traffic-router-project-tree-overview">Traffic Router Project Tree Overview</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_router.html#java-formatting-conventions">Java Formatting Conventions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_router.html#installing-the-developer-environment">Installing The Developer Environment</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_router.html#manual-testing">Manual Testing</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_router.html#test-cases">Test Cases</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_router.html#rpm-packaging">RPM Packaging</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_router.html#api">API</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="development/traffic_monitor.html">Traffic Monitor Golang</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor.html#introduction">Introduction</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor.html#software-requirements">Software Requirements</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor.html#project-tree-overview">Project Tree Overview</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor.html#architecture">Architecture</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor.html#formatting-conventions">Formatting Conventions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor.html#installing-the-developer-environment">Installing The Developer Environment</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor.html#test-cases">Test Cases</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor.html#api">API</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="development/traffic_stats.html">Traffic Stats</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_stats.html#introduction">Introduction</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_stats.html#software-requirements">Software Requirements</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_stats.html#traffic-stats-project-tree-overview">Traffic Stats Project Tree Overview</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_stats.html#go-formatting-conventions">Go Formatting Conventions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_stats.html#installing-the-developer-environment">Installing The Developer Environment</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="development/traffic_stats.html#test-cases">Test Cases</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="section" id="apis"> |
| <h2>APIs<a class="headerlink" href="#apis" title="Permalink to this headline">¶</a></h2> |
| <p>A guide to external RESTful APIs for Traffic Ops</p> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="api/index.html">APIs</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="api/traffic_ops_api.html">API Overview</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="api/traffic_ops_api.html#response-structure">Response Structure</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/traffic_ops_api.html#using-api-endpoints">Using API Endpoints</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/traffic_ops_api.html#api-errors">API Errors</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/traffic_ops_api.html#trafficops-native-client-libraries">TrafficOps Native Client Libraries</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="api/routes.html">API Routes</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/v11/index.html">API 1.1 Reference</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="api/v11/asn.html">ASN</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v11/cachegroup.html">Cache Group</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v11/cdn.html">CDN</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v11/changelog.html">Change Logs</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v11/deliveryservice.html">Delivery Service</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v11/hwinfo.html">Hardware Info</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v11/parameter.html">Parameter</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v11/phys_location.html">Physical Location</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v11/profile.html">Profiles</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v11/region.html">Regions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v11/role.html">Roles</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v11/server.html">Server</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v11/static_dns.html">Static DNS Entries</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v11/status.html">Status</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v11/system.html">System</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v11/to_extension.html">TO Extensions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v11/type.html">Types</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v11/user.html">Users</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="api/v12/index.html">API 1.2 Reference</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/api_capability.html">API-Capabilities</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/asn.html">ASN</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/cache.html">Cache</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/cachegroup.html">Cache Group</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/cachegroup_parameter.html">Cache Group parameters</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/cachegroup_fallbacks.html">Cache Group Fallback</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/cache_stats.html">Cache Statistics</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/capability.html">Capabilities</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/cdn.html">CDN</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/changelog.html">Change Logs</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/configfiles_ats.html">Config Files and Config File Metadata</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/deliveryservice.html">Delivery Service</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/deliveryservice_regex.html">Delivery Service Regexes</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/deliveryservice_stats.html">Delivery Service Statistics</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/division.html">Divisions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/federation.html">Federation</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/federation_deliveryservice.html">Federation Delivery Service</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/federation_federationresolver.html">Federation Federation Resolver</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/federation_resolver.html">Federation Resolver</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/federation_user.html">Federation User</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/hwinfo.html">Hardware Info</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/iso.html">ISO</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/job.html">Jobs</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/parameter.html">Parameter</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/phys_location.html">Physical Location</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/profile.html">Profiles</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/profile_parameter.html">Profile parameters</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/influxdb.html">InfluxDB</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/region.html">Regions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/role.html">Roles</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/server.html">Server</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/static_dns.html">Static DNS Entries</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/status.html">Status</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/steering_target.html">Steering Targets</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/system.html">System</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/tenant.html">Tenants</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/to_extension.html">TO Extensions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/type.html">Types</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/user.html">Users</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v12/topology.html">Snapshot CRConfig</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="api/v13/index.html">API 1.3 Reference</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="api/v13/coordinate.html">Coordinate</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/v13/origin.html">Origin</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="section" id="faq"> |
| <h2>FAQ<a class="headerlink" href="#faq" title="Permalink to this headline">¶</a></h2> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="faq/index.html">FAQ</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="faq/general.html">General</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="faq/general.html#who-is-using-traffic-control">Who is using Traffic Control?</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="faq/general.html#how-do-i-get-help-with-traffic-control">How do I get help with Traffic Control?</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="faq/general.html#what-is-rascal">What is Rascal?</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="faq/general.html#what-is-the-ccr">What is the CCR?</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="faq/general.html#what-is-twelve-monkeys">What is Twelve Monkeys?</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="faq/general.html#what-license-is-traffic-control-released-under">What license is Traffic Control released under?</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="faq/development.html">Development</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="faq/development.html#how-can-i-become-involved">How can I become involved?</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="faq/administration.html">Running a Traffic Control CDN</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="faq/administration.html#cache-group">Cache Group</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="faq/administration.html#profile">Profile</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="section" id="indices-and-tables"> |
| <h2>Indices and Tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="basics/index.html" class="btn btn-neutral float-right" title="CDN Basics">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> |
| <span class="rst-current-version" data-toggle="rst-current-version"> |
| <span class="fa fa-book">Apache Traffic Control (Incubating)</span> |
| v: |
| <span class="fa fa-caret-down"></span> |
| </span> |
| <div class="rst-other-versions"> |
| <dl> |
| <dt>Versions</dt> |
| <dd><a href="/docs/master/">latest</a></dd> |
| <dd><a href="/docs/2.0/">2.0</a></dd> |
| <dd><a href="/docs/1.8.1/">1.8</a></dd> |
| <dd><a href="/docs/1.7.0/">1.7</a></dd> |
| </dl> |
| <hr/> |
| Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>. |
| |
| </div> |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT:'./', |
| VERSION:'2.2-dev', |
| COLLAPSE_INDEX:false, |
| FILE_SUFFIX:'.html', |
| HAS_SOURCE: true, |
| SOURCELINK_SUFFIX: '.txt' |
| }; |
| </script> |
| <script type="text/javascript" src="_static/jquery.js"></script> |
| <script type="text/javascript" src="_static/underscore.js"></script> |
| <script type="text/javascript" src="_static/doctools.js"></script> |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="_static/js/theme.js"></script> |
| |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.StickyNav.enable(); |
| }); |
| </script> |
| |
| |
| </body> |
| </html> |
