Skip to content

Commit e3062e6

Browse files
authored
Merge pull request #149 from edisonxiang/clarifypluginnamerules
spec: Clarify Plugin Name Rules
2 parents 28cea9f + 2147678 commit e3062e6

File tree

3 files changed

+22
-4
lines changed

3 files changed

+22
-4
lines changed

csi.proto

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,13 @@ message GetPluginInfoRequest {
8282
}
8383

8484
message GetPluginInfoResponse {
85-
// This field is REQUIRED.
85+
// The name MUST follow reverse domain name notation format
86+
// (https://en.wikipedia.org/wiki/Reverse_domain_name_notation).
87+
// It SHOULD include the plugin's host company name and the plugin
88+
// name, to minimize the possibility of collisions. It MUST be 63
89+
// characters or less, beginning and ending with an alphanumeric
90+
// character ([a-z0-9A-Z]) with dashes (-), underscores (_),
91+
// dots (.), and alphanumerics between. This field is REQUIRED.
8692
string name = 1;
8793

8894
// This field is REQUIRED. Value of this field is opaque to the CO.

lib/go/csi/csi.pb.go

Lines changed: 7 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

spec.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,7 @@ The general flow of the success case is as follows (protos illustrated in YAML f
352352
minor: 1
353353
patch: 0
354354
response:
355-
name: org.foo.whizbang/super-plugin
355+
name: org.foo.whizbang.super-plugin
356356
vendor_version: blue-green
357357
manifest:
358358
baz: qaz
@@ -400,7 +400,13 @@ message GetPluginInfoRequest {
400400
}
401401
402402
message GetPluginInfoResponse {
403-
// This field is REQUIRED.
403+
// The name MUST follow reverse domain name notation format
404+
// (https://en.wikipedia.org/wiki/Reverse_domain_name_notation).
405+
// It SHOULD include the plugin's host company name and the plugin
406+
// name, to minimize the possibility of collisions. It MUST be 63
407+
// characters or less, beginning and ending with an alphanumeric
408+
// character ([a-z0-9A-Z]) with dashes (-), underscores (_),
409+
// dots (.), and alphanumerics between. This field is REQUIRED.
404410
string name = 1;
405411
406412
// This field is REQUIRED. Value of this field is opaque to the CO.

0 commit comments

Comments
 (0)