Skip to content
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

Description for kctrl dev command in help section should also include package installs #964

Closed
praveenrewar opened this issue Oct 31, 2022 · 1 comment · Fixed by #1000
Closed
Labels
bug This issue describes a defect or unexpected behavior carvel-accepted This issue should be considered for future work and that the triage process has been completed cli Issue for kapp-controller cli good first issue An issue that will be a good candidate for a new contributor priority/unprioritized-backlog Higher priority than priority/awaiting-more-evidence but not planned. Contributions are welcome. snack This issue has been identified as lightweight and potentially quick to deliver.

Comments

@praveenrewar
Copy link
Member

What steps did you take:
kctrl dev -h

What happened:

Deploy App CRs and packaging CRs

Usage:
  kctrl dev [flags]

Flags:
      --delete             Delete deployed app
  -f, --file strings       Set App CR file (required)
  -h, --help               help for dev
  -b, --kbld-build         Allow kbld build
  -l, --local              Use local fetch source
  -n, --namespace string   Specified namespace ($KCTRL_NAMESPACE or default from kubeconfig)
      --tty                Force TTY-like output

Global Flags:
      --color                       Set color output (default true)
      --column strings              Filter to show only given columns
      --debug                       Include debug output
      --json                        Output as JSON
      --kube-api-burst int          Set Kubernetes API client burst limit (default 1000)
      --kube-api-qps float32        Set Kubernetes API client QPS limit (default 1000)
      --kubeconfig string           Path to the kubeconfig file ($KCTRL_KUBECONFIG)
      --kubeconfig-context string   Kubeconfig context override ($KCTRL_KUBECONFIG_CONTEXT)
      --kubeconfig-yaml string      Kubeconfig contents as YAML ($KCTRL_KUBECONFIG_YAML)
  -y, --yes                         Assume yes for any prompt

Succeeded

What did you expect:
The description for the dev command should Deploy App CRs, Package CR and PackageInstall CRs.
Description for the -f flag should just be Set file name

Anything else you would like to add:
[Additional information that will assist in solving the issue.]

Environment:

  • kapp Controller version (execute kubectl get deployment -n kapp-controller kapp-controller -o yaml and the annotation is kbld.k14s.io/images):
  • Kubernetes version (use kubectl version)

Vote on this request

This is an invitation to the community to vote on issues, to help us prioritize our backlog. Use the "smiley face" up to the right of this comment to vote.

👍 "I would like to see this addressed as soon as possible"
👎 "There are other more important things to focus on right now"

We are also happy to receive and review Pull Requests if you want to help working on this issue.

@praveenrewar praveenrewar added bug This issue describes a defect or unexpected behavior good first issue An issue that will be a good candidate for a new contributor carvel-accepted This issue should be considered for future work and that the triage process has been completed cli Issue for kapp-controller cli snack This issue has been identified as lightweight and potentially quick to deliver. labels Oct 31, 2022
@ThomasVitale
Copy link
Contributor

I have submitted a PR to handle this issue: #1000

100mik pushed a commit that referenced this issue Dec 2, 2022
* Update the description for the kctrl dev command.
* Update the description for the -f flag.

Fixes gh-964
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue describes a defect or unexpected behavior carvel-accepted This issue should be considered for future work and that the triage process has been completed cli Issue for kapp-controller cli good first issue An issue that will be a good candidate for a new contributor priority/unprioritized-backlog Higher priority than priority/awaiting-more-evidence but not planned. Contributions are welcome. snack This issue has been identified as lightweight and potentially quick to deliver.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants