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

Remove 'be formatted' from VolumeSource docs #21884

Merged
merged 1 commit into from Feb 26, 2016
Merged

Remove 'be formatted' from VolumeSource docs #21884

merged 1 commit into from Feb 26, 2016

Conversation

ghost
Copy link

@ghost ghost commented Feb 24, 2016

Volumes do not need to be formatted as we now have the
SafeFormatAndMount utility which formats volumes when needed.

@k8s-github-robot
Copy link

Labelling this PR as size/M

@k8s-github-robot k8s-github-robot added kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 24, 2016
@ghost
Copy link
Author

ghost commented Feb 24, 2016

@bgrant0607 PTAL

@k8s-bot
Copy link

k8s-bot commented Feb 24, 2016

GCE e2e test build/test passed for commit 6b4dc00f6152354e917cf1d6f469b25188c3207b.

// GCE PDs support ownership management and SELinux relabeling.
// A GCE PD must exist before mounting to a container. The disk must
// also be in the same GCE project and zone as the kubelet. A GCE PD
// can only be mounted as read/write once. GCE PDs support ownership
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can only be mounted as read/write once

While, we're cleaning up the comments, this doesn't seem right. GCE PDs can be mounted as read-only as well right? Ditto for AWS below?

@saad-ali saad-ali changed the title Remove 'be formatted' from VolumeSrouce docs Remove 'be formatted' from VolumeSource docs Feb 25, 2016
@ghost
Copy link
Author

ghost commented Feb 25, 2016

@saad-ali updated GCE comment. I think AWS EBS is correct

@k8s-bot
Copy link

k8s-bot commented Feb 25, 2016

GCE e2e test build/test passed for commit cb21e286c36ad7f5690fc81cfa39df52c3240329.

Volumes do not need to be formatted as we now have the
SafeFormatAndMount utility which formats volumes when needed.
@k8s-bot
Copy link

k8s-bot commented Feb 25, 2016

GCE e2e build/test failed for commit d7c6eb9.

Please reference the list of currently known flakes when examining this failure. If you request a re-test, you must reference the issue describing the flake.

@saad-ali
Copy link
Member

LGTM thanks @swagiaal

@saad-ali saad-ali added lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-merge labels Feb 25, 2016
fabioy added a commit that referenced this pull request Feb 26, 2016
Remove 'be formatted' from VolumeSource docs
@fabioy fabioy merged commit fedca86 into kubernetes:master Feb 26, 2016
@ixdy
Copy link
Member

ixdy commented Feb 26, 2016

@fabioy this was failing verification checks and should not have been merged. kubernetes-test-go is now broken as a result.

@fabioy
Copy link
Contributor

fabioy commented Feb 26, 2016

Yeah, I missed it (my bad). I've since updated docs on another PR.

@ghost
Copy link
Author

ghost commented Feb 26, 2016

Hmm.. sorry about that guys!
Which verification test was failing ?
I can only see

[Fail] Deployment [It] RollingUpdateDeployment should delete old pods and create new ones

@fabioy
Copy link
Contributor

fabioy commented Feb 26, 2016

Yeah, it's not in the "Build Log" link above, but the Jenkins output. But, if you build locally, it'll show an error in the generated doc:

Moving api reference docs from /workspace/kubernetes/_output/generated_html to /workspace/kubernetes/tmp/api-reference
diffing /workspace/kubernetes/docs/api-reference against freshly generated docs
diff -NauprB -I 'Last update' '--exclude=
.md' /workspace/kubernetes/docs/api-reference/extensions/v1beta1/definitions.html /workspace/kubernetes/_tmp/api-reference/extensions/v1beta1/definitions.html
--- /workspace/kubernetes/docs/api-reference/extensions/v1beta1/definitions.html 2016-02-26 13:34:34.047480330 -0800
+++ /workspace/kubernetes/_tmp/api-reference/extensions/v1beta1/definitions.html 2016-02-26 13:38:35.811611144 -0800
@@ -1437,7 +1437,7 @@ Examples:

Represents a Persistent Disk resource in Google Compute Engine.

-

A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once. GCE PDs support ownership management and SELinux relabeling.

+

A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.

diff -NauprB -I 'Last update' '--exclude=_.md' /workspace/kubernetes/docs/api-reference/v1/definitions.html /workspace/kubernetes/_tmp/api-reference/v1/definitions.html --- /workspace/kubernetes/docs/api-reference/v1/definitions.html 2016-02-26 13:34:34.047480330 -0800 +++ /workspace/kubernetes/_tmp/api-reference/v1/definitions.html 2016-02-26 13:38:28.151607127 -0800 @@ -982,7 +982,7 @@ Examples:

Represents a Persistent Disk resource in Google Compute Engine.

-

A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once. GCE PDs support ownership management and SELinux relabeling.

+

A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.

/workspace/kubernetes/docs/api-reference is out of date. Please run hack/update-api-reference-docs.sh FAILED

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API lgtm "Looks good to me", indicates that a PR is ready to be merged. 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.

8 participants