diff --git a/.github/workflows/pr_cockpit.yml b/.github/workflows/pr_cockpit.yml index 1248c07b..599b4226 100644 --- a/.github/workflows/pr_cockpit.yml +++ b/.github/workflows/pr_cockpit.yml @@ -7,7 +7,6 @@ on: - ".github/workflows/pr_cockpit.yml" - "rust/stackable-cockpitd/**" - "rust/stackable-cockpit/**" - - "docs/modules/cockpit/**" - "docs/modules/ROOT/**" - "Cargo.lock" - "deploy/**" diff --git a/docs/antora.yml b/docs/antora.yml index 45968107..3578e46a 100644 --- a/docs/antora.yml +++ b/docs/antora.yml @@ -3,5 +3,4 @@ name: management title: SDP Management version: "nightly" nav: - - modules/cockpit/nav.adoc - modules/stackablectl/nav.adoc diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index 6dd74e8c..6c54f67f 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -1,4 +1,3 @@ = Management Tools for the Stackable Data Platform -* xref:cockpit:index.adoc[] * xref:stackablectl:index.adoc[] diff --git a/docs/modules/cockpit/images/login-view.png b/docs/modules/cockpit/images/login-view.png deleted file mode 100644 index c9cc996c..00000000 Binary files a/docs/modules/cockpit/images/login-view.png and /dev/null differ diff --git a/docs/modules/cockpit/images/stacklets-view.png b/docs/modules/cockpit/images/stacklets-view.png deleted file mode 100644 index 9c76e034..00000000 Binary files a/docs/modules/cockpit/images/stacklets-view.png and /dev/null differ diff --git a/docs/modules/cockpit/nav.adoc b/docs/modules/cockpit/nav.adoc deleted file mode 100644 index fd44482e..00000000 --- a/docs/modules/cockpit/nav.adoc +++ /dev/null @@ -1,2 +0,0 @@ -* xref:index.adoc[Cockpit] -** xref:installation.adoc[Installation] diff --git a/docs/modules/cockpit/pages/index.adoc b/docs/modules/cockpit/pages/index.adoc deleted file mode 100644 index 41139372..00000000 --- a/docs/modules/cockpit/pages/index.adoc +++ /dev/null @@ -1,16 +0,0 @@ -= Stackable Cockpit - -IMPORTANT: The Stackable Cockpit is currently an early preview, and is not yet a fully supported component of the -Stackable Data Platform. - -The `Cockpit` application is a browser-based management tool which interacts with the Stackable data platform. Currently -it can display deployed stacklets and their status. The display can be compared with the -xref:management:stackablectl:commands/stacklet.adoc#list-stacklets[`stackablectl stacklet list`] command output. - -The installation is described in the xref:installation.adoc[installation guide]. - -.Stackable Cockpit login page -image::login-view.png[Image of the Stackable Cockpit login page] - -.Stackable Cockpit Stacklet list page -image::stacklets-view.png[Image of the Stackable Cockpit Stacklet list page] diff --git a/docs/modules/cockpit/pages/installation.adoc b/docs/modules/cockpit/pages/installation.adoc deleted file mode 100644 index 09d2115a..00000000 --- a/docs/modules/cockpit/pages/installation.adoc +++ /dev/null @@ -1,51 +0,0 @@ -= 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-dev https://repo.stackable.tech/repository/helm-dev/ ----- - -Then install the Stackable Cockpit: - -[source,console] ----- -$ helm upgrade stackable-cockpit stackable-dev/stackable-cockpit --install \ - --version 0.0.0-dev --set-file htpasswd=my-htpasswd ----- - -Helm will deploy the service in Kubernetes containers. You're now ready to access the cockpit!