Skip to content

Add deployment docs #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nightkr merged 2 commits into from
Aug 7, 2023
Merged

Add deployment docs #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9c04087
Add deployment docs
nightkr Aug 4, 2023
a7821c9
Add prerelease note
nightkr Aug 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/antora.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
name: home
version: "nightly"
6 changes: 6 additions & 0 deletions docs/modules/cockpit/pages/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
50 changes: 50 additions & 0 deletions docs/modules/cockpit/pages/installation.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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!
2 changes: 2 additions & 0 deletions docs/modules/cockpit/partials/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
* xref:cockpit:index.adoc[]
* xref:cockpit:installation.adoc[]