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

Updated --help page for kompose up #852

Merged
merged 1 commit into from
Oct 25, 2017

Conversation

surajnarwade
Copy link
Contributor

This PR will add customhelp section in kompose up --help section,
which will show consistency in help section.
Issue reference: #842

for example,

$ kompose up --help
Deploy your Dockerized application to a container orchestrator. (default "kubernetes")

Usage:
  kompose up [flags]

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 "local")
  -h, --help               help for up
      --namespace string   Specify Namespace to deploy your application (default "default")
      --replicas int       Specify the number of replicas generated (default 1)
      --volumes string     Volumes to be generated ("persistentVolumeClaim"|"emptyDir") (default "persistentVolumeClaim")

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

This PR will add customhelp section in `kompose up --help` section,
which will show consistency in help section.
Issue reference: kubernetes#842

for example,

```
$ kompose up --help
Deploy your Dockerized application to a container orchestrator. (default "kubernetes")

Usage:
  kompose up [flags]

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 "local")
  -h, --help               help for up
      --namespace string   Specify Namespace to deploy your application (default "default")
      --replicas int       Specify the number of replicas generated (default 1)
      --volumes string     Volumes to be generated ("persistentVolumeClaim"|"emptyDir") (default "persistentVolumeClaim")

Global Flags:
      --error-on-warning    Treat any warning as an error
  -f, --file stringArray    Specify an alternative compose file
      --provider string     Specify a provider. Kubernetes or OpenShift. (default "kubernetes")
      --suppress-warnings   Suppress all warnings
  -v, --verbose             verbose output
```
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 13, 2017
@surajnarwade
Copy link
Contributor Author

@cdrage review needed

@cdrage
Copy link
Member

cdrage commented Oct 25, 2017

LGTM

@cdrage cdrage merged commit 393b392 into kubernetes:master Oct 25, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants