Skip to content

Commit 6585d6b

Browse files
Update readme
1 parent de27110 commit 6585d6b

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Example for a local trusted `brokerMssqlConnection` with ODBC driver:
7272
Setup you GOPATH env variable
7373

7474
```sh
75-
go get github.com/tools/godep
75+
go get -u -v github.com/tools/godep
7676
go get github.com/cloudfoundry-incubator/cf-mssql-broker
7777

7878
cd $GOPATH/src/github.com/cloudfoundry-incubator/cf-mssql-broker # cd $env:GOPATH/src/github.com/cloudfoundry-incubator/cf-mssql-broker
@@ -84,6 +84,22 @@ go build
8484
cf-mssql-broker -config=cf_mssql_broker_config.json
8585
```
8686

87+
### Update dependencies
88+
89+
```sh
90+
cd $GOPATH/src/github.com/cloudfoundry-incubator/cf-mssql-broker
91+
92+
# To update all packages:
93+
go get -u -v go get github.com/cloudfoundry-incubator/cf-mssql-broker/...
94+
godep update ...
95+
96+
# Or to update a specific package (e.g. odbc package):
97+
go get -u -v code.google.com/p/odbc
98+
godep update code.google.com/p/odbc
99+
100+
git add Godeps/*
101+
```
102+
87103
## Using the broker with Curl REST calls
88104

89105
### Provision Instance
@@ -141,6 +157,13 @@ You need admin access to a Cloud Foundry deployment to add a new service broker.
141157
cf create-service-broker mssql-broker1 username password http://192.168.1.10:3000
142158
cf enable-service-access mssql-dev
143159
```
160+
161+
## Connecting to an external SQL Server
162+
163+
The broker service can run on the local SQL Server machine or on a remote machine (even as a CF app). It only needs to be able to send SQL queries/commands to the SQL Server. When the broker service is run on a remote location the `brokerMssqlConnection` has to be configured with the right IP, port, and credentials. You need to make sure that the network and firewall is setup so that the broker service has access to the SQL Server and that the credentials provided are authorized to create and drop databases.
164+
165+
Also, make sure the the CF applications that bind and connect to the SQL service database instances have network access to the configured `servedMssqlBindingHostname` and `servedMssqlBindingPort` entires. The following confiugations can affect what CF apps can reach in the network: Cloud Foundry security grous (i.e. cf security-groups), OpenStack/AWS sercurity groups for the DEAs/Cells and the SQL Server machines, Windows Firewall settings on the SQL Server machine, etc.
166+
144167
## Binding credentials exmaple
145168

146169
VCAP_SERVICES env variable for a CF application with a mssql service binding will contin the crednetials to the SQL Server. The folowing [credential fields](https://github.com/cloudfoundry-incubator/cf-mssql-broker/blob/master/mssql_binding_credentials.go) will be used:

0 commit comments

Comments
 (0)