search

kubernetes / kompose

Convert Compose to Kubernetes
http://kompose.io
Apache License 2.0
9.65k stars 764 forks source link

Reorganize flags on --help page #1867

Closed cdrage closed 1 month ago

cdrage commented 7 months ago

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

latest

Docker-Compose file

No response

Anything else?

No response

cdrage commented 6 months ago

we should reorganize flags into separate more readable sections.

Ex.

k8s-triage-robot commented 3 months ago

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

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

You can:

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

/lifecycle stale

k8s-triage-robot commented 2 months ago

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:

You can:

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

/lifecycle rotten

k8s-triage-robot commented 1 month ago

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:

You can:

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

/close not-planned

k8s-ci-robot commented 1 month ago

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

In response to [this](https://github.com/kubernetes/kompose/issues/1867#issuecomment-2439617694): >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][1] > >Please send feedback to sig-contributor-experience at [kubernetes/community](https://github.com/kubernetes/community). > >/close not-planned > >[1]: https://www.kubernetes.dev/docs/guide/issue-triage/ Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.