https://github.com/icflorescu/openshift-cartridge-mongodb
Custom cartridge for OpenShift providing MongoDB > 3.2.
https://github.com/icflorescu/openshift-cartridge-mongodb
cartridge mongodb mongodb-cartridge mongodb-openshift openshift
Last synced: 5 months ago
JSON representation
Custom cartridge for OpenShift providing MongoDB > 3.2.
- Host: GitHub
- URL: https://github.com/icflorescu/openshift-cartridge-mongodb
- Owner: icflorescu
- License: isc
- Created: 2014-12-13T04:01:04.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2017-04-23T10:52:03.000Z (over 8 years ago)
- Last Synced: 2025-07-08T17:45:01.787Z (6 months ago)
- Topics: cartridge, mongodb, mongodb-cartridge, mongodb-openshift, openshift
- Language: Shell
- Homepage:
- Size: 33.2 KB
- Stars: 70
- Watchers: 7
- Forks: 27
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Custom MongoDB cartridge for OpenShift
This is a custom OpenShift cartridge providing MongoDB 3.4.x + WiredTiger storage engine.
## Why
Because the standard OpenShift MongoDB cartridge is stuck at 2.4.
## When to use
When you need a quick and unsofisticated solution to run your application with the latest MongoDB version.
## How to
### Using [web console](https://openshift.redhat.com/app/console/applications)
Open your application in the [web console](https://openshift.redhat.com/app/console/applications), go to **"See the list of cartridges you can add"**, paste the URL below in **"Install your own cartridge"** textbox at the bottom of the page and click "Next".
https://raw.githubusercontent.com/icflorescu/openshift-cartridge-mongodb/master/metadata/manifest.yml
Then you can use `MONGODB_URL` environment variable to connect from an application running in the main web cartridge.
To keep things flexible, the connection string stored in `MONGODB_URL` ends with `/` and **does not include a database name**. Use your application logic to name/create your database(s) as needed.
For instance, here's how you'd do it in a Node.js application using [Mongoose ODM](http://mongoosejs.com/):
var mongoose = require('mongoose');
...
// Mongoose will create database_name if necessary
mongoose.connect(process.env.MONGODB_URL + 'database_name', { db: { nativeParser: true } });
### Using the command line
Make sure you have `rhc` installed (see [here](https://developers.openshift.com/en/managing-client-tools.html)).
If you want to **add** a MongoDB instance based on this cartridge to an existing application:
rhc cartridge-add https://raw.githubusercontent.com/icflorescu/openshift-cartridge-mongodb/master/metadata/manifest.yml \
--app appname
...where `appname` is the name of your application.
To **create** an app based on the standard Node.js v0.10 cartridge and this one, run:
rhc app create appname \
nodejs-0.10 \
https://raw.githubusercontent.com/icflorescu/openshift-cartridge-mongodb/master/metadata/manifest.yml
If you want to use **the latest Node.js version**, you'll have to use a [custom Node.js cartridge](https://github.com/icflorescu/openshift-cartridge-nodejs) as well:
rhc app create appname \
https://raw.githubusercontent.com/icflorescu/openshift-cartridge-nodejs/master/metadata/manifest.yml \
https://raw.githubusercontent.com/icflorescu/openshift-cartridge-mongodb/master/metadata/manifest.yml
## Notes
- Using this cartridge to host your data does provide a cheap solution, but please understand that you'll be using it on **your own responsibility**. `WiredTiger` engine is a memory-hungry beast and you could eventually [run into problems](https://github.com/icflorescu/openshift-cartridge-mongodb/issues/18). **Use a specialized Database-as-a Service provider for critical data** ([mLab](https://mlab.com/), [Compose](https://www.compose.io/), etc.).
- This is a lean cartridge. To save space, just `mongod` is installed. No client libraries, no `mongo` console. **If you need external access to your data, use `rhc port-forward`**.
- By default, the underlying MongoDB instance will accept unauthenticated access, which should be fine for most typical usage scenarios. See [the discussion here](https://github.com/icflorescu/openshift-cartridge-mongodb/issues/1) for more info.
- Can't think of a safe way to make this cartridge auto-updatable. For now we'll just have to use `mongodump`, destroy the cartridge, install the new version, then do a `mongorestore`.
- Don't hesitate to make a pull-request with an updated version in [this file](https://github.com/icflorescu/openshift-cartridge-mongodb/blob/master/metadata/manifest.yml#L4) if you notice this cartridge version is behind the latest stable [official MongoDB linux binary](http://www.mongodb.org/downloads).
## FAQ
**Q**: I'm getting the error *Cannot download, must be smaller than 20480 bytes* while trying to deploy the cartridge to OpenShift. What am I doing wrong?
**A**: You're probably trying to use the URL `https://github.com/icflorescu/openshift-cartridge-mongodb` instead of
`https://raw.githubusercontent.com/icflorescu/openshift-cartridge-mongodb/master/metadata/manifest.yml`. A common mistake for people not paying sufficient attention while trying to use a custom cartridge for the first time.
---
**Q**: How do I change the default `mongod` options?
**A**: `ssh` to the MongoDB gear, edit the [control script](https://github.com/icflorescu/openshift-cartridge-mongodb/blob/master/bin/control) with `nano mongodb/bin/control` and make sure to restart afterwards.
---
**Q:** How can I `ssh` to a MongoDB cartridge running in a secondary application gear?
**A:** You can discover the secondary gear URL by running `rhc app show appname --gears`.
## Related
Since you're here, chances are you might also be interested in this [custom Node.js cartridge](https://github.com/icflorescu/openshift-cartridge-nodejs).
## Credits
See contributors [here](https://github.com/icflorescu/openshift-cartridge-nodejs/graphs/contributors).
If you find this repo useful, don't hesitate to give it a star and [spread the word](http://twitter.com/share?text=Checkout%20this%20custom%20MongoDB%20cartridge%20for%20OpenShift!&url=http%3A%2F%2Fgithub.com/icflorescu/openshift-cartridge-mongodb&hashtags=mongodb,openshift,nodejs&via=icflorescu).
## Before raising issues
I'm getting lots of questions from people just learning to do web development or simply looking to solve a very specific problem they're dealing with. While I will answer some of them for the benefit of the community, please understand that open-source is a shared effort and it's definitely not about piggybacking on other people's work. On places like GitHub, that means raising issues is encouraged, but coming up with useful PRs is a lot better. If I'm willing to share some of my code for free, I'm doing it for a number of reasons: my own intellectual challenges, pride, arrogance, stubbornness to believe I'm bringing a contribution to common progress and freedom, etc. Your particular well-being is probably not one of those reasons. I'm not in the business of providing free consultancy, so if you need my help to solve your specific problem, there's a fee for that.
## License
The [ISC License](http://github.com/icflorescu/openshift-cartridge-mongodb/blob/master/LICENSE).