Depreciate auth.key_passphrase

Fixes: #142

Author: prydie

manifests/cloud-provider-example.yaml

@@ -8,7 +8,7 @@ auth:
     <snip>
     -----END RSA PRIVATE KEY-----
   # Omit if there is not a password for the key
-  key_passphrase: supersecretpassword
+  passphrase: supersecretpassword
   fingerprint: 8c:bf:17:7b:5f:e0:7d:13:75:11:d6:39:0d:e2:84:74
 
 # vcn configures the Virtual Cloud Network (VCN) within which the cluster resides.

pkg/oci/ccm.go

@@ -73,7 +73,7 @@ func NewCloudProvider(config *Config) (cloudprovider.Interface, error) {
 		config.Auth.Region,
 		config.Auth.Fingerprint,
 		config.Auth.PrivateKey,
-		&config.Auth.PrivateKeyPassphrase,
+		&config.Auth.Passphrase,
 	))
 	if err != nil {
 		return nil, err
@@ -109,6 +109,8 @@ func init() {
 		if err != nil {
 			return nil, err
 		}
+		cfg.Complete()
+
 		if err = cfg.Validate(); err != nil {
 			return nil, err
 		}

pkg/oci/config.go

@@ -19,19 +19,22 @@ import (
 	"io"
 	"io/ioutil"
 
+	"github.com/golang/glog"
 	"gopkg.in/yaml.v2"
 )
 
 // AuthConfig holds the configuration required for communicating with the OCI
 // API.
 type AuthConfig struct {
-	Region               string `yaml:"region"`
-	TenancyOCID          string `yaml:"tenancy"`
-	CompartmentOCID      string `yaml:"compartment"`
-	UserOCID             string `yaml:"user"`
-	PrivateKey           string `yaml:"key"`
-	Fingerprint          string `yaml:"fingerprint"`
-	PrivateKeyPassphrase string `yaml:"key_passphrase"` // TODO(apryde): the yaml should be keyPassphrase
+	Region          string `yaml:"region"`
+	TenancyOCID     string `yaml:"tenancy"`
+	CompartmentOCID string `yaml:"compartment"`
+	UserOCID        string `yaml:"user"`
+	PrivateKey      string `yaml:"key"`
+	Fingerprint     string `yaml:"fingerprint"`
+	// PrivateKeyPassphrase is DEPRECIATED in favour of Passphrase.
+	PrivateKeyPassphrase string `yaml:"key_passphrase"`
+	Passphrase           string `yaml:"passphrase"`
 }
 
 // LoadBalancerConfig holds the configuration options for OCI load balancers.
@@ -60,6 +63,14 @@ type Config struct {
 	VCNID string `yaml:"vcn"`
 }
 
+// Complete the config applying defaults / overrides.
+func (c *Config) Complete() {
+	if c.Auth.Passphrase == "" && c.Auth.PrivateKeyPassphrase != "" {
+		glog.Warning("cloud-provider config: \"auth.key_passphrase\" is DEPRECIATED and will be removed in a later release. Please set \"auth.passphrase\".")
+		c.Auth.Passphrase = c.Auth.PrivateKeyPassphrase
+	}
+}
+
 // Validate validates the OCI cloud-provider config.
 func (c *Config) Validate() error {
 	return ValidateConfig(c).ToAggregate()