cassandra: add doc

juspay · Mar 3, 2024 · 5b0a688 · 5b0a688
1 parent 3373bb0
commit 5b0a688
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/doc/cassandra.md b/doc/cassandra.md
@@ -0,0 +1,31 @@
+# Cassandra
+
+[Cassandra] is a free and open-source, distributed, wide-column store, NoSQL database management system designed to handle large amounts of data across many commodity servers, providing high availability with no single point of failure.
+
+[Cassandra]: https://cassandra.apache.org/_/index.html
+
+## Getting Started
+
+```nix
+# In `perSystem.process-compose.<name>`
+{
+  services.cassandra."cass1".enable = true;
+}
+```
+
+{#tips}
+## Tips & Tricks
+
+{#change-port}
+### Change the default port
+
+By default, the Cassandra server is started on port `9042`. To change the port, we can use the following config:
+
+```nix
+{
+  services.cassandra."cass1" = {
+    enable = true;
+    nativeTransportPort = 9043;
+  };
+}
+```
diff --git a/doc/services.md b/doc/services.md
@@ -19,6 +19,7 @@ short-title: Services
 - [x] [[grafana]]#
 - [X] [[prometheus]]#
 - [X] [[pgadmin]]#
+- [X] [[cassandra]]#
 - [ ] ...
 
 [gh]: https://github.com/juspay/services-flake