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

Reorganize flags on --help page #1867

Closed
cdrage opened this issue Apr 25, 2024 · 5 comments
Closed

Reorganize flags on --help page #1867

cdrage opened this issue Apr 25, 2024 · 5 comments
Assignees
Labels
kind/bug Categorizes issue or PR as related to a bug. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed.

Comments

@cdrage
Copy link
Member

cdrage commented Apr 25, 2024

Expected Behavior

 ./kompose convert --help
Convert a Docker Compose file

Usage:
  kompose convert [flags]

Kubernetes Flags:
  -c, --chart                    Create a Helm chart for converted objects
      --controller               Set the output controller ("deployment"|"daemonSet"|"replicationController")
      --service-group-mode       Group multiple service to create single workload by "label"("kompose.service.group") or "volume"(shared volumes)
      --service-group-name       Using with --service-group-mode=volume to specific a final service name for the group

OpenShift Flags:
      --build-branch             Specify repository branch to use for buildconfig (default is current branch name)
      --build-repo               Specify source repository for buildconfig (default is current branch's remote url)
      --insecure-repository      Specify to use insecure docker repository while generating Openshift image stream object

Flags:
      --build string                 Set the type of build ("local"|"build-config"(OpenShift only)|"none") (default "none")
      --build-command string         Set the command used to build the container image. override the docker build command.Should be used in conjuction with --push-command flag.
      --controller string            Set the output controller ("deployment"|"daemonSet"|"replicationController")
      --generate-network-policies    Specify whether to generate network policies or not.
  -h, --help                         help for convert
      --indent int                   Spaces length to indent generated yaml files (default 2)
  -j, --json                         Generate resource files into JSON format
  -n, --namespace string             Specify the namespace of the generated resources
  -o, --out string                   Specify a file name or directory to save objects to (if path does not exist, a file will be created)
      --profile stringArray          Specify the profile to use, can use multiple profiles
      --push-command string          Set the command used to push the container image. override the docker push command. Should be used in conjuction with --build-command flag.
      --push-image                   If we should push the docker image we built
      --push-image-registry string   Specify registry for pushing image, which will override registry from image name.
      --pvc-request-size string      Specify the size of pvc storage requests in the generated resource spec
      --replicas int                 Specify the number of replicas in the generated resource spec (default 1)
      --secrets-as-files             Always convert docker-compose secrets into files instead of symlinked directories.
      --service-group-mode label     Group multiple service to create single workload by label(`kompose.service.group`) or `volume`(shared volumes)
      --service-group-name string    Using with --service-group-mode=volume to specific a final service name for the group
      --stdout                       Print converted objects to stdout
      --volumes string               Volumes to be generated ("persistentVolumeClaim"|"emptyDir"|"hostPath" | "configMap") (default "persistentVolumeClaim")
      --with-kompose-annotation      Add kompose annotations to generated resource (default true)

Global Flags:
      --error-on-warning    Treat any warning as an error
  -f, --file strings        Specify an alternative compose file
      --provider string     Specify a provider. Kubernetes or OpenShift. (default "kubernetes")
      --suppress-warnings   Suppress all warnings
  -v, --verbose             verbose output

The following is displayed twice (once in kubernetes flags, others in normal flags):

      --service-group-mode label     Group multiple service to create single workload by label(`kompose.service.group`) or `volume`(shared volumes)
    --service-group-name string    Using with --service-group-mode=volume to specific a final service name for the group
    ```


### Actual Behavior

Help command flags shown twice.

### Steps To Reproduce

_No response_

### Kompose Version

```Text
latest

Docker-Compose file

No response

Anything else?

No response

@cdrage cdrage added the kind/bug Categorizes issue or PR as related to a bug. label Apr 25, 2024
@cdrage cdrage changed the title Remove the multiple flags Reorganize flags on --help page May 29, 2024
@cdrage
Copy link
Member Author

cdrage commented May 29, 2024

we should reorganize flags into separate more readable sections.

Ex.

  • Cluster
  • OpenShift Only
  • Kubernetes Only
  • Container CLI (where the push commands go for docker CLI)
  • Formatting (json output, --stdout, etc).

@cdrage cdrage self-assigned this May 29, 2024
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue as fresh with /remove-lifecycle stale
  • Close this issue with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Aug 27, 2024
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue as fresh with /remove-lifecycle rotten
  • Close this issue with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Sep 26, 2024
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Reopen this issue with /reopen
  • Mark this issue as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close not-planned

@k8s-ci-robot
Copy link
Contributor

@k8s-triage-robot: Closing this issue, marking it as "Not Planned".

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Reopen this issue with /reopen
  • Mark this issue as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close not-planned

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot closed this as not planned Won't fix, can't repro, duplicate, stale Oct 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed.
Projects
None yet
Development

No branches or pull requests

3 participants