summaryrefslogtreecommitdiff
path: root/doc/troubleshooting
diff options
context:
space:
mode:
authorMicah <micah@leap.se>2016-05-10 11:17:58 -0400
committerMicah <micah@leap.se>2016-05-10 11:17:58 -0400
commit372ddc290a0e06ac23398a82860620df68fa801d (patch)
tree179be4c6289e67dc5f3f36cd28ab22b7c6c7c078 /doc/troubleshooting
parente71c10af73be758e407ee352a3a7b12347177dce (diff)
update /doc directory with latest from leap docs/platform
Change-Id: I696af649806a7321f92baaf55dc5d404ce5c3d93
Diffstat (limited to 'doc/troubleshooting')
-rw-r--r--doc/troubleshooting/tests.md12
-rw-r--r--doc/troubleshooting/vagrant.md45
-rw-r--r--doc/troubleshooting/where-to-look.md28
3 files changed, 29 insertions, 56 deletions
diff --git a/doc/troubleshooting/tests.md b/doc/troubleshooting/tests.md
index b85c19d2..607f924e 100644
--- a/doc/troubleshooting/tests.md
+++ b/doc/troubleshooting/tests.md
@@ -8,15 +8,15 @@ At any time, you can run troubleshooting tests on the nodes of your provider inf
To run tests on FILTER node list:
- leap test run FILTER
+ workstation$ leap test run FILTER
For example, you can also test a single node (`leap test elephant`); test a specific environment (`leap test development`), or any tag (`leap test soledad`).
Alternately, you can run test on all nodes (probably only useful if you have pinned the environment):
- leap test
+ workstation$ leap test
-The tests that are performed are located in the platform under the tests directory.
+The tests that are performed are located in the platform under the tests directory.
## Testing with the bitmask client
@@ -50,16 +50,16 @@ In order to set up a monitoring node, you simply add a `monitor` service tag to
After deploying, this node will regularly poll every node to ask for the status of various health checks. These health checks include the checks run with `leap test`, plus many others.
-We use [Nagios](http://www.nagios.org/) together with [Check MK agent](https://en.wikipedia.org/wiki/Check_MK) for running checks on remote hosts.
+We use [Nagios](https://www.nagios.org/) together with [Check MK agent](https://en.wikipedia.org/wiki/Check_MK) for running checks on remote hosts.
One nagios installation will monitor all nodes in all your environments. You can log into the monitoring web interface via [https://DOMAIN/nagios3/](https://DOMAIN/nagios3/). The username is `nagiosadmin` and the password is found in the secrets.json file in your provider directory.
Nagios will send out mails to the `contacts` address provided in `provider.json`.
-## Nagios Frontents
+## Nagios Frontends
There are other ways to check and get notified by Nagios besides regularly checking the Nagios webinterface or reading email notifications. Check out the [Frontends (GUIs and CLIs)](http://exchange.nagios.org/directory/Addons/Frontends-%28GUIs-and-CLIs%29) on the Nagios project website.
-A recommended status tray application is [Nagstamon](https://nagstamon.ifw-dresden.de/), which is available for Linux, MacOS X and Windows. It can not only notify you of hosts/services failures, you can also acknoledge or recheck these with it.
+A recommended status tray application is [Nagstamon](https://nagstamon.ifw-dresden.de/), which is available for Linux, MacOS X and Windows. It can not only notify you of hosts/services failures, you can also acknowledge or recheck them.
### Log Monitoring
diff --git a/doc/troubleshooting/vagrant.md b/doc/troubleshooting/vagrant.md
deleted file mode 100644
index ad284161..00000000
--- a/doc/troubleshooting/vagrant.md
+++ /dev/null
@@ -1,45 +0,0 @@
-@title = 'LEAP Platform Vagrant testing'
-@nav_title = 'Vagrant Integration'
-@summary = 'Testing your provider with Vagrant'
-
-Setting up Vagrant for a testing the platform
-=============================================
-
-There are two ways you can setup leap platform using vagrant.
-
-Using the Vagrantfile provided by Leap Platform
------------------------------------------------
-
-This is by far the easiest way. It will install a single node mail server in the default
-configuration with one single command.
-
-Clone the platform with
-
- git clone https://github.com/leapcode/leap_platform.git
-
-Start the vagrant box with
-
- cd leap_platform
- vagrant up
-
-Follow the instructions how to configure your `/etc/hosts`
-in order to use the provider!
-
-You can login via ssh with the systemuser `vagrant` and the same password.
-
-There are 2 users preconfigured:
-
-. `testuser` with pw `hallo123`
-. `testadmin` with pw `hallo123`
-
-
-Use the leap_cli vagrant integration
-------------------------------------
-
-Install leap_cli and leap_platform on your host, configure a provider from scratch and use the `leap local` commands to manage your vagrant node(s).
-
-See https://leap.se/en/docs/platform/development how to use the leap_cli vagrant
-integration and https://leap.se/en/docs/platform/tutorials/single-node-email how
-to setup a single node mail server.
-
-
diff --git a/doc/troubleshooting/where-to-look.md b/doc/troubleshooting/where-to-look.md
index fbd95931..c92fba8f 100644
--- a/doc/troubleshooting/where-to-look.md
+++ b/doc/troubleshooting/where-to-look.md
@@ -7,6 +7,16 @@ General
=======
* Please increase verbosity when debugging / filing issues in our issue tracker. You can do this with adding i.e. `-v 5` after the `leap` cmd, i.e. `leap -v 2 deploy`.
+* We use the `example.org` domain for documentation purposes here, please replace it with the you domain.
+
+Firewall
+=======================
+
+Every node in your provider has its own restrictive firewall, but you might have a network firewall in place as well that is not managed by LEAP platform. To see what ports and addresses must be open, run this command:
+
+ workstation$ leap compile firewall
+
+If any of those are blocked, then your provider will not work.
Webapp
======
@@ -19,10 +29,10 @@ Places to look for errors
* `/var/log/syslog` (watch out for stunnel issues)
* `/var/log/leap/*`
+
Is haproxy ok ?
---------------
-
curl -s -X GET "http://127.0.0.1:4096"
Is couchdb accessible through stunnel ?
@@ -59,13 +69,21 @@ Check couchdb acl as unpriviledged user
curl -s --netrc-file /etc/couchdb/couchdb-webapp.netrc -X GET "http://127.0.0.1:4096/_all_dbs"
+All URLs accessible ?
+---------------------
+
+* https://example.org
+* https://api.example.org:4430/provider.json
+* https://example.org/ca.crt
+
+
Check client config files
-------------------------
- https://example.net/provider.json
- https://example.net/1/config/smtp-service.json
- https://example.net/1/config/soledad-service.json
- https://example.net/1/config/eip-service.json
+* https://example.net/provider.json
+* https://example.net/1/config/smtp-service.json
+* https://example.net/1/config/soledad-service.json
+* https://example.net/1/config/eip-service.json
Soledad