summaryrefslogtreecommitdiffstats
path: root/examples/rgw/golang/topic-creation/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/rgw/golang/topic-creation/README.md')
-rw-r--r--examples/rgw/golang/topic-creation/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/examples/rgw/golang/topic-creation/README.md b/examples/rgw/golang/topic-creation/README.md
new file mode 100644
index 000000000..3033a86c5
--- /dev/null
+++ b/examples/rgw/golang/topic-creation/README.md
@@ -0,0 +1,11 @@
+# Introduction
+This directory contains Golang code example on how to create an SNS Topic on a Ceph RGW cluster.
+
+# Prerequisite
+Linux machine running an RGW Ceph cluster. Preferrably started with the ``OSD=1 MON=1 MDS=0 MGR=0 RGW=1 ../src/vstart.sh --debug --new `` command.
+Go installed on the Linux machine.
+
+## Workflow Procedure
+1. Navigate through your file system to where the Golang example code exists on your terminal.
+2. Run ``` go mod tidy ``` to install the required Golang packages on the system.
+3. Run the Golang program as ``` go run topic-creation.go -t sample-topic-1 -a '{"push-endpoint": "http://127.0.0.1:10900"}' ``` on the terminal window to create SNS topic with custom attributes.