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..d5e697a0 --- /dev/null +++ b/docs/modules/cockpit/pages/index.adoc @@ -0,0 +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. 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[]