Skip to content

Commit

Permalink
docs: add port forwarding info to dev guide
Browse files Browse the repository at this point in the history
Signed-off-by: Leticia Farias Wanderley <leticia.farias.wanderley@cern.ch>
  • Loading branch information
Leticia Farias Wanderley committed Jul 24, 2019
1 parent ef9a8d8 commit 0808fe3
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
1 change: 1 addition & 0 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ The list of contributors in alphabetical order:
- `Dinos Kousidis <https://orcid.org/0000-0002-4914-4289>`_
- `Harri Hirvonsalo <https://orcid.org/0000-0002-5503-510X>`_
- `Jan Okraska <https://orcid.org/0000-0002-1416-3244>`_
- `Leticia Wanderley <https://orcid.org/0000-0003-4649-6630>`_
- `Lukas Heinrich <https://orcid.org/0000-0002-4048-7584>`_
- `Robin Long <https://github.com/longr>`_
- `Michael R. Crusoe <https://orcid.org/0000-0002-2961-9670>`_
Expand Down
15 changes: 15 additions & 0 deletions docs/developerguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,3 +92,18 @@ celery option `--autoreload` doesn't work and it is deprecated. To debug

* Set breakpoint: ``import wdb; wdb.set_trace()``
* Kill the workflow engine container: ``kubectl delete pod cwl-default-worker-2461563162-r4hgg``

Port forwarding
---------------

If you ever need to access one specific microservice via HTTP there is a Kubernetes
command that can help. The ``port-forward`` command connects a local port on the
machine to a port on a Kubernetes pod. It directs the traffic reaching the local
port to the pod port through an HTTP connection. Example:

.. code-block:: console
$ kubectl port-forward --address 0.0.0.0 <pod_name> <local_port>:<pod_port>
The ``--address`` flag defines the local IP address to listen on. Using ``0.0.0.0``
makes the connection listen to all local IP addresses.

0 comments on commit 0808fe3

Please sign in to comment.