Skip to content

Conversation

Zash
Copy link
Contributor

@Zash Zash commented Sep 18, 2025

  • bin: Expand short flags in Harbor init script to improve readability
  • bin: Expand sops flags
  • bin: Expand --all-namespaces since it increases blast radius
  • bin: Expand rm -rf (tho, everyone knows what this means, right?)
  • bin: Expand jq flags

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 expands various short -f flags to --long-flag in order to improve readabilty.

Information to reviewers

There are many more short flags, but some don't have long variants, some don't have in every implementation (e.g. compare POSIX cp, BSD cp, GNU cp)
Especially shell built-ins rarely do (e.g. [ -f ], local, declare etc)

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

@Zash Zash force-pushed the ka/goto/expandflags branch from 4b23a59 to 30311a2 Compare September 25, 2025 08:33
@Zash Zash marked this pull request as ready for review September 25, 2025 08:39
@Zash Zash requested review from a team as code owners September 25, 2025 08:39
- sops flags, since it's security related

- helm --all-namespaces since it increases blast radius

- various others
@Zash Zash force-pushed the ka/goto/expandflags branch from 30311a2 to 2cf34e9 Compare September 26, 2025 11:01
Copy link
Contributor

@rarescosma rarescosma left a comment

Choose a reason for hiding this comment

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

awesome work!

### Bash

- See [Googles style guide](https://google.github.io/styleguide/shellguide.html).
- Prefer long versions of flags to improve readability, i.e. `--long-flag` instead of `-f`|
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- Prefer long versions of flags to improve readability, i.e. `--long-flag` instead of `-f`|
- Prefer long versions of flags to improve readability, i.e. `--long-flag` instead of `-f`

Copy link
Contributor

@viktor-f viktor-f left a comment

Choose a reason for hiding this comment

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

Very nice that you are improving readability of the scripts 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants