add description to secret fields

banzaicloud · Jun 21, 2019 · d1f622c · d1f622c
1 parent 60f0fa8
commit d1f622c
Showing 1 changed file with 30 additions and 30 deletions.
diff --git a/pkg/secret/secret.go b/pkg/secret/secret.go
@@ -180,41 +180,41 @@ const (
 var DefaultRules = map[string]Meta{
 	cluster.Alibaba: {
 		Fields: []FieldMeta{
-			{Name: AlibabaRegion, Required: false},
-			{Name: AlibabaAccessKeyId, Required: true},
-			{Name: AlibabaSecretAccessKey, Required: true},
+			{Name: AlibabaRegion, Required: false, Description: "Alibaba Cloud region"},
+			{Name: AlibabaAccessKeyId, Required: true, Description: "Your Alibaba Cloud access key id"},
+			{Name: AlibabaSecretAccessKey, Required: true, Description: "Your Alibaba Cloud secret access key id"},
 		},
 		Sourcing: EnvVar,
 	},
 	cluster.Amazon: {
 		Fields: []FieldMeta{
-			{Name: AwsRegion, Required: false},
-			{Name: AwsAccessKeyId, Required: true},
-			{Name: AwsSecretAccessKey, Required: true},
+			{Name: AwsRegion, Required: false, Description: "Amazon Cloud region"},
+			{Name: AwsAccessKeyId, Required: true, Description: "Your Amazon Cloud access key id"},
+			{Name: AwsSecretAccessKey, Required: true, Description: "Your Amazon Cloud secret access key id"},
 		},
 		Sourcing: EnvVar,
 	},
 	cluster.Azure: {
 		Fields: []FieldMeta{
-			{Name: AzureClientID, Required: true},
-			{Name: AzureClientSecret, Required: true},
-			{Name: AzureTenantID, Required: true},
-			{Name: AzureSubscriptionID, Required: true},
+			{Name: AzureClientID, Required: true, Description: "Your application client id"},
+			{Name: AzureClientSecret, Required: true, Description: "Your client secret id"},
+			{Name: AzureTenantID, Required: true, Description: "Your tenant id"},
+			{Name: AzureSubscriptionID, Required: true, Description: "Your subscription id"},
 		},
 		Sourcing: EnvVar,
 	},
 	cluster.Google: {
 		Fields: []FieldMeta{
-			{Name: Type, Required: true},
-			{Name: ProjectId, Required: true},
-			{Name: PrivateKeyId, Required: true},
-			{Name: PrivateKey, Required: true},
-			{Name: ClientEmail, Required: true},
-			{Name: ClientId, Required: true},
-			{Name: AuthUri, Required: true},
-			{Name: TokenUri, Required: true},
-			{Name: AuthX509Url, Required: true},
-			{Name: ClientX509Url, Required: true},
+			{Name: Type, Required: true, Description: "service_account"},
+			{Name: ProjectId, Required: true, Description: "Google Could Project Id. Find more about, Google Cloud secret fields here: https://beta.banzaicloud.io/docs/cloud-provider-credentials/google/gke_auth_credentials/#method-2-command-line"},
+			{Name: PrivateKeyId, Required: true, Description: "Id of you private key"},
+			{Name: PrivateKey, Required: true, Description: "Your private key "},
+			{Name: ClientEmail, Required: true, Description: "Google service account client email"},
+			{Name: ClientId, Required: true, Description: "Client Id"},
+			{Name: AuthUri, Required: true, Description: "OAuth2 authentatication IRU"},
+			{Name: TokenUri, Required: true, Description: "OAuth2 token URI"},
+			{Name: AuthX509Url, Required: true, Description: "OAuth2 provider ceritficate URL"},
+			{Name: ClientX509Url, Required: true, Description: "OAuth2 client ceritficate URL"},
 		},
 		Sourcing: EnvVar,
 	},
@@ -226,12 +226,12 @@ var DefaultRules = map[string]Meta{
 	},
 	cluster.Oracle: {
 		Fields: []FieldMeta{
-			{Name: OracleUserOCID, Required: true},
-			{Name: OracleTenancyOCID, Required: true},
-			{Name: OracleAPIKey, Required: true},
-			{Name: OracleAPIKeyFingerprint, Required: true},
-			{Name: OracleRegion, Required: true},
-			{Name: OracleCompartmentOCID, Required: true},
+			{Name: OracleUserOCID, Required: true, Description: "Your Oracle user OCID. Find more about, generating public key and fingerprint here: https://beta.banzaicloud.io/docs/cloud-provider-credentials/oracle/oke_auth_credentials/#generate-api-token"},
+			{Name: OracleTenancyOCID, Required: true, Description: "Your tenancy OCID"},
+			{Name: OracleAPIKey, Required: true, Description: "Your public key"},
+			{Name: OracleAPIKeyFingerprint, Required: true, Description: "Fingerprint of you public key"},
+			{Name: OracleRegion, Required: true, Description: "Oracle region"},
+			{Name: OracleCompartmentOCID, Required: true, Description: "Your compartment OCID"},
 		},
 	},
 	SSHSecretType: {
@@ -288,15 +288,15 @@ var DefaultRules = map[string]Meta{
 	},
 	PasswordSecretType: {
 		Fields: []FieldMeta{
-			{Name: Username, Required: true},
-			{Name: Password, Required: false},
+			{Name: Username, Required: true, Description: "Your username"},
+			{Name: Password, Required: false, Description: "Your password"},
 		},
 		Sourcing: EnvVar,
 	},
 	HtpasswdSecretType: {
 		Fields: []FieldMeta{
-			{Name: Username, Required: true, Opaque: true},
-			{Name: Password, Required: false, Opaque: true},
+			{Name: Username, Required: true, Opaque: true, Description: "Your username"},
+			{Name: Password, Required: false, Opaque: true, Description: "Your password"},
 			{Name: HtpasswdFile, Required: false},
 		},
 		Sourcing: Volume,