apache · dangogh · Aug 27, 2018 · Aug 29, 2018 · Sep 10, 2018 · Sep 18, 2018
diff --git a/.dependency_license b/.dependency_license
@@ -51,12 +51,14 @@ cron\.d/[^/]*$, Apache
 ^misc/traffic-control-cdn/images/traffic_portal_logo\.png, Apache
 ^misc/traffic-control-cdn/images/traffic_router_logo\.png, Apache
 ^misc/traffic-control-cdn/images/traffic_stats_logo\.png, Apache
-^misc/logos/Traffic-Control-Logo-FINAL-Black-Text\.png, Apache
-^misc/logos/Traffic-Control-Logo-FINAL-White-Text\.png, Apache
-^misc/logos/Traffic-Control-Logo-FINALc\.png\.zip, Apache
-^misc/logos/atc-final\.svg, Apache
-^misc/logos/atc-final\.psd, Apache
-^misc/logos/atc-largepng-c-only\.png, Apache
+^misc/logos/ATC-PNG\.png, Apache
+^misc/logos/ATC-PNG-FULL-BLACK\.png, Apache
+^misc/logos/ATC-PNG-FULL-BLACK-LARGE\.png, Apache
+^misc/logos/ATC-PNG-FULL-WHITE\.png, Apache
+^misc/logos/ATC-PNG-FULL-WHITE-LARGE\.png, Apache
+^misc/logos/ATC-PNG-LARGE\.png, Apache
+^misc/logos/ATC-SVG\.sketch, Apache
+^misc/logos/ATC-SVG-FULL\.sketch, Apache
 ^misc/logos/page_logos/trafficLogoFactory\.psd, Apache
 ^misc/logos/page_logos/traffic_monitor_logo\.png, Apache
 ^misc/logos/page_logos/traffic_operations_logo\.png, Apache

diff --git a/.rat-excludes b/.rat-excludes
@@ -21,6 +21,7 @@ testFiles(?:                         test data that is neither code nor capable
 .*\.spec(?:                          Specifies license, among other things. ){0}
 .*\.test(?:                          test data ){0}
 .*\.txt(?:                           text data files can't handle comments, so their licenses must be documented as part of their project ){0}
+.*\.sketch(?:                        sketch files are binary source image files and don't bear license information ){0}
 ssl\.(?:crt|key)(?:                  demo certificate ){0}
 keystore.*(?:                        keystore ){0}
 README.*(?:                          Readme's don't usually require a separate license. ){0}

diff --git a/docs/source/api/v11/server.rst b/docs/source/api/v11/server.rst
@@ -72,7 +72,7 @@ Server
   +--------------------+--------+------------------------------------------------------------------------------------------------------------+
   | ``iloIpNetmask``   | string | The IPv4 netmask of the lights-out-management port.                                                        |
   +--------------------+--------+------------------------------------------------------------------------------------------------------------+
-  | ``iloPassword``    | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
+  | ``iloPassword``    | string | The password of the of the lights-out-management user (displays as ****** unless 'ops' / 'admin' user).    |
   +--------------------+--------+------------------------------------------------------------------------------------------------------------+
   | ``iloUsername``    | string | The user name for lights-out-management.                                                                   |
   +--------------------+--------+------------------------------------------------------------------------------------------------------------+
@@ -228,7 +228,7 @@ Server
   +--------------------+--------+------------------------------------------------------------------------------------------------------------+
   | ``iloIpNetmask``   | string | The IPv4 netmask of the lights-out-management port.                                                        |
   +--------------------+--------+------------------------------------------------------------------------------------------------------------+
-  | ``iloPassword``    | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
+  | ``iloPassword``    | string | The password of the of the lights-out-management user (displays as ****** unless 'ops' / 'admin' user).    |
   +--------------------+--------+------------------------------------------------------------------------------------------------------------+
   | ``iloUsername``    | string | The user name for lights-out-management.                                                                   |
   +--------------------+--------+------------------------------------------------------------------------------------------------------------+
@@ -422,7 +422,7 @@ Server
   +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
   | ``iloIpNetmask``     | string | The IPv4 netmask of the lights-out-management port.                                                         |
   +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
-  | ``iloPassword``      | string | The password of the of the lights-out-management user  (displays as ****** unless you are an 'admin' user). |
+  | ``iloPassword``      | string | The password of the of the lights-out-management user (displays as ****** unless 'ops' / 'admin' user).     |
   +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
   | ``iloUsername``      | string | The user name for lights-out-management.                                                                    |
   +----------------------+--------+-------------------------------------------------------------------------------------------------------------+

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -25,10 +25,13 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
-
+import os
+import sys
+ortPath = os.path.dirname(__file__)
+ortPath = os.path.join(ortPath, '..', '..', 'infrastructure', 'cdn-in-a-box', 'edge')
+ortPath = os.path.abspath(ortPath)
+print("Looking for Python-based ORT in '", ortPath, ",", sep="")
+sys.path.insert(0, ortPath)
 
 # -- Project information -----------------------------------------------------
 
@@ -52,6 +55,8 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+	'sphinx.ext.autodoc',
+	'sphinx_autodoc_typehints'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -122,27 +127,27 @@
 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
     #
-    # 'papersize': 'letterpaper',
+    'papersize': 'a4paper',
 
     # The font size ('10pt', '11pt' or '12pt').
     #
-    # 'pointsize': '10pt',
+    'pointsize': '12pt',
 
-    # Additional stuff for the LaTeX preamble.
-    #
-    # 'preamble': '',
+	# Additional stuff for the LaTeX preamble.
+	#
+	# 'preamble': '',
 
-    # Latex figure (float) alignment
-    #
-    # 'figure_align': 'htbp',
+	# Latex figure (float) alignment
+	#
+	# 'figure_align': 'htbp',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'trafficcontrol.tex', 'Apache Traffic Control Documentation',
-     'Apache Traffic Control', 'manual'),
+	(master_doc, 'trafficcontrol.tex', 'Apache Traffic Control Documentation',
+	 'Apache Traffic Control', 'manual'),
 ]
 
 
@@ -151,8 +156,8 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'Apache Traffic Control', 'Apache Traffic Control Documentation',
-     [author], 1)
+	(master_doc, 'Apache Traffic Control', 'Apache Traffic Control Documentation',
+	 [author], 1)
 ]
 
 
@@ -162,7 +167,7 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'trafficcontrol', 'trafficcontrol Documentation',
-     author, 'trafficcontrol', 'Traffic Control is an Open Source implementation of a Content Delivery Network.',
-     'Miscellaneous'),
+	(master_doc, 'trafficcontrol', 'trafficcontrol Documentation',
+	 author, 'trafficcontrol', 'Traffic Control is an Open Source implementation of a Content Delivery Network.',
+	 'Miscellaneous'),
 ]
diff --git a/docs/source/development/index.rst b/docs/source/development/index.rst
@@ -1,17 +1,17 @@
-.. 
-.. 
+..
+..
 .. Licensed under the Apache License, Version 2.0 (the "License");
 .. you may not use this file except in compliance with the License.
 .. You may obtain a copy of the License at
-.. 
+..
 ..     http://www.apache.org/licenses/LICENSE-2.0
-.. 
+..
 .. Unless required by applicable law or agreed to in writing, software
 .. distributed under the License is distributed on an "AS IS" BASIS,
 .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 .. See the License for the specific language governing permissions and
 .. limitations under the License.
-.. 
+..
 
 Developer's Guide
 *****************
@@ -22,6 +22,7 @@ Use this guide to start developing applications that consume the Traffic Control
 
   building
   traffic_ops
+  ort/modules
   traffic_portal
   traffic_router
   traffic_monitor

diff --git a/docs/source/development/ort/modules.rst b/docs/source/development/ort/modules.rst
@@ -0,0 +1,22 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+..     http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+edge
+====
+
+.. toctree::
+   :maxdepth: 4
+
+   traffic_ops_ort
diff --git a/docs/source/development/ort/traffic_ops_ort.rst b/docs/source/development/ort/traffic_ops_ort.rst
@@ -0,0 +1,24 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+..     http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+traffic\_ops\_ort module
+========================
+
+.. autodata:: traffic_ops_ort
+
+.. automodule:: traffic_ops_ort
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt
@@ -14,3 +14,4 @@
 #
 Sphinx>=1.4.3
 sphinx_rtd_theme>=0.4.0
+sphinx_autodoc_typehints>=1.3.0
diff --git a/infrastructure/cdn-in-a-box/.gitignore b/infrastructure/cdn-in-a-box/.gitignore
@@ -1 +1,2 @@
 *.rpm
+traffic_ops/ca
diff --git a/infrastructure/cdn-in-a-box/Makefile b/infrastructure/cdn-in-a-box/Makefile
@@ -0,0 +1,95 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+############################################################
+# Dockerfile to build Edge-Tier Cache container images for
+# Apache Traffic Control
+# Based on CentOS 7.2
+############################################################
+
+# Check for proper invocation
+PWD := $(strip $(lastword $(patsubst %/,%,$(notdir $(shell pwd)))))
+makefile_dir := $(strip $(notdir $(patsubst %/,%,$(dir $(abspath $(lastword $(MAKEFILE_LIST)))))))
+
+ifneq ($(PWD),$(makefile_dir))
+$(error This makefile MUST be run from within its directory)
+endif
+
+BUILD_NUMBER := $(shell git rev-list HEAD 2>/dev/null | wc -l).$(shell git rev-parse --short=8 HEAD)
+TC_VERSION := $(shell cat "../../VERSION")
+TOMCAT_VERSION := $(shell grep 'export TOMCAT_VERSION=' ../../traffic_router/build/build_rpm.sh  | cut -d '=' -f 2)
+TOMCAT_RELEASE := $(shell grep 'export TOMCAT_RELEASE=' ../../traffic_router/build/build_rpm.sh  | cut -d '=' -f 2)
+
+ifeq ($(shell which rpm 2>/dev/null),)
+RHEL_VERSION :=el7
+$(info Couldn't find 'rpm' binary, building for RHEL version $(RHEL_VERSION))
+else
+RHEL_VERSION :=el$(shell rpm -q --qf "%{VERSION}" $(shell rpm -q --whatprovides redhat-release))
+endif
+
+SPECIAL_SAUCE := $(TC_VERSION)-$(BUILD_NUMBER).$(RHEL_VERSION).x86_64.rpm
+SPECIAL_SEASONING := $(TOMCAT_VERSION).$(TOMCAT_RELEASE)-$(BUILD_NUMBER).$(RHEL_VERSION).x86_64.rpm
+
+TO_SOURCE := $(wildcard ../../traffic_ops/**/*)
+ORT_SOURCE:= $(wildcard ../../traffic_ops/bin/*)
+TO_SOURCE += $(wildcard ../../traffic_ops_db/**/*)
+TM_SOURCE := $(wildcard ../../traffic_monitor/**/*)
+TP_SOURCE := $(wildcard ../../traffic_portal/**/*)
+TR_SOURCE := $(wildcard ../../traffic_router/**/*)
+
+.PHONY: clean very-clean all nearly-all
+
+# Default target; builds all pre-requisite rpms from source trees
+all: traffic_monitor/traffic_monitor.rpm traffic_portal/traffic_portal.rpm traffic_ops/traffic_ops.rpm mid/traffic_ops_ort.rpm edge/traffic_ops_ort.rpm traffic_router/traffic_router.rpm traffic_router/tomcat.rpm
+
+# Actual output rpm recipies
+traffic_monitor/traffic_monitor.rpm: ../../dist/traffic_monitor-$(SPECIAL_SAUCE)
+	cp -f $? $@
+traffic_ops/traffic_ops.rpm: ../../dist/traffic_ops-$(SPECIAL_SAUCE)
+	cp -f $? $@
+mid/traffic_ops_ort.rpm edge/traffic_ops_ort.rpm: ../../dist/traffic_ops_ort-$(SPECIAL_SAUCE)
+	cp -f $? $@
+traffic_portal/traffic_portal.rpm: ../../dist/traffic_portal-$(SPECIAL_SAUCE)
+	cp -f $? $@
+traffic_router/traffic_router.rpm: ../../dist/traffic_router-$(SPECIAL_SAUCE)
+	cp -f $? $@
+traffic_router/tomcat.rpm: ../../dist/tomcat-$(SPECIAL_SEASONING)
+	cp -f $? $@
+
+# Dist rpms
+../../dist/traffic_monitor-$(SPECIAL_SAUCE): $(TM_SOURCE)
+	sudo ../../pkg -v traffic_monitor_build
+
+../../dist/traffic_ops-$(SPECIAL_SAUCE): $(TO_SOURCE)
+	sudo ../../pkg -v traffic_ops_build
+
+../../dist/traffic_ops_ort-$(SPECIAL_SAUCE): $(ORT_SOURCE)
+	sudo ../../pkg -v traffic_ops_build
+
+../../dist/traffic_portal-$(SPECIAL_SAUCE): $(TP_SOURCE)
+	sudo ../../pkg -v traffic_portal_build
+
+../../dist/traffic_router-$(SPECIAL_SAUCE): $(TR_SOURCE)
+	sudo ../../pkg -v traffic_router_build
+
+clean:
+	$(RM) traffic_ops/traffic_ops.rpm traffic_monitor/traffic_monitor.rpm traffic_portal/traffic_portal.rpm traffic_router/traffic_router.rpm traffic_router/tomcat.rpm edge/traffic_ops_ort.rpm mid/traffic_ops_ort.rpm
+
+very-clean: clean
+	$(warning This will destroy ALL OUTPUT RPMS IN 'dist'. Please be sure this is what you want)
+	sleep 2 # Give users a sceond to cancel
+	$(RM) ../../dist/*
diff --git a/infrastructure/cdn-in-a-box/README.md b/infrastructure/cdn-in-a-box/README.md
@@ -38,10 +38,12 @@ via the distribution's package manager under the names `docker-ce` and
 `docker-compose`, respectively (e.g. `sudo yum install docker-ce`).
 
 Each container (except the origin) requires an `.rpm` file to install the Traffic Control
-component for which it is responsible. You can either download these `*.rpm` files or
-create them yourself by using the [`pkg`](../../pkg) script at the root of the
-repository. Copy the `*.rpm`s without any version/architecture information to their
-respective component directories, such that their filenames are as follows:
+component for which it is responsible. You can download these `*.rpm` files from an archive
+(e.g. under "Releases"), use the provided [Makefile](./Makefile) to generate them (simply
+type `make` while in the `cdn-in-a-box` directory) or create them yourself by using the
+[`pkg`](../../pkg) script at the root of the repository. If you choose the latter, copy
+the `*.rpm`s without any version/architecture information to their respective component
+directories, such that their filenames are as follows:
 
 * `edge/traffic_ops_ort.rpm`
 * `mid/traffic_ops_ort.rpm`
@@ -137,3 +139,12 @@ a very simple page sporting the Traffic Control logo.
 
 The process creates containers for each component with ports exposed on the host.  The
 following should be available once the system is running:
+
+
+## Common Pitfalls
+
+> Everything's "waiting for Traffic Ops" forever and nothing seems to be working - what do?
+> If you scroll back through the output ( or use `docker compose logs trafficops-perl | grep "User defined signal 2"` ) and see a line that says something like `/run.sh: line 79: 118 User defined signal 2 $TO_DIR/local/bin/hypnotoad script/cdn` then you've hit a mysterious known error. We don't know what this is or why it happens, but your best bet is to send up a quick prayer and restart the stack.
+
+> I'm seeing a failure to open a socket and/or set a socket option
+> Try disabling SELinux or setting it to 'permissive'. SELinux hates letting containers bind to certain ports. You can also try re-labeling the `docker` executable if you feel comfortable.