README
¶
Traffic Ops is the tool for administration (configuration and monitoring) of all components in a Traffic Control CDN. The CDN administrator uses Traffic Ops to manage servers, cache groups, delivery services, etc. In many cases, a configuration change requires propagation to several, or even all, caches and only explicitly after or before the same change propagates to Traffic Router. Traffic Ops takes care of this required consistency between the different components and their configuration. Traffic Ops exposes its data through a series of HTTP APIs.
For more info see the Traffic Control Website
Directories
¶
| Path | Synopsis |
|---|---|
|
app
|
|
|
install
|
|
| * | |
|
testing
|
|
|
api/config
Package config provides tools to load and validate configuration data for Traffic Ops API tests.
|
Package config provides tools to load and validate configuration data for Traffic Ops API tests. |
|
api/utils
Package utils provides helpful utilities for easing the process of testing Traffic Ops API clients.
|
Package utils provides helpful utilities for easing the process of testing Traffic Ops API clients. |
|
Package toclientlib provides shared symbols for Traffic Ops Go clients.
|
Package toclientlib provides shared symbols for Traffic Ops Go clients. |
|
api
Package api provides general purpose tools for implementing the Traffic Ops API.
|
Package api provides general purpose tools for implementing the Traffic Ops API. |
|
apicapability
Package apicapability defines the API handlers for Traffic Ops's API's /api_capabilities endpoint.
|
Package apicapability defines the API handlers for Traffic Ops's API's /api_capabilities endpoint. |
|
cachegroupparameter
Package cachegroupparameter is deprecated and will be removed with API v1-3.
|
Package cachegroupparameter is deprecated and will be removed with API v1-3. |
|
capabilities
Package capabilities contains logic and handlers for the /capabilities API endpoint.
|
Package capabilities contains logic and handlers for the /capabilities API endpoint. |
|
cdn_lock
Package cdn_lock contains the CRD methods which aid in locking and unlocking CDNs.
|
Package cdn_lock contains the CRD methods which aid in locking and unlocking CDNs. |
|
cdnfederation
Package cdnfederation is one of many, many packages that contain logic pertaining to federations of CDNs and/or parts of CDNs.
|
Package cdnfederation is one of many, many packages that contain logic pertaining to federations of CDNs and/or parts of CDNs. |
|
coordinate
Package coordinate contains API handlers and associated logic for servicing the `/coordinates` API endpoint.
|
Package coordinate contains API handlers and associated logic for servicing the `/coordinates` API endpoint. |
|
deliveryservice
Package deliveryservice contains logic and handlers for /deliveryservices and related sub-routes (e.g.
|
Package deliveryservice contains logic and handlers for /deliveryservices and related sub-routes (e.g. |
|
deliveryservice/request
Package request contains logic and handlers for API routes dealing with Delivery Service Requests (DSRs).
|
Package request contains logic and handlers for API routes dealing with Delivery Service Requests (DSRs). |
|
deliveryservicerequests
Package deliveryservicerequests contains the handler for the endpoint responsible for issuing a request for Delivery Service creation via email - not to be confused with package github.com/apache/trafficcontrol/v8/traffic_ops/traffic_ops_golang/deliveryservice/request.
|
Package deliveryservicerequests contains the handler for the endpoint responsible for issuing a request for Delivery Service creation via email - not to be confused with package github.com/apache/trafficcontrol/v8/traffic_ops/traffic_ops_golang/deliveryservice/request. |
|
federation_resolvers
Package federation_resolvers contains handler logic for the /federation_resolvers and /federation_resolvers/{{ID}} endpoints.
|
Package federation_resolvers contains handler logic for the /federation_resolvers and /federation_resolvers/{{ID}} endpoints. |
|
iso
Package iso provides support for generating ISO images.
|
Package iso provides support for generating ISO images. |
|
logs
Package logs contains handlers and logic for the /logs and /logs/newcount API endpoints.
|
Package logs contains handlers and logic for the /logs and /logs/newcount API endpoints. |
|
monitoring
Package monitoring contains handlers and supporting logic for the /cdns/{{CDN Name}}/configs/monitoring Traffic Ops API endpoint.
|
Package monitoring contains handlers and supporting logic for the /cdns/{{CDN Name}}/configs/monitoring Traffic Ops API endpoint. |
|
profile
Package profile includes logic and handlers for Profile-related API endpoints, including /profiles, /profiles/name/{{name}}/parameters, /profiles/{{ID}}/parameters, /profiles/name/{{New Profile Name}}/copy/{{existing Profile Name}}, /profiles/import, and /profiles/{{ID}}/export.
|
Package profile includes logic and handlers for Profile-related API endpoints, including /profiles, /profiles/name/{{name}}/parameters, /profiles/{{ID}}/parameters, /profiles/name/{{New Profile Name}}/copy/{{existing Profile Name}}, /profiles/import, and /profiles/{{ID}}/export. |
|
routing
Package routing defines the HTTP routes for Traffic Ops and provides tools to register those routes with appropriate middleware.
|
Package routing defines the HTTP routes for Traffic Ops and provides tools to register those routes with appropriate middleware. |
|
routing/middleware
Package middleware provides symbols for HTTP "middleware" which wraps handlers to perform common behaviors, such as authentication, headers, and compression.
|
Package middleware provides symbols for HTTP "middleware" which wraps handlers to perform common behaviors, such as authentication, headers, and compression. |
|
server
Package server provides tools for manipulating the server database table and corresponding http handlers.
|
Package server provides tools for manipulating the server database table and corresponding http handlers. |
|
swaggerdocs/v13
Package docs Traffic Ops API
|
Package docs Traffic Ops API |
|
trafficvault
Package trafficvault provides the interfaces and types necessary to support various Traffic Vault backend data stores.
|
Package trafficvault provides the interfaces and types necessary to support various Traffic Vault backend data stores. |
|
trafficvault/backends
Package backends is simply for importing the traffic vault backend packages so they can initialize.
|
Package backends is simply for importing the traffic vault backend packages so they can initialize. |
|
trafficvault/backends/disabled
Package disabled provides a TrafficVault implementation that simply returns an error for every method stating that Traffic Vault is disabled.
|
Package disabled provides a TrafficVault implementation that simply returns an error for every method stating that Traffic Vault is disabled. |
|
trafficvault/backends/postgres
Package postgres provides a TrafficVault implementation which uses PostgreSQL as the backend.
|
Package postgres provides a TrafficVault implementation which uses PostgreSQL as the backend. |
|
trafficvault/backends/riaksvc
Package riaksvc provides a TrafficVault implementation which uses Riak as the backend.
|
Package riaksvc provides a TrafficVault implementation which uses Riak as the backend. |
|
Package client implements methods for interacting with the Traffic Ops API.
|
Package client implements methods for interacting with the Traffic Ops API. |
|
Package client implements methods for interacting with the Traffic Ops API.
|
Package client implements methods for interacting with the Traffic Ops API. |
|
Package client implements methods for interacting with the Traffic Ops API.
|
Package client implements methods for interacting with the Traffic Ops API. |
Click to show internal directories.
Click to hide internal directories.