| |
| |
| <!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>Building Traffic Control — Traffic Control 2.1-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="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/> |
| <link rel="up" title="Developer’s Guide" href="index.html"/> |
| <link rel="next" title="Traffic Ops" href="traffic_ops.html"/> |
| <link rel="prev" title="Developer’s Guide" href="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_server.html">Traffic Server</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/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.html">Traffic Portal Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</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 class="current"> |
| <li class="toctree-l1 current"><a class="reference internal" href="index.html">Developer’s Guide</a><ul class="current"> |
| <li class="toctree-l2 current"><a class="current reference internal" href="#">Building Traffic Control</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html">Traffic Monitor Golang</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</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="../index.html">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="../index.html">Traffic Control 2.1-dev</a> »</li> |
| |
| <li><a href="index.html">Developer’s Guide</a> »</li> |
| |
| <li>Building Traffic Control</li> |
| <li class="wy-breadcrumbs-aside"> |
| |
| <a href="../_sources/development/building.txt" rel="nofollow"> View page source</a> |
| |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="traffic_ops.html" class="btn btn-neutral float-right" title="Traffic Ops">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="index.html" class="btn btn-neutral" title="Developer’s Guide"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| <div role="main" class="document"> |
| |
| <div class="section" id="building-traffic-control"> |
| <span id="dev-building"></span><h1>Building Traffic Control<a class="headerlink" href="#building-traffic-control" title="Permalink to this headline">¶</a></h1> |
| <div class="section" id="build-using-pkg"> |
| <h2>Build using pkg<a class="headerlink" href="#build-using-pkg" title="Permalink to this headline">¶</a></h2> |
| <p>This is the easiest way to build all the components of Traffic Control; |
| all requirements are automatically loaded into the image used to build |
| each component.</p> |
| <div class="section" id="requirements"> |
| <h3>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h3> |
| <ul class="simple"> |
| <li><code class="docutils literal"><span class="pre">docker</span></code> (<a class="reference external" href="https://docs.docker.com/engine/installation/">https://docs.docker.com/engine/installation/</a>)</li> |
| <li><code class="docutils literal"><span class="pre">docker-compose</span></code> (<a class="reference external" href="https://docs.docker.com/compose/install/">https://docs.docker.com/compose/install/</a>) |
| (optional, but recommended)</li> |
| </ul> |
| <p>If <code class="docutils literal"><span class="pre">docker-compose</span></code> is not available, the <code class="docutils literal"><span class="pre">pkg</span></code> script will |
| automatically download and run it in a container. This is noticeably |
| slower than running it natively.</p> |
| </div> |
| <div class="section" id="usage"> |
| <h3>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h3> |
| <div class="highlight-default"><div class="highlight"><pre><span></span>$ ./pkg -? |
| Usage: ./pkg [options] [projects] |
| -q Quiet mode. Supresses output. |
| -v Verbose mode. Lists all build output. |
| -l List available projects. |
| |
| If no projects are listed, all projects will be packaged. |
| Valid projects: |
| - traffic_portal_build |
| - traffic_router_build |
| - traffic_monitor_build |
| - source |
| - traffic_ops_build |
| - traffic_stats_build |
| </pre></div> |
| </div> |
| <p>If any project names are provided on the command line, only those will be built. |
| Otherwise, all projects are built.</p> |
| <p>All artifacts (rpms, logs, source tar ball) are copied to <code class="docutils literal"><span class="pre">dist</span></code> at the top level of the |
| <code class="docutils literal"><span class="pre">incubator-trafficcontrol</span></code> directory.</p> |
| </div> |
| <div class="section" id="example"> |
| <h3>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h3> |
| <div class="highlight-default"><div class="highlight"><pre><span></span>$ ./pkg -v source traffic_ops_build |
| Building source. |
| Building traffic_ops_build. |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="build-using-docker-compose"> |
| <h2>Build using docker-compose<a class="headerlink" href="#build-using-docker-compose" title="Permalink to this headline">¶</a></h2> |
| <p>If the <code class="docutils literal"><span class="pre">pkg</span></code> script fails, <code class="docutils literal"><span class="pre">docker-compose</span></code> can still be used directly.</p> |
| <div class="section" id="id1"> |
| <h3>Usage<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3> |
| <div class="highlight-default"><div class="highlight"><pre><span></span>$ docker-compose -f ./infrastructure/docker/build/docker-compose.yml down -v |
| $ docker-compose -f ./infrastructure/docker/build/docker-compose.yml up --build source traffic_ops_build |
| $ ls -1 dist/ |
| build-traffic_ops.log |
| traffic_ops-2.1.0-6396.07033d6d.el7.src.rpm |
| traffic_ops-2.1.0-6396.07033d6d.el7.x86_64.rpm |
| traffic_ops_ort-2.1.0-6396.07033d6d.el7.src.rpm |
| traffic_ops_ort-2.1.0-6396.07033d6d.el7.x86_64.rpm |
| trafficcontrol-incubating-2.1.0.tar.gz |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="traffic_ops.html" class="btn btn-neutral float-right" title="Traffic Ops">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="index.html" class="btn btn-neutral" title="Developer’s Guide"><span class="fa fa-arrow-circle-left"></span> Previous</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> |
| |
| |
| |
| |
| |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT:'../', |
| VERSION:'2.1-dev', |
| COLLAPSE_INDEX:false, |
| FILE_SUFFIX:'.html', |
| HAS_SOURCE: true, |
| SOURCELINK_SUFFIX: '' |
| }; |
| </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> |
