knowledge-repo
knowledge-repo copied to clipboard
airbnb
Add detailed documentation around deployment best practices (with Docker images, etc)
In particular, we need to provide a few examples of different deployment scripts, along with a discussion of what can be configured for local deployments.
Auto-reviewers: @NiharikaRay @matthewwardrop @earthmancash @danfrankj
and perhaps an example where people can see what it looks like?
Oh and how to restrict access
Any updates on this? Having docker images would make adoption of this great tool a breeze
Hi @gabceb. Sorry! Not yet. There's been so many other issues that we've been working through, that this has been left behind. I also need to look into the standard way of handling site-specific configuration in Docker images. We'll get there!
Thanks for the reply @matthewwardrop. I recently helped deploy this in our internal dokku/docker box and was able to do so with some hacks due to the way is implemented. The hack was mostly around the fact that the code wants to git pull and if the folder is not a git repo it throws errors and dies. I did figure out later if the folder IS a git repo but it cannot pull either due to connection or ssh keys it gracefully handles the error and continues. Once i learn this I was able to deploy to dokku (which makes a docker image with the code) and before starting the server I run 'git init && git add . && git commit -m "dummy commit"' and 💥
With this experience in mind I've been thinking about a proper Dockefile. Since there is no secure way of passing ssh keys into a docker instance and I would not suggest users doing so via COPY these are options I think we have:
- Fix/change the code so that it gracefully handles the repo not being a git project
- Provide a dockerfile for use with the project backed by a db and not by a git repo
Let me know your thoughts
Just wanted to add that more documentation around deployments would be extremely valuable. I was able to get everything up and running locally without any problems, but got stuck trying to deploy to bluemix and heroku. A manifest.yml file would be extremely helpful for beginners. Ultimately, this seems like a fairly big barrier to adoption if users can't figure out how to deploy it because all their knowledge is stuck on their local machine.
