From c669e1b68966d519b2bb5f34608d95711d6ad78e Mon Sep 17 00:00:00 2001
From: Tigran Mkrtchyan <tigran.mkrtchyan@desy.de>
Date: Tue, 23 Nov 2021 17:31:23 +0100
Subject: [PATCH] cta-dcache: add README.md to decribe the module

---
 cta-dcache/README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 cta-dcache/README.md

diff --git a/cta-dcache/README.md b/cta-dcache/README.md
new file mode 100644
index 0000000000..2a8a0f5d2a
--- /dev/null
+++ b/cta-dcache/README.md
@@ -0,0 +1,21 @@
+# dCache CTA integration
+
+gRPC based frontend for integration with dCache 7.2.2 and later. This is thin layer
+that only populates CTA catalog and scheduler queue. THe connection between a CTA and
+a dCache instance maintained by hsm URI, for example:
+
+```
+osm://cta/00001D43C0C086CA459298C634D67F68AB6B?archiveid=8402
+```
+
+where _00001D43C0C086CA459298C634D67F68AB6B_ corresponds to the dCache unique file id
+(so called pnfs id) and _8402_ corresponds to the archive id within CTA catalog.
+
+> NOTE: the original file name, owner and owner group are not propagated by dCache to CTA.
+
+## Configuration
+
+As mentioned above, the _cta-dcache_ interface requires only connection to the CTA catalog
+and the scheduler. Those configurations are taken from `/etc/cta/cta-catalogue.conf` and
+`/etc/cta/cta.conf`. The TPC port number used to accept dCache requests is specified in
+`/etc/sysconfig/cta-dcache` and defaults to `17017`.
\ No newline at end of file
-- 
GitLab