Skip to content

Commit 62800fd

Browse files
Techassisbernauer
Techassi
and
sbernauer
authored
docs: Update and improve stackablectl documentation (#101)
* Initial commit * Add demos partial * Split up xtask commands * Add doc auto gen xtask * Adjust module nav * Adjust operator cmd output, fix typo * Update operator doc page * Continue release doc page * Revert to `rustls-tls` * Continue stackablectl demos doc migration * Copy earthquake demo docs * Copy logging demo page * Copy waterlavel demo docs * Move demo images to sub folder * Add anomaly detection demo docs * Copy trino iceberg demo docs * Copy trino taxi data demo docs * Update docs auto generation * Add stackablectl base command docs * Update image paths * Add customization docs * Add quickstart * Add minor adjustments * Style adjustment for start page * Add quickstart and installation page to nav * Adjust style for demo command page * Adjust style for operator command page * Adjust style for release command page * Adjust style for airflow-scheduled-job page * Update introduction for operator command * Start styling adjustments for demo data-lakehouse * Continue adjustments on data-lakehouse demo * Finish data-lakehouse demo adjustments * Add instance hint partial * Adjust hbase-cycling-data demo * Adjust jupyterhub demo * Adjust logging demo * Start adjustments for nifi earthquake demo * Adjust spark anomaly detection docs * Adjust add demo customization docs * Adjust add stack customization docs * Adjust add release customization docs * Finish nifi earthquake demo adjustments * Start nifi water level demo adjustments * Finish nifi water level adjustments * Start trino iceberg adjustments * Finish trino iceber demo adjustments * Adjust trino taxi data demo docs * Add installation docs * Adjust quick start guide * fix: nav * docs: Remove demo docs, as they are moved to https://github.com/stackabletech/demos * callout * docs * Add minor formatting * Update broken xrefs * Fix xrefs, remove unused section * Update xrefs on stackablectl start page * Update demo links * Update fish completion instructions * Add page aliases --------- Co-authored-by: Sebastian Bernauer <sebastian.bernauer@stackable.de>
1 parent 6b74581 commit 62800fd

37 files changed

+1899
-117
lines changed

‎Cargo.lock

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Cargo.toml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,12 @@ k8s-openapi = { version = "0.19", default-features = false, features = ["v1_27"]
2929
kube = { version = "0.85", default-features = false, features = ["client", "rustls-tls"] }
3030
lazy_static = "1.4"
3131
nu-ansi-term = "0.49"
32+
once_cell = "1.18"
3233
phf = "0.11"
3334
phf_codegen = "0.11"
3435
rand = "0.8"
35-
reqwest = { version = "0.11.16", default-features = false, features = ["rustls-tls"] }
36+
regex = "1.9"
37+
reqwest = { version = "0.11", default-features = false, features = ["rustls-tls"] }
3638
semver = "1.0"
3739
serde = { version = "1.0", features = ["derive"] }
3840
serde_json = "1.0"

‎docs/antora.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
---
2-
name: home
2+
name: management
3+
title: SDP Management
34
version: "nightly"
5+
nav:
6+
- modules/cockpit/nav.adoc
7+
- modules/stackablectl/nav.adoc

‎docs/modules/ROOT/pages/index.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
= Management Tools for the Stackable Data Platform
2+
3+
* xref:cockpit:index.adoc[]
4+
* xref:stackablectl:index.adoc[]

‎docs/modules/cockpit/nav.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
* xref:index.adoc[Cockpit]
2+
** xref:installation.adoc[Installation]

‎docs/modules/cockpit/pages/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22

33
This is a visual dashboard to monitor and control Stackable Data Platform clusters.
44

5-
NOTE: The Stackable Cockpit is currently an early preview, and is not yet a
5+
IMPORTANT: The Stackable Cockpit is currently an early preview, and is not yet a
66
fully supported component of the Stackable Data Platform.

‎docs/modules/cockpit/pages/installation.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ You will need:
1111
* Helm
1212
* htpasswd (from Apache HTTPD)
1313

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:
14+
Resource sizing depends on cluster type(s), usage and scope, but as a starting point we recommend a minimum of the
15+
following resources for this service:
1516

1617
* 0.2 cores (e.g. i5 or similar)
1718
* 256MB RAM

‎docs/modules/cockpit/partials/nav.adoc

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/modules/stackablectl/images/layers.png

26.6 KB
Loading

‎docs/modules/stackablectl/nav.adoc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
* xref:index.adoc[stackablectl]
2+
** xref:installation.adoc[Installation]
3+
** xref:quickstart.adoc[Quickstart]
4+
** xref:commands/index.adoc[Commands]
5+
*** xref:commands/cache.adoc[cache]
6+
*** xref:commands/completions.adoc[completions]
7+
*** xref:commands/demo.adoc[demo]
8+
*** xref:commands/operator.adoc[operator]
9+
*** xref:commands/release.adoc[release]
10+
*** xref:commands/stack.adoc[stack]
11+
*** xref:commands/stacklets.adoc[stacklets]
12+
** xref:customization/index.adoc[]
13+
*** xref:customization/add-demo.adoc[]
14+
*** xref:customization/add-stack.adoc[]
15+
*** xref:customization/add-release.adoc[]
16+
// *** xref:customization/working-with-feature-branches.adoc[]

‎docs/modules/stackablectl/pages/commands/cache.adoc

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
= stackablectl cache
2+
3+
// Autogenerated by cargo xtask gen-docs. DO NOT CHANGE MANUALLY!
4+
[source,console]
5+
----
6+
$ stackablectl cache
7+
Interact with locally cached files
8+
9+
Usage: cache [OPTIONS] <COMMAND>
10+
11+
Commands:
12+
list List cached files
13+
clean Clean cached files
14+
help Print this message or the help of the given subcommand(s)
15+
16+
Options:
17+
-l, --log-level <LOG_LEVEL>
18+
Log level this application uses
19+
20+
--no-cache
21+
Do not cache the remote (default) demo, stack and release files
22+
23+
Cached files are saved at '$XDG_CACHE_HOME/stackablectl', which is usually
24+
'$HOME/.cache/stackablectl' when not explicitly set.
25+
26+
--offline
27+
Do not request any remote files via the network
28+
29+
-h, --help
30+
Print help (see a summary with '-h')
31+
32+
-V, --version
33+
Print version
34+
35+
File options:
36+
-d, --demo-file <DEMO_FILE>
37+
Provide one or more additional (custom) demo file(s)
38+
39+
Demos are loaded in the following order: Remote (default) demo file, custom
40+
demo files provided via the 'STACKABLE_DEMO_FILES' environment variable, and
41+
lastly demo files provided via the '-d/--demo-file' argument(s). If there are
42+
demos with the same name, the last demo definition will be used.
43+
44+
Use "stackablectl [OPTIONS] <COMMAND> -d path/to/demos1.yaml -d path/to/demos2.yaml"
45+
to provide multiple additional demo files.
46+
47+
-s, --stack-file <STACK_FILE>
48+
Provide one or more additional (custom) stack file(s)
49+
50+
Stacks are loaded in the following order: Remote (default) stack file, custom
51+
stack files provided via the 'STACKABLE_STACK_FILES' environment variable, and
52+
lastly demo files provided via the '-s/--stack-file' argument(s). If there are
53+
stacks with the same name, the last stack definition will be used.
54+
55+
Use "stackablectl [OPTIONS] <COMMAND> -s path/to/stacks1.yaml -s path/to/stacks2.yaml"
56+
to provide multiple additional stack files.
57+
58+
-r, --release-file <RELEASE_FILE>
59+
Provide one or more additional (custom) release file(s)
60+
61+
Releases are loaded in the following order: Remote (default) release file,
62+
custom release files provided via the 'STACKABLE_RELEASE_FILES' environment
63+
variable, and lastly release files provided via the '-r/--release-file'
64+
argument(s). If there are releases with the same name, the last release
65+
definition will be used.
66+
67+
Use "stackablectl [OPTIONS] <COMMAND> -r path/to/releases1.yaml -r path/to/releases2.yaml"
68+
to provide multiple additional release files.
69+
70+
Helm repository options:
71+
--helm-repo-stable <URL>
72+
Provide a custom Helm stable repository URL
73+
74+
[default: https://repo.stackable.tech/repository/helm-stable/]
75+
76+
--helm-repo-test <URL>
77+
Provide a custom Helm test repository URL
78+
79+
[default: https://repo.stackable.tech/repository/helm-test/]
80+
81+
--helm-repo-dev <URL>
82+
Provide a custom Helm dev repository URL
83+
84+
[default: https://repo.stackable.tech/repository/helm-dev/]
85+
----

‎docs/modules/stackablectl/pages/commands/completions.adoc

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
= stackablectl completions
2+
3+
// Autogenerated by cargo xtask gen-docs. DO NOT CHANGE MANUALLY!
4+
[source,console]
5+
----
6+
$ stackablectl completions
7+
Generate shell completions for this tool
8+
9+
Usage: completions [OPTIONS] <COMMAND>
10+
11+
Commands:
12+
bash Generate shell completions for Bash
13+
fish Generate shell completions for Fish
14+
zsh Generate shell completions for ZSH
15+
help Print this message or the help of the given subcommand(s)
16+
17+
Options:
18+
-l, --log-level <LOG_LEVEL>
19+
Log level this application uses
20+
21+
--no-cache
22+
Do not cache the remote (default) demo, stack and release files
23+
24+
Cached files are saved at '$XDG_CACHE_HOME/stackablectl', which is usually
25+
'$HOME/.cache/stackablectl' when not explicitly set.
26+
27+
--offline
28+
Do not request any remote files via the network
29+
30+
-h, --help
31+
Print help (see a summary with '-h')
32+
33+
-V, --version
34+
Print version
35+
36+
File options:
37+
-d, --demo-file <DEMO_FILE>
38+
Provide one or more additional (custom) demo file(s)
39+
40+
Demos are loaded in the following order: Remote (default) demo file, custom
41+
demo files provided via the 'STACKABLE_DEMO_FILES' environment variable, and
42+
lastly demo files provided via the '-d/--demo-file' argument(s). If there are
43+
demos with the same name, the last demo definition will be used.
44+
45+
Use "stackablectl [OPTIONS] <COMMAND> -d path/to/demos1.yaml -d path/to/demos2.yaml"
46+
to provide multiple additional demo files.
47+
48+
-s, --stack-file <STACK_FILE>
49+
Provide one or more additional (custom) stack file(s)
50+
51+
Stacks are loaded in the following order: Remote (default) stack file, custom
52+
stack files provided via the 'STACKABLE_STACK_FILES' environment variable, and
53+
lastly demo files provided via the '-s/--stack-file' argument(s). If there are
54+
stacks with the same name, the last stack definition will be used.
55+
56+
Use "stackablectl [OPTIONS] <COMMAND> -s path/to/stacks1.yaml -s path/to/stacks2.yaml"
57+
to provide multiple additional stack files.
58+
59+
-r, --release-file <RELEASE_FILE>
60+
Provide one or more additional (custom) release file(s)
61+
62+
Releases are loaded in the following order: Remote (default) release file,
63+
custom release files provided via the 'STACKABLE_RELEASE_FILES' environment
64+
variable, and lastly release files provided via the '-r/--release-file'
65+
argument(s). If there are releases with the same name, the last release
66+
definition will be used.
67+
68+
Use "stackablectl [OPTIONS] <COMMAND> -r path/to/releases1.yaml -r path/to/releases2.yaml"
69+
to provide multiple additional release files.
70+
71+
Helm repository options:
72+
--helm-repo-stable <URL>
73+
Provide a custom Helm stable repository URL
74+
75+
[default: https://repo.stackable.tech/repository/helm-stable/]
76+
77+
--helm-repo-test <URL>
78+
Provide a custom Helm test repository URL
79+
80+
[default: https://repo.stackable.tech/repository/helm-test/]
81+
82+
--helm-repo-dev <URL>
83+
Provide a custom Helm dev repository URL
84+
85+
[default: https://repo.stackable.tech/repository/helm-dev/]
86+
----

0 commit comments

Comments
 (0)