spec: Clarify Plugin Name Rules #149
Merged
Conversation
This file contains hidden or 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
The plugin name will be passed in through CO's APIs by the users to refer to the plugin. CSI should clarify the plugin name rules. This patch sepecifies the name in Reverse domain name notation format. Resolves: container-storage-interface#145, container-storage-interface#3
jdef
approved these changes
Nov 16, 2017
saad-ali
reviewed
Nov 17, 2017
There was a problem hiding this comment.
Thanks @edisonxiang for the PR!!
Minor change in wording otherwise LGTM
csi.proto
Outdated
| @@ -82,7 +82,13 @@ message GetPluginInfoRequest { | |||
| } | |||
|
|
|||
| message GetPluginInfoResponse { | |||
| // This field is REQUIRED. | |||
| // Specify the name in Reverse domain name notation format, | |||
There was a problem hiding this comment.
I would change the wording slightly:
The name MUST follow reverse domain name notation format (https://en.wikipedia.org/wiki/Reverse_domain_name_notation). It SHOULD include the plugin's host company name and the plugin name, to minimize the possibility of collisions. It MUST be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. This field is REQUIRED.
There was a problem hiding this comment.
Done, Thanks for your suggestion.
|
LGTM! |
This was referenced Nov 17, 2017
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.
The plugin name will be passed in through CO's
APIs by the users to refer to the plugin.
CSI should clarify the plugin name rules.
This patch sepecifies the name in Reverse domain
name notation format.
Resolves: #145, #3