Add TO Golang documentation

Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/repo
Commit: 
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/commit/e1dab673
Tree: 
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/tree/e1dab673
Diff: 
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/diff/e1dab673

Branch: refs/heads/master
Commit: e1dab673e47974d049540fe871c4a6b6b16ee277
Parents: b9780d8
Author: Robert Butts <robert.o.bu...@gmail.com>
Authored: Wed Jul 26 18:20:07 2017 -0600
Committer: Dewayne Richardson <dewr...@apache.org>
Committed: Thu Aug 10 09:46:03 2017 -0600

----------------------------------------------------------------------
 docs/source/admin/traffic_ops/configuration.rst | 5 ++++-
 docs/source/overview/traffic_ops.rst            | 4 +++-
 2 files changed, 7 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/blob/e1dab673/docs/source/admin/traffic_ops/configuration.rst
----------------------------------------------------------------------
diff --git a/docs/source/admin/traffic_ops/configuration.rst 
b/docs/source/admin/traffic_ops/configuration.rst
index d293b89..66158d9 100644
--- a/docs/source/admin/traffic_ops/configuration.rst
+++ b/docs/source/admin/traffic_ops/configuration.rst
@@ -296,5 +296,8 @@ This is a standard kickstart formatted file that the 
generate ISO process uses t
 .. seealso:: For in-depth instructions, please see `Kickstart Installation 
<https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Installation_Guide/s1-kickstart2-howuse.html>`_
 
 
+Configuring the Go Application
+=======================
+Traffic Ops is in the process of migrating from Perl to Go, and currently runs 
as two applications. The Go application serves all endpoints which have been 
rewritten in the Go language, and transparently proxies all other requests to 
the old Perl application. Both applications are installed by the RPM, and both 
run as a single service. When the project has fully migrated to Go, the Perl 
application will be removed, and the RPM and service will consist solely of the 
Go application.
 
-
+By default, the postinstall script configures the Go application to behave and 
transparently serve as the old Perl Traffic Ops did in previous versions. This 
includes reading the old ``cdn.conf`` and ``database.conf`` config files, and 
logging to the old ``access.log`` location. However, if you wish to customize 
the Go Traffic Ops application, you can do so by running it with the 
``-oldcfg=false`` argument. By default, it will then look for a config file in 
``/opt/traffic_ops/conf/traffic_ops_golang.json``. The new config file location 
may also be customized via the ``-cfg`` flag. A sample config file is installed 
by the RPM at ``/opt/traffic_ops/conf/traffic_ops_golang.json``. If you wish to 
run the new Go Traffic Ops application as a service with a new config file, the 
``-oldcfg=false`` and  ``-cfg`` flags may be added to the ``start`` function in 
the service file, located by default at ``etc/init.d/traffic_ops``.

http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/blob/e1dab673/docs/source/overview/traffic_ops.rst
----------------------------------------------------------------------
diff --git a/docs/source/overview/traffic_ops.rst 
b/docs/source/overview/traffic_ops.rst
index 9cc72ee..7053c7b 100644
--- a/docs/source/overview/traffic_ops.rst
+++ b/docs/source/overview/traffic_ops.rst
@@ -21,10 +21,12 @@ Traffic Ops is the tool for administration (configuration 
and monitoring) of all
 
 Traffic Ops uses a MySQL or PostgreSQL database to store the configuration 
information, and the `Mojolicious framework <http://mojolicio.us/>`_ to 
generate the user interface and APIs. Not all configuration data is in this 
database however; for sensitive data, like SSL private keys or token based 
authentication shared secrets, a separate key-value store is used, allowing the 
operator to harden the server that runs this key-value store better from a 
security perspective (i.e only allow Traffic Ops access it with a cert). The 
Traffic Ops server, by design, needs to be accessible from all the other 
servers in the Traffic Control CDN. 
 
-Traffic Ops generates all the application specific configuration files for the 
caches and other servers. The caches and other servers check in with Traffic 
Ops at a regular interval (default 15 minutes) to see if updated configuration 
files require application. 
+Traffic Ops generates all the application specific configuration files for the 
caches and other servers. The caches and other servers check in with Traffic 
Ops at a regular interval (default 15 minutes) to see if updated configuration 
files require application.
 
 Traffic Ops also runs a collection of periodic checks to determine the 
operational readiness of the caches. These periodic checks are customizable by 
the Traffic Ops admin using extensions.
 
+Traffic Ops is in the process of migrating from Perl to Go, and currently runs 
as two applications. The Go application serves all endpoints which have been 
rewritten in the Go language, and transparently proxies all other requests to 
the old Perl application. Both applications are installed by the RPM, and both 
run as a single service. When the project has fully migrated to Go, the Perl 
application will be removed, and the RPM and service will consist solely of the 
Go application.
+
 |
 
 .. _rl-trops-ext: 

Reply via email to