diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..68919d8 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,14 @@ +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "mambaforge-4.10" + +sphinx: + builder: html + configuration: docs/conf.py + fail_on_warning: true + +conda: + environment: environment.yml diff --git a/docs/developer/index.rst b/docs/developer/index.rst index 4c22c3b..7c9f2cb 100644 --- a/docs/developer/index.rst +++ b/docs/developer/index.rst @@ -6,3 +6,4 @@ Development Guide config_for_local_use service_through_apache + troubleshoot/index diff --git a/docs/developer/media/forward_rule_443.GIF b/docs/developer/media/forward_rule_443.GIF new file mode 100644 index 0000000..8680b9f Binary files /dev/null and b/docs/developer/media/forward_rule_443.GIF differ diff --git a/docs/developer/troubleshoot/index.rst b/docs/developer/troubleshoot/index.rst new file mode 100644 index 0000000..0838ec4 --- /dev/null +++ b/docs/developer/troubleshoot/index.rst @@ -0,0 +1,12 @@ +.. _troubleshoot: + +============ +Troubleshoot +============ + +These pages contain various scenarions where the app fails. + +.. toctree:: + :maxdepth: 1 + + unresponsive diff --git a/docs/developer/troubleshoot/unresponsive.rst b/docs/developer/troubleshoot/unresponsive.rst new file mode 100644 index 0000000..ba88cc9 --- /dev/null +++ b/docs/developer/troubleshoot/unresponsive.rst @@ -0,0 +1,44 @@ +.. _unresponsive: + +Unresponsive Testing Server +--------------------------- + +Issue ++++++ +Pointing the web browser to http://testfixture02-test.ornl.gov/admin causes the page to **hang**, the adming page +never shows up. + +**Diagnostics: faulty TLS (ssl) certs** + +login to testfixture02-test.ornl.gov and examine the `nginx` logs + +.. code-block:: bash + + $> ssh cloud@testfixture02-test.ornl.gov + $> docker logs test-nginx-1 + SSL_CTX_use_PrivateKey("/etc/pki/wildcard.sns.gov.key") failed (SSL: error:0B080074:x509 certificate routines:X509_check_private_key:key values mismatch) + nginx: [emerg] SSL_CTX_use_PrivateKey("/etc/pki/wildcard.sns.gov.key") failed (SSL: error:0B080074:x509 certificate routines:X509_check_private_key:key values mismatch) + +The logs indicate a problem with the certificate files. + +An additional test is to substitute the +`nginx.conf file for the testing environment `_ +with the +`local environment one `_, +which does not contain SSL certificates. Don't forget to change +`the server name `_ +from `"localhost"` to `"testfixture02-test.ornl.gov"`. +Redeploy after this. If the http://testfixture02-test.ornl.gov/admin (notice the `http` instead of `https`) app is +served now, then it's a problem of the secure connection. + + +**Diagnostics: upstream firewall policy** + +If the prod or test servers are hosted on ORNL cloud, ensure that unsolicited incoming requests on ports 80 and 443 are allowed in the upstream firewall. +Navigate to https://orc-open.ornl.gov and select the security group rules for the hosted instance. +Check to see that Ingress ports 80(HTTP) and 443(HTTPS) are allowed for 0.0.0.0/0 all IPv4 hosts. The following screenshot depicts the desired configuration. + +.. image:: /developer/media/forward_rule_443.GIF + :width: 800px + :align: center + :alt: forward rule in CADES management