Skip to content

added welkin quickstart script#2918

Open
shafi-elastisys wants to merge 8 commits intomainfrom
welkin-quickstart
Open

added welkin quickstart script#2918
shafi-elastisys wants to merge 8 commits intomainfrom
welkin-quickstart

Conversation

@shafi-elastisys
Copy link
Copy Markdown
Contributor

Warning

This is a public repository, ensure not to disclose:

  • personal data beyond what is necessary for interacting with this pull request, nor
  • business confidential information, such as customer names.

What kind of PR is this?

Required: Mark one of the following that is applicable:

  • kind/feature
  • kind/improvement
  • kind/deprecation
  • kind/documentation
  • kind/clean-up
  • kind/bug
  • kind/other

Optional: Mark one or more of the following that are applicable:

Important

Breaking changes should be marked kind/admin-change or kind/dev-change depending on type
Critical security fixes should be marked with kind/security

  • kind/admin-change
  • kind/dev-change
  • kind/security
  • [kind/adr](set-me)

What does this PR do / why do we need this PR?

This PR introduces bin/quick-start, a script that fully automates the setup of a local Welkin environment which handles kind cluster creation, configuration, and app installation. It also updates the README.md with a simplified "Quickstart" section.
...

Information to reviewers

Checklist

  • Proper commit message prefix on all commits
  • Change checks:
    • The change is transparent
    • The change is disruptive
    • The change requires no migration steps
    • The change requires migration steps
    • The change updates CRDs
    • The change updates the config and the schema
  • Documentation checks:
  • Metrics checks:
    • The metrics are still exposed and present in Grafana after the change
    • The metrics names didn't change (Grafana dashboards and Prometheus alerts required no updates)
    • The metrics names did change (Grafana dashboards and Prometheus alerts required an update)
  • Logs checks:
    • The logs do not show any errors after the change
  • PodSecurityPolicy checks:
    • Any changed Pod is covered by Kubernetes Pod Security Standards
    • Any changed Pod is covered by Gatekeeper Pod Security Policies
    • The change does not cause any Pods to be blocked by Pod Security Standards or Policies
  • NetworkPolicy checks:
    • Any changed Pod is covered by Network Policies
    • The change does not cause any dropped packets in the NetworkPolicy Dashboard
  • Audit checks:
    • The change does not cause any unnecessary Kubernetes audit events
    • The change requires changes to Kubernetes audit policy
  • Falco checks:
    • The change does not cause any alerts to be generated by Falco
  • Bug checks:
    • The bug fix is covered by regression tests

@shafi-elastisys shafi-elastisys requested review from a team as code owners January 7, 2026 13:10
Copy link
Copy Markdown
Contributor

@Zash Zash left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really nice work!

Comment thread bin/quick-start Outdated
Comment thread bin/quick-start Outdated
Comment thread bin/quick-start
@shafi-elastisys shafi-elastisys added the kind/improvement Improvement of existing features, e.g. code cleanup or optimizations. label Jan 8, 2026
Copy link
Copy Markdown
Contributor

@cristiklein cristiklein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a really good and promising start, but I believe we need a few more iterations before it's ready to fly. 😄

My script stopped with [ck8s] CK8S_PGP_FP is unset. See more detailed comments line-by-line.

Comment thread bin/quick-start Outdated
Comment thread bin/quick-start
Comment thread bin/quick-start
Comment thread README.md
Copy link
Copy Markdown
Contributor

@cristiklein cristiklein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are converging, but I still found rough edges. Please see line-by-line comments.

Comment thread README.md
Comment thread bin/quick-start
Comment thread bin/quick-start
Comment thread bin/quick-start Outdated
Comment thread bin/quick-start Outdated
Comment thread bin/quick-start
Comment thread bin/quick-start
Comment thread bin/quick-start
Comment thread bin/quick-start
@Zash
Copy link
Copy Markdown
Contributor

Zash commented Jan 13, 2026

[ck8s] ⚠️  Setup finished, but some status checks failed.
[ck8s] ---------------------------------------------------
[ck8s] Please check the logs above.
[ck8s] You can retry the status check with:
[ck8s]   ./bin/ck8s quickstart status
$ ck8s quickstart status
bin/common.bash: line 7: CK8S_CONFIG_PATH: Missing CK8S_CONFIG_PATH
  • Which checks failed? (The .issuers.letsencrypt ones probably, otherwise something lost in the helm output)
  • What should I set $CK8S_CONFIG_PATH to? Would be nice to print that even in this case

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/improvement Improvement of existing features, e.g. code cleanup or optimizations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[5] Rewrite and script quick start

4 participants