Stackable Cockpit

Stackable Data Platform | Platform Docs | Discussions | Discord

This repository contains the Stackable library stackable-cockpit, the Stackable CLI tool stackablectl, and the Stackable Cockpit server stackable-cockpitd.

Components

• stackable-cockpit: The underlying library for all actions related to the Stackable Data Platform
• stackablectl: CLI tool to interact with local and remote deployments of the data platform
• stackable-cockpitd: API server used by frontends to interact with the data platform

Developer Setup

Prerequisites

• A working (and up2date) Rust installation including rustc, clippy, and cargo
• Optional, but strongly advised: a working pre-commit installation

Getting started

git clone git@github.com:stackabletech/stackable-cockpit.git
cd stackable-cockpit

Each component can be build separately like this:

cargo build --release -p stackablectl       # Builds stackablectl
cargo build --release -p stackable-cockpitd # Builds the Stackable Cockpit API server

Pre-commit hooks and xtasks

This repository uses multiple pre-commit hooks to run checks, formatting and code-generation on different files. The hooks are:

• trailing-whitespace: Trims trailing whitespace in all files
• end-of-file-fixer: Files need to end with newlines
• detect-aws-credentials: Detect AWS secrets
• detect-private-key: Detect private keys
• yamllint: Runs linting on all YAML files
• markdownlint: Runs linting on all Markdown files
• cargo clippy --all-targets --all-features -- -D warnings: Runs Clippy on all files and errors on warnings
• cargo fmt -- --check: Checks if Rust code needs formatting
• cargo xtask gen-comp: Runs shell completions generation for stackablectl
• cargo xtask gen-man: Runs man page generation for stackablectl
• cargo xtask gen-ctl-readme: Generates and inserts stackablectl help text into README

Templating variables

Variable	Availability	Content
NAMESPACE	Always	The namespace where the stack and demo (not the operators!) are deployed into
STACK	Always (both in stack and demo manifests)	The name of the stack
DEMO	In demos manifests: Always In stack manifests: Only when deployed as part of a demo!	The name of the demo