Skip to content

Commit 37ca0d3

Browse files
authored
Add deployment docs (#82)
* Add deployment docs Fixes #72 * Add prerelease note
1 parent 1d7aee1 commit 37ca0d3

File tree

4 files changed

+61
-0
lines changed

4 files changed

+61
-0
lines changed

docs/antora.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
name: home
3+
version: "nightly"

docs/modules/cockpit/pages/index.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
= Stackable Cockpit
2+
3+
This is a visual dashboard to monitor and control Stackable Data Platform clusters.
4+
5+
NOTE: The Stackable Cockpit is currently an early preview, and is not yet a
6+
fully supported component of the Stackable Data Platform.
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
= Installation
2+
3+
The Stackable Cockpit is normally installed using Helm.
4+
5+
== Prerequisites
6+
7+
You will need:
8+
9+
* a Kubernetes cluster
10+
* kubectl
11+
* Helm
12+
* htpasswd (from Apache HTTPD)
13+
14+
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:
15+
16+
* 0.2 cores (e.g. i5 or similar)
17+
* 256MB RAM
18+
19+
== Authentication
20+
21+
The Stackable Cockpit authenticates users using a htpasswd database. This file can be
22+
created and maintained using the `htpasswd` tool:
23+
24+
[source,console]
25+
----
26+
$ htpasswd -Bc my-htpasswd first-user
27+
$ htpasswd -B my-htpasswd second-user
28+
----
29+
30+
NOTE: Stackable Cockpit _only_ supports bcrypt passwords (controlled by the
31+
`-B` flag).
32+
33+
== Installing
34+
35+
First ensure that you have installed the Stackable Operators Helm repository:
36+
37+
[source,console]
38+
----
39+
$ helm repo add stackable https://repo.stackable.tech/repository/helm-stable/
40+
----
41+
42+
Then install the Stackable Cockpit:
43+
44+
[source,console]
45+
----
46+
$ helm upgrade listener-operator stackable/stackable-cockpit --install \
47+
--set-file htpasswd=my-htpasswd
48+
----
49+
50+
Helm will deploy the service in Kubernetes containers. You're now ready to access the cockpit!
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
* xref:cockpit:index.adoc[]
2+
* xref:cockpit:installation.adoc[]

0 commit comments

Comments
 (0)