Skip to content
This repository was archived by the owner on Mar 22, 2018. It is now read-only.

Commit 00d4753

Browse files
rootfsrootfs
authored
Merge pull request #14 from edisonxiang/supportreadconfigincinder
support reading config in csi cinder driver
2 parents a310ddc + fd023c5 commit 00d4753

9 files changed

Lines changed: 234 additions & 26 deletions

File tree

‎app/cinderplugin/main.go‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ import (
2525
)
2626

2727
var (
28-
endpoint string
29-
nodeID string
28+
endpoint string
29+
nodeID string
30+
cloudconfig string
3031
)
3132

3233
func main() {
@@ -44,6 +45,9 @@ func main() {
4445
cmd.PersistentFlags().StringVar(&endpoint, "endpoint", "", "CSI endpoint")
4546
cmd.MarkPersistentFlagRequired("endpoint")
4647

48+
cmd.PersistentFlags().StringVar(&cloudconfig, "cloud-config", "", "CSI driver cloud config")
49+
cmd.MarkPersistentFlagRequired("cloud-config")
50+
4751
if err := cmd.Execute(); err != nil {
4852
fmt.Fprintf(os.Stderr, "%s", err.Error())
4953
os.Exit(1)
@@ -53,6 +57,6 @@ func main() {
5357
}
5458

5559
func handle() {
56-
d := cinder.NewDriver(nodeID, endpoint)
60+
d := cinder.NewDriver(nodeID, endpoint, cloudconfig)
5761
d.Run()
5862
}

‎pkg/cinder/README.md‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,7 @@
44

55
### Start Cinder driver
66
```
7-
$ export OS_USERNAME=admin
8-
$ export OS_PASSWORD=password
9-
$ export OS_TENANT_NAME=admin
10-
$ export OS_AUTH_URL="http://10.0.0.1/identity"
11-
$ export OS_DOMAIN_NAME=Default
12-
$ sudo ./_output/cinderplugin --endpoint tcp://127.0.0.1:10000 --nodeid CSINodeID
7+
$ sudo ./_output/cinderplugin --endpoint tcp://127.0.0.1:10000 --cloud-config /etc/cloud.conf --nodeid CSINodeID
138
```
149

1510
### Test using csc

‎pkg/cinder/controllerserver_test.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ var fakeCs *controllerServer
3030
// Init Controller Server
3131
func init() {
3232
if fakeCs == nil {
33-
d := NewDriver(fakeNodeID, fakeEndpoint)
33+
d := NewDriver(fakeNodeID, fakeEndpoint, fakeConfig)
3434
fakeCs = NewControllerServer(d)
3535
}
3636
}

‎pkg/cinder/driver.go‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,14 @@ import (
2020
"github.com/container-storage-interface/spec/lib/go/csi"
2121
"github.com/golang/glog"
2222

23+
"github.com/kubernetes-csi/drivers/pkg/cinder/openstack"
2324
"github.com/kubernetes-csi/drivers/pkg/csi-common"
2425
)
2526

2627
type driver struct {
27-
csiDriver *csicommon.CSIDriver
28-
endpoint string
28+
csiDriver *csicommon.CSIDriver
29+
endpoint string
30+
cloudconfig string
2931

3032
ids *csicommon.DefaultIdentityServer
3133
cs *controllerServer
@@ -49,12 +51,13 @@ func GetSupportedVersions() []*csi.Version {
4951
return []*csi.Version{&version}
5052
}
5153

52-
func NewDriver(nodeID, endpoint string) *driver {
54+
func NewDriver(nodeID, endpoint string, cloudconfig string) *driver {
5355
glog.Infof("Driver: %v version: %v", driverName, csicommon.GetVersionString(&version))
5456

5557
d := &driver{}
5658

5759
d.endpoint = endpoint
60+
d.cloudconfig = cloudconfig
5861

5962
csiDriver := csicommon.NewCSIDriver(driverName, &version, GetSupportedVersions(), nodeID)
6063
csiDriver.AddControllerServiceCapabilities([]csi.ControllerServiceCapability_RPC_Type{csi.ControllerServiceCapability_RPC_CREATE_DELETE_VOLUME})
@@ -79,5 +82,6 @@ func NewNodeServer(d *driver) *nodeServer {
7982
}
8083

8184
func (d *driver) Run() {
85+
openstack.InitOpenStackProvider(d.cloudconfig)
8286
csicommon.RunControllerandNodePublishServer(d.endpoint, d.csiDriver, NewControllerServer(d), NewNodeServer(d))
8387
}

‎pkg/cinder/etc/cloud.conf‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[Global]
2+
username=user
3+
password=pass
4+
auth-url=https://<keystone_ip>/identity/v3
5+
tenant-id=c869168a828847f39f7f06edd7305637
6+
domain-id=2a73b8f597c04551a0fdc8e95544be8a

‎pkg/cinder/fake.go‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import (
2222

2323
var fakeNodeID = "CSINodeID"
2424
var fakeEndpoint = "tcp://127.0.0.1:10000"
25+
var fakeConfig = "/etc/cloud.conf"
2526
var fakeCtx = context.Background()
2627
var fakeVolName = "CSIVolumeName"
2728
var fakeVolID = "CSIVolumeID"

‎pkg/cinder/nodeserver_test.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ var fakeNs *nodeServer
3030
// Init Node Server
3131
func init() {
3232
if fakeNs == nil {
33-
d := NewDriver(fakeNodeID, fakeEndpoint)
33+
d := NewDriver(fakeNodeID, fakeEndpoint, fakeConfig)
3434
fakeNs = NewNodeServer(d)
3535
}
3636
}

‎pkg/cinder/openstack/openstack.go‎

Lines changed: 91 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,10 @@ package openstack
1919
import (
2020
"os"
2121

22+
"github.com/golang/glog"
2223
"github.com/gophercloud/gophercloud"
2324
"github.com/gophercloud/gophercloud/openstack"
25+
"gopkg.in/gcfg.v1"
2426
)
2527

2628
type IOpenStack interface {
@@ -38,37 +40,114 @@ type OpenStack struct {
3840
blockstorage *gophercloud.ServiceClient
3941
}
4042

43+
type Config struct {
44+
Global struct {
45+
AuthUrl string `gcfg:"auth-url"`
46+
Username string
47+
UserId string `gcfg:"user-id"`
48+
Password string
49+
TenantId string `gcfg:"tenant-id"`
50+
TenantName string `gcfg:"tenant-name"`
51+
DomainId string `gcfg:"domain-id"`
52+
DomainName string `gcfg:"domain-name"`
53+
Region string
54+
}
55+
}
56+
57+
func (cfg Config) toAuthOptions() gophercloud.AuthOptions {
58+
return gophercloud.AuthOptions{
59+
IdentityEndpoint: cfg.Global.AuthUrl,
60+
Username: cfg.Global.Username,
61+
UserID: cfg.Global.UserId,
62+
Password: cfg.Global.Password,
63+
TenantID: cfg.Global.TenantId,
64+
TenantName: cfg.Global.TenantName,
65+
DomainID: cfg.Global.DomainId,
66+
DomainName: cfg.Global.DomainName,
67+
68+
// Persistent service, so we need to be able to renew tokens.
69+
AllowReauth: true,
70+
}
71+
}
72+
73+
func GetConfigFromFile(configFilePath string) (gophercloud.AuthOptions, gophercloud.EndpointOpts, error) {
74+
// Get config from file
75+
var authOpts gophercloud.AuthOptions
76+
var epOpts gophercloud.EndpointOpts
77+
config, err := os.Open(configFilePath)
78+
if err != nil {
79+
glog.V(3).Infof("Failed to open OpenStack configuration file: %v", err)
80+
return authOpts, epOpts, err
81+
}
82+
defer config.Close()
83+
84+
// Read configuration
85+
var cfg Config
86+
err = gcfg.ReadInto(&cfg, config)
87+
if err != nil {
88+
glog.V(3).Infof("Failed to read OpenStack configuration file: %v", err)
89+
return authOpts, epOpts, err
90+
}
91+
92+
authOpts = cfg.toAuthOptions()
93+
epOpts = gophercloud.EndpointOpts{
94+
Region: cfg.Global.Region,
95+
}
96+
97+
return authOpts, epOpts, nil
98+
}
99+
100+
func GetConfigFromEnv() (gophercloud.AuthOptions, gophercloud.EndpointOpts, error) {
101+
// Get config from env
102+
authOpts, err := openstack.AuthOptionsFromEnv()
103+
var epOpts gophercloud.EndpointOpts
104+
if err != nil {
105+
glog.V(3).Infof("Failed to read OpenStack configuration from env: %v", err)
106+
return authOpts, epOpts, err
107+
}
108+
109+
epOpts = gophercloud.EndpointOpts{
110+
Region: os.Getenv("OS_REGION_NAME"),
111+
}
112+
113+
return authOpts, epOpts, nil
114+
}
115+
41116
var OsInstance IOpenStack = nil
117+
var configFile string = "/etc/cloud.conf"
118+
119+
func InitOpenStackProvider(cfg string) {
120+
configFile = cfg
121+
glog.V(2).Infof("InitOpenStackProvider configFile: %s", configFile)
122+
}
42123

43124
func GetOpenStackProvider() (IOpenStack, error) {
44125

45126
if OsInstance == nil {
46-
// Get config from env
47-
opts, err := openstack.AuthOptionsFromEnv()
127+
// Get config from file
128+
authOpts, epOpts, err := GetConfigFromFile(configFile)
48129
if err != nil {
49-
return nil, err
130+
// Get config from env
131+
authOpts, epOpts, err = GetConfigFromEnv()
132+
if err != nil {
133+
return nil, err
134+
}
50135
}
51136

52137
// Authenticate Client
53-
provider, err := openstack.AuthenticatedClient(opts)
138+
provider, err := openstack.AuthenticatedClient(authOpts)
54139
if err != nil {
55140
return nil, err
56141
}
57142

58-
region := os.Getenv("OS_REGION_NAME")
59-
60143
// Init Nova ServiceClient
61-
computeclient, err := openstack.NewComputeV2(provider, gophercloud.EndpointOpts{
62-
Region: region,
63-
})
144+
computeclient, err := openstack.NewComputeV2(provider, epOpts)
64145
if err != nil {
65146
return nil, err
66147
}
67148

68149
// Init Cinder ServiceClient
69-
blockstorageclient, err := openstack.NewBlockStorageV3(provider, gophercloud.EndpointOpts{
70-
Region: region,
71-
})
150+
blockstorageclient, err := openstack.NewBlockStorageV3(provider, epOpts)
72151
if err != nil {
73152
return nil, err
74153
}

‎pkg/cinder/openstack/openstack_test.go‎

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
/*
2+
Copyright 2017 The Kubernetes Authors.
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
*/
16+
17+
package openstack
18+
19+
import (
20+
"os"
21+
"testing"
22+
23+
"github.com/gophercloud/gophercloud"
24+
"github.com/stretchr/testify/assert"
25+
)
26+
27+
var fakeFileName = "cloud.conf"
28+
var fakeUserName = "user"
29+
var fakePassword = "pass"
30+
var fakeAuthUrl = "https://169.254.169.254/identity/v3"
31+
var fakeTenantID = "c869168a828847f39f7f06edd7305637"
32+
var fakeDomainID = "2a73b8f597c04551a0fdc8e95544be8a"
33+
var fakeRegion = "RegionOne"
34+
35+
// Test GetConfigFromFile
36+
func TestGetConfigFromFile(t *testing.T) {
37+
// init file
38+
var fakeFileContent = `
39+
[Global]
40+
username=` + fakeUserName + `
41+
password=` + fakePassword + `
42+
auth-url=` + fakeAuthUrl + `
43+
tenant-id=` + fakeTenantID + `
44+
domain-id=` + fakeDomainID + `
45+
region=` + fakeRegion + `
46+
`
47+
48+
f, err := os.Create(fakeFileName)
49+
if err != nil {
50+
t.Errorf("failed to create file: %v", err)
51+
}
52+
53+
_, err = f.WriteString(fakeFileContent)
54+
f.Close()
55+
if err != nil {
56+
t.Errorf("failed to write file: %v", err)
57+
}
58+
defer os.Remove(fakeFileName)
59+
60+
// Init assert
61+
assert := assert.New(t)
62+
63+
expectedAuthOpts := gophercloud.AuthOptions{
64+
IdentityEndpoint: fakeAuthUrl,
65+
Username: fakeUserName,
66+
Password: fakePassword,
67+
TenantID: fakeTenantID,
68+
DomainID: fakeDomainID,
69+
AllowReauth: true,
70+
}
71+
expectedEpOpts := gophercloud.EndpointOpts{
72+
Region: fakeRegion,
73+
}
74+
75+
// Invoke GetConfigFromFile
76+
actualAuthOpts, actualEpOpts, err := GetConfigFromFile(fakeFileName)
77+
if err != nil {
78+
t.Errorf("failed to GetConfigFromFile: %v", err)
79+
}
80+
81+
// Assert
82+
assert.Equal(expectedAuthOpts, actualAuthOpts)
83+
assert.Equal(expectedEpOpts, actualEpOpts)
84+
}
85+
86+
// Test GetConfigFromEnv
87+
func TestGetConfigFromEnv(t *testing.T) {
88+
// init env
89+
os.Setenv("OS_AUTH_URL", fakeAuthUrl)
90+
os.Setenv("OS_USERNAME", fakeUserName)
91+
os.Setenv("OS_PASSWORD", fakePassword)
92+
os.Setenv("OS_TENANT_ID", fakeTenantID)
93+
os.Setenv("OS_DOMAIN_ID", fakeDomainID)
94+
os.Setenv("OS_REGION_NAME", fakeRegion)
95+
96+
// Init assert
97+
assert := assert.New(t)
98+
99+
expectedAuthOpts := gophercloud.AuthOptions{
100+
IdentityEndpoint: fakeAuthUrl,
101+
Username: fakeUserName,
102+
Password: fakePassword,
103+
TenantID: fakeTenantID,
104+
DomainID: fakeDomainID,
105+
}
106+
expectedEpOpts := gophercloud.EndpointOpts{
107+
Region: fakeRegion,
108+
}
109+
110+
// Invoke GetConfigFromEnv
111+
actualAuthOpts, actualEpOpts, err := GetConfigFromEnv()
112+
if err != nil {
113+
t.Errorf("failed to GetConfigFromEnv: %v", err)
114+
}
115+
116+
// Assert
117+
assert.Equal(expectedAuthOpts, actualAuthOpts)
118+
assert.Equal(expectedEpOpts, actualEpOpts)
119+
}

0 commit comments

Comments
 (0)