Skip to content

Commit 01641b1

Browse files
committed
misc: explain what is the difference between "cluster id" and "cluster name"
1 parent 2e5a0f8 commit 01641b1

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

pkg/client/client.go

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,17 @@ type (
1313
// Options is the struct describing additional information pertinent to an agent that isn't a data reading
1414
// These fields will then be uploaded together with data readings.
1515
Options struct {
16-
OrgID string
17-
ClusterID string
18-
ClusterName string
16+
// Only used with Jetstack Secure.
17+
OrgID string
18+
19+
// Only used with Jetstack Secure.
20+
ClusterID string
21+
22+
// Only used with Venafi Cloud. The convention is to use the agent
23+
// config's `cluster_id` as ClusterName.
24+
ClusterName string
25+
26+
// Only used with Venafi Cloud.
1927
ClusterDescription string
2028
}
2129

0 commit comments

Comments
 (0)