Skip to content

fix(docs): Update getting-started script pre-25.7.0 #962

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.

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
merged 3 commits into from
Jul 14, 2025

Conversation

NickLarsenNZ
Copy link
Member

  • Move listenerClass to under roleConfig.
  • Move to cluster-internal listener class.
  • Update the service name (no longer at the rolegroup level)

Check and Update Getting Started Script

Part of stackabletech/issues#742

Note

During a Stackable release we need to check (and optionally update) the
getting-started scripts to ensure they still work after product and operator
updates.

# Some of the scripts are in a code/ subdirectory
# pushd docs/modules/superset/examples/getting_started
# pushd docs/modules/superset/examples/getting_started/code
pushd $(fd -td getting_started | grep examples); cd code 2>/dev/null || true

# Make a fresh cluster (~12 seconds)
kind delete cluster && kind create cluster
./getting_started.sh stackablectl

# Make a fresh cluster (~12 seconds)
kind delete cluster && kind create cluster
./getting_started.sh helm

popd

@NickLarsenNZ NickLarsenNZ self-assigned this Jul 14, 2025
@NickLarsenNZ NickLarsenNZ moved this to Development: Waiting for Review in Stackable Engineering Jul 14, 2025
@NickLarsenNZ
Copy link
Member Author

NickLarsenNZ commented Jul 14, 2025

testing

stackablectl

❯ kind delete cluster && ctlptl create cluster kind --registry=ctlptl-registry
❯ ./getting_started.sh stackablectl
installing Operators with stackablectl
Installed commons=0.0.0-dev operator
Installed secret=0.0.0-dev operator
Installed listener=0.0.0-dev operator
Installed zookeeper=0.0.0-dev operator

Installed 4 operators

Use "stackablectl operator installed [OPTIONS]" to list installed operators.

Creating ZooKeeper cluster
zookeepercluster.zookeeper.stackable.tech/simple-zk unchanged
Awaiting ZooKeeper rollout finish
partitioned roll out complete: 3 new pods have been updated...
zkCli.sh ls command worked
Applying ZNode
zookeeperznode.zookeeper.stackable.tech/simple-znode created
zkCli.sh ls command worked
ConfigMap retrieved.
ConfigMap contains a reference of the ZNode
Script ran successfully!

helm

❯ kind delete cluster && ctlptl create cluster kind --registry=ctlptl-registry
❯ ./getting_started.sh helm
Installing Operators with Helm
Pulled: oci.stackable.tech/sdp-charts/commons-operator:0.0.0-dev
Digest: sha256:a00b9869e04c5f361b610330e5a759f1826cb4a4ba4c4a406aa71bbf23d1f9a8
NAME: commons-operator
LAST DEPLOYED: Mon Jul 14 11:33:56 2025
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None
Pulled: oci.stackable.tech/sdp-charts/secret-operator:0.0.0-dev
Digest: sha256:f0a7c4b8892682115ca480eab55d5477796c9fe1216a7b1574be1aa6c65742b1
NAME: secret-operator
LAST DEPLOYED: Mon Jul 14 11:34:06 2025
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None
Pulled: oci.stackable.tech/sdp-charts/listener-operator:0.0.0-dev
Digest: sha256:6b32cd84199a1b751b084a1251c1c93bbb2052be3cd02d2bf5ff349c67f9948d
NAME: listener-operator
LAST DEPLOYED: Mon Jul 14 11:34:09 2025
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None
Pulled: oci.stackable.tech/sdp-charts/zookeeper-operator:0.0.0-dev
Digest: sha256:7fc3451a1dc246a142dd826bb5b168f3971f00931f71539bfe04953fafea6bc4
NAME: zookeeper-operator
LAST DEPLOYED: Mon Jul 14 11:34:22 2025
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None
Creating ZooKeeper cluster
zookeepercluster.zookeeper.stackable.tech/simple-zk created
Awaiting ZooKeeper rollout finish
Waiting for 3 pods to be ready...
Waiting for 2 pods to be ready...
Waiting for 1 pods to be ready...
partitioned roll out complete: 3 new pods have been updated...
zkCli.sh ls command worked
Applying ZNode
zookeeperznode.zookeeper.stackable.tech/simple-znode created
zkCli.sh ls command worked
ConfigMap retrieved.
ConfigMap contains a reference of the ZNode
Script ran successfully!

@NickLarsenNZ NickLarsenNZ added this pull request to the merge queue Jul 14, 2025
@Techassi Techassi moved this from Development: Waiting for Review to Development: Done in Stackable Engineering Jul 14, 2025
Merged via the queue into main with commit b411e20 Jul 14, 2025
17 checks passed
@NickLarsenNZ NickLarsenNZ deleted the fix/getting-started-pre-25.7.0 branch July 14, 2025 10:07
@lfrancke lfrancke moved this from Development: Done to Done in Stackable Engineering Jul 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

2 participants