Skip to content

Commit f55a49c

Browse files
docs: Add release notes for stackablectl (#402)
* docs: Add release notes for stackablectl * docs: Add 1.1.0 release notes * chore: Add include for 1.1.0 release notes * chore: Fix typos * docs: Add note about independent versioning * chore: Apply suggestion Co-authored-by: Nick <[email protected]> --------- Co-authored-by: Nick <[email protected]>
1 parent 72e88c3 commit f55a49c

File tree

5 files changed

+68
-0
lines changed

5 files changed

+68
-0
lines changed

docs/modules/stackablectl/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
* xref:index.adoc[stackablectl]
22
** xref:installation.adoc[Installation]
33
** xref:quickstart.adoc[Quickstart]
4+
** xref:release-notes.adoc[Release notes]
45
** xref:commands/index.adoc[Commands]
56
*** xref:commands/cache.adoc[cache]
67
*** xref:commands/completions.adoc[completions]
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
= Release notes for stackablectl
2+
:page-toclevels: 3
3+
:description: Learn about the latest features and changes in the release notes for stackablectl.
4+
5+
A full list of changes is available directly in https://github.com/stackabletech/stackable-cockpit/blob/main/rust/stackablectl/CHANGELOG.md[stackablectl's changelog].
6+
7+
// WARNING: Please keep the empty newlines, otherwise headings are broken.
8+
include::partial$release-notes/release-1.1.0.adoc[]
9+
10+
include::partial$release-notes/release-1.0.0.adoc[]
11+
12+
include::partial$release-notes/releases-old.adoc[]
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
== 1.0.0
2+
3+
[NOTE]
4+
====
5+
Previously, `stackablectl` was release alongside each Stackable Data Platform (SDP) release.
6+
However, the patch releases from thereon were not related to SDP.
7+
We have since decided to version `stackablectl` independently of SDP, starting at 1.0.0.
8+
====
9+
10+
* We have added visual progress reporting to more easily see what the tool is doing at any given moment in time.
11+
Previously, it looked like the tool was hanging as nothing was printed out to the terminal during the installation, but only after.
12+
See https://github.com/stackabletech/stackable-cockpit/pull/376[stackable-cockpit#376].
13+
* Releases can now be upgraded with the new `release upgrade` command.
14+
This makes it easier to upgrade installed operators to a newer SDP release.
15+
See https://github.com/stackabletech/stackable-cockpit/pull/379[stackable-cockpit#379].
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
== 1.1.0
2+
3+
* We now support idempotent Helm installations for demos and stacks.
4+
See https://github.com/stackabletech/stackable-cockpit/pull/386[stackable-cockpit#386].
5+
* Ignore failed re-application of Jobs due to immutability in demo and stack installations.
6+
The user is now asked if these be deleted or recreated.
7+
See https://github.com/stackabletech/stackable-cockpit/pull/386[stackable-cockpit#386].
8+
* Default to release build for nix users.
9+
See https://github.com/stackabletech/stackable-cockpit/pull/388[stackable-cockpit#388].
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
== 25.3.0
2+
3+
* A new demo called `jupyterhub-keycloak` was added and is available via `stackablectl`.
4+
The JupyterHub-Keycloak integration demo offers a comprehensive and secure multi-user data science environment on Kubernetes, integrating Single Sign-on Jupyter notebooks with Stackable Spark and S3 storage.
5+
The demo can be installed by running `stackablectl demo install jupyterhub-keycloak`.
6+
See https://github.com/stackabletech/demos/pull/155[demos#155] and https://github.com/stackabletech/documentation/pull/715[documentation#715].
7+
* Demos and stacks are now versioned and the main branch is considered unstable.
8+
`stackablectl` by default installs the latest stable demo and/or stack.
9+
A specific release can be targeted by providing the `--release` argument.
10+
See https://github.com/stackabletech/stackable-cockpit/pull/340[stackable-cockpit#340].
11+
* Add new argument --chart-source so that operator charts can be pulled either from an OCI registry (the default) or from a index.yaml-based repository.
12+
See https://github.com/stackabletech/stackable-cockpit/pull/344[stackable-cockpit#344].
13+
* Use `rustls-native-certs` so that `stackablectl` can be used in environments with internal PKI.
14+
See https://github.com/stackabletech/stackable-cockpit/pull/351[stackable-cockpit#351].
15+
* Use `heritage` label when looking up the `minio-console` stacklet.
16+
See https://github.com/stackabletech/stackable-cockpit/pull/364[stackable-cockpit#364].
17+
* Improve tracing and log output.
18+
See https://github.com/stackabletech/stackable-cockpit/pull/365[stackable-cockpit#365].
19+
20+
== 24.11.0
21+
22+
* Bump Rust dependencies to fix critical vulnerability in quinn-proto.
23+
See https://github.com/advisories/GHSA-vr26-jcq5-fjj8[CVE-2024-45311] and https://github.com/stackabletech/stackable-cockpit/pull/318[stackable-cockpit#318].
24+
* We now provide additional completions for Nushell and Elvish, support using SOCK5 and HTTP proxies, and have improved the sorting of release versions.
25+
26+
== 24.7.0
27+
28+
* a new experimental debug command
29+
* a pre-built binary for aarch64-unknown-linux-gnu is now available
30+
* complete error messages are now shown (remedying the truncation of some details in previous releases)
31+
* use of the latest Go and Rust versions and respective dependencies

0 commit comments

Comments
 (0)