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.

Sign up for GitHub

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

Jump to bottom

kube-apiserver: output flags in logical sections #64517

Merged

k8s-github-robot merged 1 commit into kubernetes:master from sttts:sttts-apiserver-sectioned-flags

Aug 6, 2018

Contributor

sttts commented May 30, 2018 •

edited

Loading

Print kube-apiserver --help flag help in sections.

k8s-ci-robot added do-not-merge/work-in-progress size/M do-not-merge/release-note-label-needed cncf-cla: yes labels

k8s-ci-robot requested review from deads2k and wojtek-t

May 30, 2018 14:23

k8s-ci-robot added the approved label

Contributor Author

sttts commented May 30, 2018

/cc @deads2k @hzxuzhonghu @mtaufen

k8s-ci-robot requested review from hzxuzhonghu and mtaufen

May 30, 2018 14:24

hzxuzhonghu reviewed

View reviewed changes

cmd/kube-apiserver/app/options/options.go Outdated

    
              // AddFlags adds flags for a specific APIServer to the specified FlagSet

              func (s *ServerRunOptions) AddFlags(fs *pflag.FlagSet) {

              // Flags returns flags for a specific APIServer by section name

              func (s *ServerRunOptions) Flags() (fss map[string]*pflag.FlagSet) {

Member

hzxuzhonghu May 31, 2018

redundant fss

Member

hzxuzhonghu commented May 31, 2018

LGTM, it works fine.

The flags help info are well grouped instead of in alphabetical order.

The Kubernetes API server validates and configures data
for the api objects which include pods, services, replicationcontrollers, and
others. The API Server services REST operations and provides the frontend to the
cluster's shared state through which all other components interact.

Usage:
  kube-apiserver [flags]

Generic flags:
      --advertise-address ip                 The IP address on which to advertise the apiserver to members of the cluster. This address must be reachable by the rest of the cluster. If blank, the --bind-address will be used. If --bind-address is unspecified, the host's default interface will be used.
      --cors-allowed-origins strings         List of allowed origins for CORS, comma separated.  An allowed origin can be a regular expression to support subdomain matching. If this list is empty CORS will not be enabled.
      --external-hostname string             The hostname to use when generating externalized URLs for this master (e.g. Swagger API Docs).
      --feature-gates mapStringBool          A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
                APIListChunking=true|false (BETA - default=true)
                APIResponseCompression=true|false (ALPHA - default=false)
                AdvancedAuditing=true|false (BETA - default=true)
                AllAlpha=true|false (ALPHA - default=false)

Contributor Author

sttts commented May 31, 2018

It's a bit ugly that we cannot pass a uniform indention to cobra for all sections. Actually, I like the indention with the newline best:

    --foo-very-long-flag-so-that-not-space-is-left
         This does some thing cool, over many many many many many many many many
         many many many many many many many many lines.

This indention is only chosen implicitly by cobra if there is really not enough space. We would need to contribute something upstream to get this feature under control.

sttts force-pushed the sttts-apiserver-sectioned-flags branch from cc48ea7 to d63901e Compare

June 7, 2018 14:18

k8s-ci-robot added size/L and removed size/M labels

Contributor Author

sttts commented Jun 7, 2018

Fixed the order. Enforcing the "newline mode" now via a fake zzzzzzz flag.

k8s-ci-robot added the needs-rebase label

sttts changed the title ~~[WIP] apiserver: output flags in logical sections~~ kube-apiserver: output flags in logical sections

k8s-ci-robot removed the do-not-merge/work-in-progress label

sttts force-pushed the sttts-apiserver-sectioned-flags branch from d63901e to 4b7016e Compare

August 2, 2018 09:18

k8s-ci-robot added release-note and removed needs-rebase do-not-merge/release-note-label-needed labels

sttts added the kind/feature label

sttts force-pushed the sttts-apiserver-sectioned-flags branch from 4b7016e to 4aeef27 Compare

August 2, 2018 09:29

sttts assigned hzxuzhonghu, stewart-yu and yue9944882

sttts force-pushed the sttts-apiserver-sectioned-flags branch from 4aeef27 to efc48e9 Compare

August 2, 2018 09:34

fejta-bot commented Aug 4, 2018

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel comment for consistent failures.

15 similar comments

fejta-bot commented Aug 4, 2018

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel comment for consistent failures.

fejta-bot commented Aug 4, 2018

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel comment for consistent failures.

fejta-bot commented Aug 4, 2018

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel comment for consistent failures.

fejta-bot commented Aug 4, 2018

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel comment for consistent failures.

fejta-bot commented Aug 5, 2018

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel comment for consistent failures.

fejta-bot commented Aug 5, 2018

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel comment for consistent failures.

fejta-bot commented Aug 5, 2018

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel comment for consistent failures.

fejta-bot commented Aug 5, 2018

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel comment for consistent failures.

fejta-bot commented Aug 5, 2018

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel comment for consistent failures.

fejta-bot commented Aug 5, 2018

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel comment for consistent failures.

fejta-bot commented Aug 5, 2018

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel comment for consistent failures.

fejta-bot commented Aug 5, 2018

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel comment for consistent failures.

fejta-bot commented Aug 6, 2018

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel comment for consistent failures.

fejta-bot commented Aug 6, 2018

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel comment for consistent failures.

fejta-bot commented Aug 6, 2018

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel comment for consistent failures.


          apiserver: output flags in logical sections

42d533e

Contributor

k8s-ci-robot commented Aug 6, 2018

New changes are detected. LGTM label has been removed.

sttts force-pushed the sttts-apiserver-sectioned-flags branch from 45d0b0a to 42d533e Compare

August 6, 2018 06:55

k8s-ci-robot removed the lgtm label

Contributor

k8s-ci-robot commented Aug 6, 2018

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sttts, yue9944882

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~cmd/kube-apiserver/OWNERS~~ [sttts]
~~staging/src/k8s.io/apiextensions-apiserver/Godeps/OWNERS~~ [sttts]
~~staging/src/k8s.io/apiserver/OWNERS~~ [sttts]
~~staging/src/k8s.io/kube-aggregator/Godeps/OWNERS~~ [sttts]
~~staging/src/k8s.io/sample-apiserver/Godeps/OWNERS~~ [sttts]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

sttts added the lgtm label

k8s-github-robot commented Aug 6, 2018

/test all [submit-queue is verifying that this PR is safe to merge]

k8s-github-robot commented Aug 6, 2018

Automatic merge from submit-queue. If you want to cherry-pick this change to another branch, please follow the instructions here.

k8s-github-robot merged commit a160fe9 into kubernetes:master

stewart-yu mentioned this pull request

kube-scheduler: output flags in logical sections #68054

Merged

This was referenced Oct 24, 2018

Fix missing glog flags for some commands which output flags in logical sections #70164

Closed

kube-apiserver: fix missing global flags for --help #70204

Merged

yue9944882 mentioned this pull request

add args to local run kubernetes-sigs/apiserver-builder-alpha#277

Closed

soltysh mentioned this pull request

Add KEP for kubectl debug kubernetes/enhancements#1204

Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

yue9944882 yue9944882 left review comments

hzxuzhonghu hzxuzhonghu left review comments

deads2k Awaiting requested review from deads2k

wojtek-t Awaiting requested review from wojtek-t

mtaufen Awaiting requested review from mtaufen

Labels

approved cncf-cla: yes kind/feature lgtm release-note size/L