From 37dc5ecb57a5f569df22b314272b26372968c84c Mon Sep 17 00:00:00 2001
From: jrybicki-jsc <j.rybicki@fz-juelich.de>
Date: Thu, 24 Mar 2022 10:45:45 +0100
Subject: [PATCH] api requests for image transfer

---
 docs/apirequests.adoc | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/docs/apirequests.adoc b/docs/apirequests.adoc
index 741c9a9..159bd41 100644
--- a/docs/apirequests.adoc
+++ b/docs/apirequests.adoc
@@ -112,6 +112,18 @@ curl -X POST -u USER:PASS -H "Content-Type: application/json" \
 ----
 
 
+=== Image transfer example ===
+To transfer images from eFlows4HPC image build service use dag defined in +dags/image_transfer.py+ (transfer_image). It requires two parameters +image_id+ name of the image in the image
+build service (e.g. "wordcount_skylake.sif") and +target+ which defines a path on the system where the image will be transfered to. 
+
+The parameters should be passed along the credentials as described in <<credentials>>. The target directory will be created with ``mkdir -p`` on the target machine. The image is streamed directly to the target location (no local copy on DLS worker).
+
+----
+curl -X POST -u USER:PASS -H "Content-Type: application/json" \
+   --data '{"conf": {"image_id": imageID, "target": PATH}}' \
+   $DLS/dags/transfer_image/dagRuns
+----
+
 
 === Comments ===
 I could image that a name of DLS pipeline (+taskflow_example+) can change and needs to be passed as parameter to YORC.
-- 
GitLab