This is an automated email from the ASF dual-hosted git repository.
mitchell852 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-trafficcontrol.git
The following commit(s) were added to refs/heads/master by this push:
new cc1f812 updates to the README.md and INSTALL.md for the latest changes
cc1f812 is described below
commit cc1f812ca14e6d0f93e21568ca960f1fcd90954b
Author: Dewayne Richardson <dewr...@apache.org>
AuthorDate: Wed Apr 4 09:29:31 2018 -0600
updates to the README.md and INSTALL.md for the latest changes
updated for the command line
---
traffic_ops/INSTALL.md | 2 +-
traffic_ops/traffic_ops_golang/README.md | 78 ++++++++++++++++++++++++++++++++
2 files changed, 79 insertions(+), 1 deletion(-)
diff --git a/traffic_ops/INSTALL.md b/traffic_ops/INSTALL.md
index 35020a0..3a6a128 100644
--- a/traffic_ops/INSTALL.md
+++ b/traffic_ops/INSTALL.md
@@ -28,7 +28,7 @@ Instructions are here: https://yum.postgresql.org/
- From this page, copy the link for CentOS 7 and install:
- $ sudo yum install
https://download.postgresql.org/pub/repos/yum/9.6/redhat/rhel-7-x86_64/pgdg-centos96-9.6-xxxx.noarch.rpm
+ `$ sudo yum install
https://download.postgresql.org/pub/repos/yum/9.6/redhat/rhel-7-x86_64/pgdg-centos96-9.6-xxxx.noarch.rpm`
## Install Postgres 9.6 server (in a container or on the host)
diff --git a/traffic_ops/traffic_ops_golang/README.md
b/traffic_ops/traffic_ops_golang/README.md
index 290ebae..5789517 100644
--- a/traffic_ops/traffic_ops_golang/README.md
+++ b/traffic_ops/traffic_ops_golang/README.md
@@ -17,6 +17,84 @@
under the License.
-->
+Prequisites
+=======================================
+
+To run `traffic_ops_golang` proxy locally the following prerequisites are
needed:
+
+* Golang 1.8.4 or greater See:
[https://golang.org/doc/install](https://golang.org/doc/install)
+* Postgres 9.6 or greater
+* Because the Golang proxy is fronting Mojolicious Perl you need to have that
service setup and running as well [TO Perl Setup
Here](https://github.com/apache/incubator-trafficcontrol/blob/master/traffic_ops/INSTALL.md)
+
+
+vendoring and building
+=======================================
+
+### vendoring
+We treat `golang.org/x` as apart of the Go compiler so that means that we
still vendor application dependencies for stability and reproducible builds.
This is a helpful tool for managing dependencies
[https://github.com/govend/govend](https://github.com/govend/govend])
+
+### building
+To download the remaining `golang.org/x` dependencies you need to:
+
+`$ go get -v`
+
+Configuration
+=======================================
+To run the Golang proxy locally the following represents a typical sequence
flow. */api/1.2* will proxy through to Mojo Perl. */api/1.3* will serve the
response from the Golang proxy directly and/or interact with Postgres
accordingly.
+
+**/api/1.2** routes:
+
+`TO Golang Proxy (port 8443)`<-->`TO Mojo Perl`<-->`TO Database (Postgres)`
+
+**/api/1.3** routes:
+
+`TO Golang Proxy (port 8443)`<-->`TO Database (Postgres)`
+
+### cdn.conf changes
+=======================================
+
+
+Copy `traffic_ops/app/conf/cdn.conf` to `$HOME/cdn.conf` so you can modify it
for development purposes.
+
+`$HOME/cdn.conf`
+
+```
+ "traffic_ops_golang" : {
+ "port" : "443",
+```
+
+```
+ "traffic_ops_golang" : {
+ "port" : "8443",
+```
+
+### Logging
+=======================================
+
+By default `/var/log/traffic_ops/error.log` is configured for output, to
change this modify your `$HOME/cdn.conf` for the following:
+
+`$HOME/cdn.conf`
+
+```
+ "traffic_ops_golang" : {
+ "..."
+ "log_location_error": "stdout",
+ "log_location_warning": "stdout",
+ "log_location_info": "stdout",
+ "log_location_debug": "stdout",
+ "log_location_event": "stdout",
+ ...
+ }
+```
+
+Development
+=======================================
+
+Go is a compiled language so any local changes will require you to CTRL-C the
console and re-run the `traffic_ops_golang` Go binary locally:
+
+`go build && ./traffic_ops_golang -cfg $HOME/cdn.conf -dbcfg
../app/conf/development/database.conf`
+
+
Converting Routes to Traffic Ops Golang
=======================================
--
To stop receiving notification emails like this one, please contact
mitchell...@apache.org.
