Update readme file to provide more info on driver options and tagging #844
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
size/S
Pull Request Test Coverage Report for Build 1876
💛 - Coveralls |
ayberk
approved these changes
Apr 21, 2021
wongma7
reviewed
Apr 21, 2021
docs/README.md
Outdated
| | TagKey | TagValue | sample | Description | | ||
| |------------------------|-------------------|---------------------------------------------------|---------------------| | ||
| | CSIVolumeName | pvcName | CSIVolumeName = pvc-1234567890 | add to all volumes, for recording associated pvc id and checking if a given volume was already created so that ControllerPublish/CreateVolume is idempotent. | | ||
| | CSISnapshotName | snapshotId | CSISnapshotName = snap-1234567890 | add to all snapshots, for for recording associated VolumeSnapshot id and checking if a given snapshot was already created | |
There was a problem hiding this comment.
typo here, 'for for recording'
wongma7
reviewed
Apr 21, 2021
docs/README.md
Outdated
| | CSIVolumeName | pvcName | CSIVolumeName = pvc-1234567890 | add to all volumes, for recording associated pvc id and checking if a given volume was already created so that ControllerPublish/CreateVolume is idempotent. | | ||
| | CSISnapshotName | snapshotId | CSISnapshotName = snap-1234567890 | add to all snapshots, for for recording associated VolumeSnapshot id and checking if a given snapshot was already created | | ||
| | ebs.csi.aws.com/cluster| true | ebs.csi.aws.com/cluster = true | add to all volumes and snapshots, for allowing users to use a policy to limit csi driver's permission to just the resources it manages. | | ||
| | kubernetes.io/cluster/X| owned | kubernetes.io/cluster/aws-cluster-id-1 = owned | add to all volumes and snapshots if k8s-tag-cluster-id argument is set to X. In in-tree cloudprovider, it's extremely unlikely/impossible for clusterName NOT to be set, so effectively this tag was set on ALL in-tree volumes, [here](https://github.com/kubernetes/cloud-provider-aws/blob/5f394ba297bf280ceb3edfc38922630b4bd83f46/pkg/providers/v2/tags.go#L108). In CSI world we have no automatic way to discover the cloud provider's clusterName, so if the user wants their CSI volumes to have these tags like in-tree volumes would, they have to provide clusterId.| |
There was a problem hiding this comment.
you can just keep the first line, the next ones are probably too much detail
AndyXiangLi
force-pushed
the
update-readme
branch
from
82cbfb4
to
af49cf4
Compare
|
thank you /lgtm |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: AndyXiangLi, ayberk, wongma7 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 |
AndyXiangLi
force-pushed
the
update-readme
branch
from
af49cf4
to
fcdd32c
Compare
k8s-ci-robot
removed
the
lgtm
|
New changes are detected. LGTM label has been removed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is this PR about? / Why do we need it?
Update readme file to provide more info on driver options and tagging