Giter Club home page Giter Club logo

dev-environment's Introduction

Snowplow Development Environment

Vagrant vagrant-based development environment with Ansible ansible playbooks to install common tools, including:

  • The JVM ecosystem
  • Ruby
  • Postgres

Works fine on Linux, Mac and Windows hosts.

Used as the development environment for all [Snowplow Analytics] snowplow projects.

Installation

Dependencies

To use this development environment, you need to have Vagrant vagrant-install and VirtualBox virtualbox-install installed.

We also recommend installing vagrant-vbguest to prevent the VirtualBox Guest Additions from getting out of sync:

$ vagrant plugin install vagrant-vbguest

Starting Vagrant

First, clone the repo, including ansible-playbooks submodule:

$ git clone --recursive https://github.com/snowplow/dev-environment.git
$ cd dev-environment

By default the development environment is configured with 2 GB of RAM. You can adjust this by running the configure.sh script, e.g. for 5 GB try:

$ ./scripts/configure.sh 5

Now you can build the VM:

$ vagrant up

And SSH into it:

$ vagrant ssh

Installing software

The guest VM has Ansible installed. This means you can run the different [Ansible playbooks] ansible-playbooks directly, thus:

$ ansible-playbook /vagrant/vagrant/oss-playbooks/{{PLAYBOOK_NAME}}.yml \
--inventory-file=/vagrant/vagrant/ansible.hosts --connection=local

For example, to install the development environment for working on the Snowplow batch-based enrichment process:

$ ansible-playbook /vagrant/vagrant/oss-playbooks/snowplow-batch-pipeline.yml \
--inventory-file=/vagrant/vagrant/ansible.hosts --connection=local

To simply install Java-7:

$ ansible-playbook /vagrant/vagrant/oss-playbooks/java-7.yml \
--inventory-file=/vagrant/vagrant/ansible.hosts --connection=local

A whole host of playbooks can be found in the ansible-playbooks (https://github.com/snowplow/ansible-playbooks). Playbooks in the root of the project can be run directly - these are composed of [roles] (https://github.com/snowplow/ansible-playbooks/tree/master/roles) that individually install specific components of development environments. For more information on composing your own development environments out of the individual roles, see the [ansible-playbooks README] (https://github.com/snowplow/ansible-playbooks).

Starting developing

We recommend removing git tracking from the dev environment before starting coding. You can do these either from the host or the guest VM:

$ rm -rf .git*

Now you can safely pull down the codebase you want to work on e.g:

$ git clone https://github.com/snowplow/snowplow.git

Available playbooks

Please see our [Ansible playbooks] ansible-playbooks repository for the full list.

Copyright and license

Snowplow Development Environment is copyright 2014 Snowplow Analytics Ltd.

Licensed under the [Apache License, Version 2.0] license (the "License"); you may not use this software except in compliance with the License.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

dev-environment's People

Contributors

alexanderdean avatar yalisassoon avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.