From 9c040873f19cbcb0c1a44666b4f253d478990c5f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Natalie=20Klestrup=20R=C3=B6ijezon?= <nat@nullable.se>
Date: Fri, 4 Aug 2023 15:44:08 +0200
Subject: [PATCH 1/2] Add deployment docs

Fixes #72
---
 docs/antora.yml                              |  3 ++
 docs/modules/cockpit/pages/index.adoc        |  3 ++
 docs/modules/cockpit/pages/installation.adoc | 50 ++++++++++++++++++++
 docs/modules/cockpit/partials/nav.adoc       |  2 +
 4 files changed, 58 insertions(+)
 create mode 100644 docs/antora.yml
 create mode 100644 docs/modules/cockpit/pages/index.adoc
 create mode 100644 docs/modules/cockpit/pages/installation.adoc
 create mode 100644 docs/modules/cockpit/partials/nav.adoc

diff --git a/docs/antora.yml b/docs/antora.yml
new file mode 100644
index 00000000..d522680b
--- /dev/null
+++ b/docs/antora.yml
@@ -0,0 +1,3 @@
+---
+name: home
+version: "nightly"
diff --git a/docs/modules/cockpit/pages/index.adoc b/docs/modules/cockpit/pages/index.adoc
new file mode 100644
index 00000000..065e908a
--- /dev/null
+++ b/docs/modules/cockpit/pages/index.adoc
@@ -0,0 +1,3 @@
+= Stackable Cockpit
+
+This is a visual dashboard to monitor and control Stackable Data Platform clusters.
diff --git a/docs/modules/cockpit/pages/installation.adoc b/docs/modules/cockpit/pages/installation.adoc
new file mode 100644
index 00000000..2d9b2a08
--- /dev/null
+++ b/docs/modules/cockpit/pages/installation.adoc
@@ -0,0 +1,50 @@
+= Installation
+
+The Stackable Cockpit is normally installed using Helm.
+
+== Prerequisites
+
+You will need:
+
+* a Kubernetes cluster
+* kubectl
+* Helm
+* htpasswd (from Apache HTTPD)
+
+Resource sizing depends on cluster type(s), usage and scope, but as a starting point we recommend a minimum of the following resources for this service:
+
+* 0.2 cores (e.g. i5 or similar)
+* 256MB RAM
+
+== Authentication
+
+The Stackable Cockpit authenticates users using a htpasswd database. This file can be
+created and maintained using the `htpasswd` tool:
+
+[source,console]
+----
+$ htpasswd -Bc my-htpasswd first-user
+$ htpasswd -B my-htpasswd second-user
+----
+
+NOTE: Stackable Cockpit _only_ supports bcrypt passwords (controlled by the
+      `-B` flag).
+
+== Installing
+
+First ensure that you have installed the Stackable Operators Helm repository:
+
+[source,console]
+----
+$ helm repo add stackable https://repo.stackable.tech/repository/helm-stable/
+----
+
+Then install the Stackable Cockpit:
+
+[source,console]
+----
+$ helm upgrade listener-operator stackable/stackable-cockpit --install \
+  --set-file htpasswd=my-htpasswd
+----
+
+Helm will deploy the service in Kubernetes containers. You're now ready to access the cockpit!
diff --git a/docs/modules/cockpit/partials/nav.adoc b/docs/modules/cockpit/partials/nav.adoc
new file mode 100644
index 00000000..bbaa1275
--- /dev/null
+++ b/docs/modules/cockpit/partials/nav.adoc
@@ -0,0 +1,2 @@
+* xref:cockpit:index.adoc[]
+* xref:cockpit:installation.adoc[]

From a7821c9cce89f1557846c0a723a27743772e9aab Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Natalie=20Klestrup=20R=C3=B6ijezon?= <nat@nullable.se>
Date: Fri, 4 Aug 2023 15:49:35 +0200
Subject: [PATCH 2/2] Add prerelease note

---
 docs/modules/cockpit/pages/index.adoc | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/docs/modules/cockpit/pages/index.adoc b/docs/modules/cockpit/pages/index.adoc
index 065e908a..d5e697a0 100644
--- a/docs/modules/cockpit/pages/index.adoc
+++ b/docs/modules/cockpit/pages/index.adoc
@@ -1,3 +1,6 @@
 = Stackable Cockpit
 
 This is a visual dashboard to monitor and control Stackable Data Platform clusters.
+
+NOTE: The Stackable Cockpit is currently an early preview, and is not yet a
+      fully supported component of the Stackable Data Platform.