ocopea / k8s-mongodsb

Ocopea MongoDB Data Service Broker implementation running on Kubernetes

Ocopea Kubernetes mongodsb

Ocopea MongoDB Data Service Broker implementation for running MongoDB on Kubernetes

For more information about Ocopea for Kubernetes, visit the Ocopea Kubernetes repo.

This DSB supports a single plan named "standard" that runs the Mongo Docker image on Kubernetes and supports taking a service copy using mongodump and mongorestore.

How to build

• clone the repo under GOPATH/src/ocopea/
• run the buildImage.sh script

How to run

The easiest and the recommended way to run the mongodsb is by using the Ocopea Kubernetes deployer using the deploy-mongodsb command. for example for running the DSB on minikube into a namespace called "testing":

$ go run deployer.go deploy-mongodsb -namespace=testing -local-cluster-ip=$(minikube ip)

If you wish to run the container yourself using Kubernetes deployment all you have to do is make sure you supply Kubernetes credentials if required using both environment variables: K8S_USERNAME, K8S_PASSWORD.

Once running you can attach the DSB to an Ocopea site using the site config screen in the UI, or directly via the Ocopea API.

Tests

The project uses the go-swagger server code generator when building the Docker image. In order to build the project, debug or run the tests locally you'll have to run the swagger tool locally. The swagger generator version we use is 0.10.0. Find installation instructions here.

$ swagger generate server -f dsb-swagger.yaml -A k8s-mongodsb

To run the unit test:

$ cd restapi/impl
$ go test

To run end to end tests on a Kubernetes cluster use the Kubernetes tester project.

Contribution

• Contributing to Ocopea
• Ocopea Developer Guidelines

k8s-mongodsb's Issues

Fix project paths to start with github.com

Tests fail to run

#1 When trying to run the tests, I get the following:
$ go test
../../../../../src/ocopea/k8s-mongodsb/restapi/impl/copy_service_instance.go:10:2: cannot find package "ocopea/k8s-mongodsb/models" in any of:
/home/mmccarth/cndp/src/ocopea/k8s-mongodsb/vendor/ocopea/k8s-mongodsb/models (vendor tree)
/usr/local/go/src/ocopea/k8s-mongodsb/models (from $GOROOT)
/home/mmccarth/cndp/src/ocopea/k8s-mongodsb/models (from $GOPATH)
../../../../../src/ocopea/k8s-mongodsb/restapi/impl/copy_service_instance.go:12:2: cannot find package "ocopea/k8s-mongodsb/restapi/operations/dsb_web" in any of:
/home/mmccarth/cndp/src/ocopea/k8s-mongodsb/vendor/ocopea/k8s-mongodsb/restapi/operations/dsb_web (vendor tree)
/usr/local/go/src/ocopea/k8s-mongodsb/restapi/operations/dsb_web (from $GOROOT)
/home/mmccarth/cndp/src/ocopea/k8s-mongodsb/restapi/operations/dsb_web (from $GOPATH)

So I went to a path referenced by my GOPATH:
$ set | grep GO
GOPATH=/home/mmccarth/cndp
GOROOT=/usr/local/go

And retried and saw

$ cd /cndp/src/ocopea/k8s-mongodsb/restapi/impl/
mmccarth@ubuntu:/cndp/src/ocopea/k8s-mongodsb/restapi/impl$ go test
copy_service_instance.go:10:2: cannot find package "ocopea/k8s-mongodsb/models" in any of:
/home/mmccarth/cndp/src/ocopea/k8s-mongodsb/vendor/ocopea/k8s-mongodsb/models (vendor tree)
/usr/local/go/src/ocopea/k8s-mongodsb/models (from $GOROOT)
/home/mmccarth/cndp/src/ocopea/k8s-mongodsb/models (from $GOPATH)
copy_service_instance.go:12:2: cannot find package "ocopea/k8s-mongodsb/restapi/operations/dsb_web" in any of:
/home/mmccarth/cndp/src/ocopea/k8s-mongodsb/vendor/ocopea/k8s-mongodsb/restapi/operations/dsb_web (vendor tree)
/usr/local/go/src/ocopea/k8s-mongodsb/restapi/operations/dsb_web (from $GOROOT)
/home/mmccarth/cndp/src/ocopea/k8s-mongodsb/restapi/operations/dsb_web (from $GOPATH)

This is based on a straight clone of this repo, without specifying a directory name for the repo.

Is there a restriction we need to document?

buildImage.sh should check the return code of the 'mvn clean install' command before creating the image.

buildImage.sh should check the return code of the 'mvn clean install' command, otherwise even if build fails, the docker image will still be created successfully.

remove the mysql dependency from the godeps

Instructions to run tests using the docker container

We have instructions to build the project using the docker container. It would be nice to have instructions on how to run the tests using the container.

Godeps and vendor folder contents don't match.

Try deleting vendor folder and issue godep restore and see the command fail. But we can see the code build with the vendor contents. Quite clearly this means things have diverged. Need to fix this.