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.

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

Update docs #149

Merged
merged 2 commits into from
Dec 16, 2018
Merged

Update docs #149

merged 2 commits into from
Dec 16, 2018

Conversation

d-nishi
Copy link
Contributor

@d-nishi d-nishi commented Dec 15, 2018

Is this a bug fix or adding new feature?
Update README

What is this PR about? / Why do we need it?
Update README for better usability of the driver

What testing is done?
Tested using the driver with KOPS and k8s v1.12

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: d-nishi

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:

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

@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Dec 15, 2018
@k8s-ci-robot
Copy link
Contributor

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

  • If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
  • If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
  • If you have done the above and are still having issues with the CLA being reported as unsigned, please email the CNCF helpdesk: [email protected]

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/test-infra repository. I understand the commands that are listed here.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Dec 15, 2018
@d-nishi
Copy link
Contributor Author

d-nishi commented Dec 15, 2018

/assign @leakingtapan

@coveralls
Copy link

coveralls commented Dec 15, 2018 •
edited
Loading

Pull Request Test Coverage Report for Build 240

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 50.352%
Totals Coverage Status
Change from base Build 237: 0.0%
Covered Lines: 572
Relevant Lines: 1136
💛 - Coveralls

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Dec 15, 2018
leakingtapan
leakingtapan reviewed Dec 16, 2018
View reviewed changes
docs/README.md Outdated

To enable topology support on kuberetes, make sure `CSINodeInfo` and `CSIDriverRegistry` feature flags are enabled on both kubelet and kube-apiserver and `CSINodeInfo` CRD is installed on the cluster following [Enabling CSINodeInfo](https://kubernetes-csi.github.io/docs/Setup.html#enabling-csinodeinfo).
* Enable the flag `--allow-privileged=true` in the manifest entries of kubelet and kube-apiserver.
Copy link
Contributor

Choose a reason for hiding this comment

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

For the manifest, ru referring to kops cluster manifest? I think we don't need to mention manifest since not every one is using kops. Probably we can say something like:

Enable the flag `--allow-privileged=true` for kubelet and kube-apiserver.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Manifest is not a word specific to kops. Manifests is a generic term valid for all Kubernetes resources / objects whether the cluster is set by kops or some other tool.

Copy link

Choose a reason for hiding this comment

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

This flag is now deprecated no?

Copy link

Choose a reason for hiding this comment

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

correct, I just ran into that as well

docs/README.md Outdated
Under the directory [deploy/kubernetes](../deploy/kubernetes), there are a few manifest files that are needed to deploy the CSI driver along with sidecar containers. If you are using Kubernetes v1.12, use the manifest files under [deploy/kubernetes/v1.12](../deploy/kubernetes/v1.12); for kubernetes v1.10 and v1.11, use the files under [deploy/kubernetes/v1.[10,11]](../deploy/kubernetes/v1.[10,11]).
* Install the `CSINodeInfo` CRD on the cluster using the instructions provided here: [Enabling CSINodeInfo](https://kubernetes-csi.github.io/docs/Setup.html#enabling-csinodeinfo).

* Ensure that the feature gate is enabled as `--feature-gates=CSINodeInfo=true` when using *external-provisioner*
Copy link
Contributor

Choose a reason for hiding this comment

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

Just notice a typo of the previous doc, we need to fix the feature gate flag:

* Ensure that the feature gate is enabled as `--feature-gates=Topology=true` when using *external-provisioner*

Ref: https://github.com/kubernetes-sigs/aws-ebs-csi-driver/blob/master/deploy/kubernetes/latest/provisioner.yaml#L101

Copy link
Contributor Author

@d-nishi d-nishi Dec 16, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Updated!

docs/README.md Outdated

## Setup
### Kubernetes
* Use the manifest files under the directory [deploy/kubernetes](../deploy/kubernetes), needed to deploy the CSI driver and sidecar containers. If you are using Kubernetes v1.12, use the manifest files under [deploy/kubernetes/v1.12](../deploy/kubernetes/v1.12); for kubernetes v1.10 and v1.11, use the files under [deploy/kubernetes/v1.[10,11]](../deploy/kubernetes/v1.[10,11]).
Copy link
Contributor

Choose a reason for hiding this comment

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

After read it again, I feel its better to use numeric list instead of bullet point here since it requires user to follow each step listed here in order

Copy link
Contributor Author

@d-nishi d-nishi Dec 16, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Updated!

@leakingtapan
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 16, 2018
@k8s-ci-robot k8s-ci-robot merged commit 85b09b3 into kubernetes-sigs:master Dec 16, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mitchellhuang mitchellhuang mitchellhuang left review comments

@leakingtapan leakingtapan leakingtapan left review comments

@corbanvilla corbanvilla corbanvilla left review comments

@jsafrane jsafrane Awaiting requested review from jsafrane

Assignees

@leakingtapan leakingtapan

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. 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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@d-nishi @k8s-ci-robot @coveralls @leakingtapan @mitchellhuang @corbanvilla