##// END OF EJS Templates
add ssh tunnel notes to parallel process doc
MinRK -
Show More
@@ -484,6 +484,49 b' The ``file`` flag works like this::'
484 (:file:`~/.ipython/profile_<name>/security` is the same on all of them), then things
484 (:file:`~/.ipython/profile_<name>/security` is the same on all of them), then things
485 will just work!
485 will just work!
486
486
487 SSH Tunnels
488 ***********
489
490 If your engines are not on the same LAN as the controller, or you are on a highly
491 restricted network where your nodes cannot see each others ports, then you can
492 use SSH tunnels to connect engines to the controller.
493
494 .. note::
495
496 This does not work in all cases. Manual tunnels may be an option, but are
497 highly inconvenient. Support for manual tunnels will be improved.
498
499 You can instruct all engines to use ssh, by specifying the ssh server in
500 :file:`ipcontroller-engine.json`:
501
502 .. I know this is really JSON, but the example is a subset of Python:
503 .. sourcecode:: python
504
505 {
506 "url":"tcp://192.168.1.123:56951",
507 "exec_key":"26f4c040-587d-4a4e-b58b-030b96399584",
508 "ssh":"user@example.com",
509 "location":"192.168.1.123"
510 }
511
512 This will be specified if you give the ``--enginessh=use@example.com`` argument when
513 starting :command:`ipcontroller`.
514
515 Or you can specify an ssh server on the command-line when starting an engine::
516
517 $> ipengine --profile=foo --ssh=my.login.node
518
519 For example, if your system is totally restricted, then all connections will actually be
520 loopback, and ssh tunnels will be used to connect engines to the controller::
521
522 [node1] $> ipcontroller --enginessh=node1
523 [node2] $> ipengine
524 [node3] $> ipcluster engines --n=4
525
526 Or if you want to start many engines on each node, the command `ipcluster engines --n=4`
527 without any configuration is equivalent to running ipengine 4 times.
528
529
487 Make JSON files persistent
530 Make JSON files persistent
488 --------------------------
531 --------------------------
489
532
General Comments 0
You need to be logged in to leave comments. Login now