You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficcontrol.apache.org by GitBox <gi...@apache.org> on 2020/11/21 01:50:04 UTC

[GitHub] [trafficcontrol] shamrickus opened a new pull request #5322: TP: Use developer conf for dev build

shamrickus opened a new pull request #5322:
URL: https://github.com/apache/trafficcontrol/pull/5322


   <!--
   ************ STOP!! ************
   If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact
   the Apache Software Foundation Security Team at security@trafficcontrol.apache.org and follow the
   guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
   -->
   ## What does this PR (Pull Request) do?
   <!-- Explain the changes you made here. If this fixes an Issue, identify it by
   replacing the text in the checkbox item with the Issue number e.g.
   
   - [x] This PR fixes #9001 OR is not related to any Issue
   
   ^ This will automatically close Issue number 9001 when the Pull Request is
   merged (The '#' is important).
   
   Be sure you check the box properly, see the "The following criteria are ALL
   met by this PR" section for details.
   -->
   
   - [x] This PR is not related to any Issue.
   
   `process.env.NODE_ENV` is the canonical way of checking for which environment the server is running. By default, this is nothing and in that case there should be no effect. Running the grunt dev task sets this to `dev`
   
   This change accomplishes two things:
   1) Only the certs need to be generated to run the dev environment (everything else is the default per CiaB).
   2) Previously, changing config to allow for local development breaks the CiaB TP as the paths are incorrect. Now it will be unaffected.
   
   
   ## Which Traffic Control components are affected by this PR?
   <!-- Please delete all components from this list that are NOT affected by this
   Pull Request. Also, feel free to add the name of a tool or script that is
   affected but not on the list.
   
   Additionally, if this Pull Request does NOT affect documentation, please
   explain why documentation is not required. -->
   
   - Traffic Portal
   
   ## What is the best way to verify this PR?
   Build default task, confirm it loads configDev instead of config
   Build for prod, confirm it loads config as normal
   Run CiaB, ensure TP works.
   Run TP Integration tests.
   <!-- Please include here ALL the steps necessary to test your Pull Request. If
   it includes tests (and most should), outline here the steps needed to run the
   tests. If not, lay out the manual testing procedure and please explain why
   tests are unnecessary for this Pull Request. -->
   
   <!-- If this PR fixes a bug, please list here all of the affected versions - to
   the best of your knowledge. It's also pretty helpful to include a commit hash
   of where 'master' is at the time this PR is opened (if it affects master),
   because what 'master' means will change over time. For example, if this PR
   fixes a bug that's present in master (at commit hash '1df853c8'), in v4.0.0,
   and in the current 4.0.1 Release candidate (e.g. RC1), then this list would
   look like:
   
   - master (1df853c8)
   - 4.0.0
   - 4.0.1 (RC1)
   
   If you don't know what other versions might have this bug, AND don't know how
   to find the commit hash of 'master', then feel free to leave this section
   blank (or, preferably, delete it entirely).
    -->
   
   
   ## The following criteria are ALL met by this PR
   <!-- Check the boxes to signify that the associated statement is true. To
   "check a box", replace the space inside of the square brackets with an 'x'.
   e.g.
   
   - [ x] <- Wrong
   - [x ] <- Wrong
   - [] <- Wrong
   - [*] <- Wrong
   - [x] <- Correct!
   
   -->
   
   - [x] This PR includes tests OR I have explained why tests are unnecessary
   - [x] This PR includes documentation OR I have explained why documentation is unnecessary
   - [x] This PR includes an update to CHANGELOG.md OR such an update is not necessary
   - [x] This PR includes any and all required license headers
   - [x] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY** (see [the Apache Software Foundation's security guidelines](https://www.apache.org/security/) for details)
   
   
   
   <!-- If you would like to include any additional information on the PR for
   potential reviewers please put it here.
   
   Some examples of this would be:
   
   - Before and after screenshots/gifs of the Traffic Portal if it is affected
   - Links to other dependent Pull Requests
   - References to relevant context (e.g. new/updates to dependent libraries,
   mailing list records, blueprints)
   
   Feel free to leave this section blank (or, preferably, delete it entirely).
   -->
   
   <!--
   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.
   -->
   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [trafficcontrol] shamrickus commented on a change in pull request #5322: TP: Use developer conf for dev build

Posted by GitBox <gi...@apache.org>.
shamrickus commented on a change in pull request #5322:
URL: https://github.com/apache/trafficcontrol/pull/5322#discussion_r550275768



##########
File path: traffic_portal/conf/configDev.js
##########
@@ -0,0 +1,46 @@
+/*
+ * 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.
+ */
+
+// this is the config that is consumed by /server.js on traffic portal startup (sudo service traffic_portal start)
+module.exports = {
+    timeout: '120s',
+    useSSL: true, // set to true if you plan to use https (self-signed or trusted certs).
+    port: 80, // set to http port
+    sslPort: 443, // set to https port
+    // if useSSL is true, generate ssl certs and provide the proper locations.
+    ssl: {
+        key:    '../localhost.key',
+        cert:   '../localhost.cert',

Review comment:
       I think I've seen it as both, I'll change it to `crt` to be more inline with what we have elsewhere.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [trafficcontrol] mitchell852 commented on a change in pull request #5322: TP: Use developer conf for dev build

Posted by GitBox <gi...@apache.org>.
mitchell852 commented on a change in pull request #5322:
URL: https://github.com/apache/trafficcontrol/pull/5322#discussion_r550305854



##########
File path: docs/source/development/traffic_portal.rst
##########
@@ -104,13 +104,13 @@ Installing The Traffic Portal Developer Environment
 #. Make sure that compass is installed and functioning correctly by running ``compass version``. If compass is not available, then it can be installed following the instructions under :ref:`dev-tp-compass`.
 
 #. Run ``grunt`` to package the application into ``traffic_portal/app/dist``, start a local HTTPS server (Express), and start a file watcher.

Review comment:
       otherwise, all looks good.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [trafficcontrol] mitchell852 merged pull request #5322: TP: Use developer conf for dev build

Posted by GitBox <gi...@apache.org>.
mitchell852 merged pull request #5322:
URL: https://github.com/apache/trafficcontrol/pull/5322


   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [trafficcontrol] mitchell852 commented on a change in pull request #5322: TP: Use developer conf for dev build

Posted by GitBox <gi...@apache.org>.
mitchell852 commented on a change in pull request #5322:
URL: https://github.com/apache/trafficcontrol/pull/5322#discussion_r550339364



##########
File path: docs/source/development/traffic_portal.rst
##########
@@ -103,14 +103,13 @@ Installing The Traffic Portal Developer Environment
 #. Run ``bower install`` to install client-side dependencies into ``traffic_portal/app/bower_components``. Only needs to be done the first time unless ``traffic_portal/bower.json`` changes.
 #. Make sure that compass is installed and functioning correctly by running ``compass version``. If compass is not available, then it can be installed following the instructions under :ref:`dev-tp-compass`.
 
-#. Run ``grunt`` to package the application into ``traffic_portal/app/dist``, start a local HTTPS server (Express), and start a file watcher.
 #. Modify ``traffic_portal/conf/configDev.js``:
-
 	#. Valid SSL certificates and keys are needed for Traffic Portal to run. Generate these (e.g. using `this SuperUser answer <https://superuser.com/questions/226192/avoid-password-prompt-for-keys-and-prompts-for-dn-information#answer-226229>`_) and update ``ssl``.
 	#. Modify ``api.base_url`` to point to your Traffic Ops API endpoint.
 	#. Modify ``files.static`` to be ``./app/dist/public``.
 	#. Modify ``log.stream`` to be ``./server/log/access.log``. If you have created a ``traffic_portal/log`` directory with ``access.log`` file, use that location.
     #. Ensure ca_bundle.crt is present at ``/etc/pki/tls/certs``. If not present, use the cmd: ``sudo touch ca_bundle.crt``

Review comment:
       can this line be deleted? looks like `ca_bundle.crt` is not needed.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [trafficcontrol] mitchell852 commented on a change in pull request #5322: TP: Use developer conf for dev build

Posted by GitBox <gi...@apache.org>.
mitchell852 commented on a change in pull request #5322:
URL: https://github.com/apache/trafficcontrol/pull/5322#discussion_r550305629



##########
File path: docs/source/development/traffic_portal.rst
##########
@@ -104,13 +104,13 @@ Installing The Traffic Portal Developer Environment
 #. Make sure that compass is installed and functioning correctly by running ``compass version``. If compass is not available, then it can be installed following the instructions under :ref:`dev-tp-compass`.
 
 #. Run ``grunt`` to package the application into ``traffic_portal/app/dist``, start a local HTTPS server (Express), and start a file watcher.

Review comment:
       can you take a look at these steps. they don't seem quite right. 
   
   ![image](https://user-images.githubusercontent.com/251272/103377114-b3b06400-4a9b-11eb-9a2f-5a549774237b.png)
   
   i.e. 6 should be after 7 and the subbullets are screwed up




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [trafficcontrol] mitchell852 commented on a change in pull request #5322: TP: Use developer conf for dev build

Posted by GitBox <gi...@apache.org>.
mitchell852 commented on a change in pull request #5322:
URL: https://github.com/apache/trafficcontrol/pull/5322#discussion_r550268113



##########
File path: traffic_portal/conf/configDev.js
##########
@@ -0,0 +1,46 @@
+/*
+ * 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.
+ */
+
+// this is the config that is consumed by /server.js on traffic portal startup (sudo service traffic_portal start)
+module.exports = {
+    timeout: '120s',
+    useSSL: true, // set to true if you plan to use https (self-signed or trusted certs).
+    port: 80, // set to http port
+    sslPort: 443, // set to https port
+    // if useSSL is true, generate ssl certs and provide the proper locations.
+    ssl: {
+        key:    '../localhost.key',

Review comment:
       this requires it outside the TP directory. do you think it should be `./localhost.key` instead to keep it contained to TP?

##########
File path: traffic_portal/conf/configDev.js
##########
@@ -0,0 +1,46 @@
+/*
+ * 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.
+ */
+
+// this is the config that is consumed by /server.js on traffic portal startup (sudo service traffic_portal start)
+module.exports = {
+    timeout: '120s',
+    useSSL: true, // set to true if you plan to use https (self-signed or trusted certs).
+    port: 80, // set to http port
+    sslPort: 443, // set to https port
+    // if useSSL is true, generate ssl certs and provide the proper locations.
+    ssl: {
+        key:    '../localhost.key',
+        cert:   '../localhost.cert',

Review comment:
       is it typically named `localhost.cert` or `localhost.crt`. I ask because i have no idea although i guess it doesn't really matter.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [trafficcontrol] shamrickus commented on a change in pull request #5322: TP: Use developer conf for dev build

Posted by GitBox <gi...@apache.org>.
shamrickus commented on a change in pull request #5322:
URL: https://github.com/apache/trafficcontrol/pull/5322#discussion_r550275304



##########
File path: traffic_portal/conf/configDev.js
##########
@@ -0,0 +1,46 @@
+/*
+ * 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.
+ */
+
+// this is the config that is consumed by /server.js on traffic portal startup (sudo service traffic_portal start)
+module.exports = {
+    timeout: '120s',
+    useSSL: true, // set to true if you plan to use https (self-signed or trusted certs).
+    port: 80, // set to http port
+    sslPort: 443, // set to https port
+    // if useSSL is true, generate ssl certs and provide the proper locations.
+    ssl: {
+        key:    '../localhost.key',

Review comment:
       Yes, I reuse that key in other parts of the CDN so that's where I have it but having it in the TP dir makes more sense.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org