Page MenuHomeSoftware Heritage
Files F9344373

docker.rst
No OneTemporary
Actions

docker.rst
View Options

Docker environment
==================
Build
-----
.. code:: bash
$ git clone https://forge.softwareheritage.org/source/swh-graph.git
$ cd swh-graph
$ docker build --tag swh-graph docker/
``docker/build.sh`` also exists as an alias for the last line.
Run
---
Given a graph ``g`` specified by:
- ``g.edges.csv.zst``: zstd-compressed CSV file with one edge per line, as a
"SRC_ID SPACE DST_ID" string, where identifiers are the :ref:`SWHIDs
<persistent-identifiers>` of each node.
- ``g.nodes.csv.zst``: sorted list of unique node identifiers appearing in the
corresponding ``g.edges.csv.zst`` file. The format is a zst-compressed CSV
file (single column) with one persistent identifier per line.
.. code:: bash
$ docker run -ti \
--volume /PATH/TO/GRAPH/:/srv/softwareheritage/graph/data \
--publish 127.0.0.1:5009:5009 \
swh-graph:latest \
bash
or, as a shortcut:
.. code:: bash
$ docker/run.sh /PATH/TO/GRAPH/
Where ``/PATH/TO/GRAPH`` is a directory containing the ``g.edges.csv.zst`` and
``g.nodes.csv.zst`` files. By default, when entering the container the current
working directory will be ``/srv/softwareheritage/graph``; all relative paths
found below are intended to be relative to that dir.
Graph compression
~~~~~~~~~~~~~~~~~
To compress the graph (from within the docker container):
.. code:: bash
$ docker/run.sh /PATH/TO/GRAPH/
root@7f3306806861:/srv/softwareheritage/graph# \
swh graph compress --graph data/g --outdir data/compressed
Graph server
~~~~~~~~~~~~
To start the swh-graph server (from within the docker container):
.. code:: bash
$ docker/run.sh /PATH/TO/GRAPH/
root@7f3306806861:/srv/softwareheritage/graph# \
swh graph rpc-serve --graph data/compressed/g

File Metadata

Mime Type
text/plain
Expires
Fri, Jul 4, 2:22 PM (2 d, 10 h ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
3237892

Event Timeline

About · Developer information · Legal