Giters

weaver-viii / adb-atomic-developer-bundle

a prepackaged development environment filled with production-grade pre-configured tools that makes container development easier

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

What is the Atomic Developer Bundle (ADB)?

The Atomic Developer Bundle (ADB) is a prepackaged development environment filled with production-grade, pre-configured tools, that makes container developers' lives easier. The ADB supports the development of multi-container applications against different technologies and orchestrators while providing a path that promotes best practices.

As a container developer, you want to use the ADB for these reasons:

  • Pre-Configured: You don't have to spend time building an environment and fighting configuration battles.
  • Multiple Environment Support: The ADB works on Windows, Linux and Mac OS X. The ADB supports several orchestrators (OpenShift, Kubernetes, Mesos, and plain Docker). The ADB is language independent and supports multiple developer models (IDE, CLI, SSH containment).
  • Production-Grade: The components of the ADB are configured to behave just as they will in production. Containers promise seamless delivery, but only if you test them in the right environment. This is that environment.
  • Self-Contained: The ADB is ready to go once installed. It comes prepackaged with the most common components ready, in case they are needed.
  • Open Source: The ADB leverages existing tools and technologies wherever possible to avoid pushing a developer into an environment that won't be supportable in production or that is tied to a single vendor. This also means it benefits from the stability of existing projects instead of reinventing the wheel.

The ADB is a virtual machine that is executed with Vagrant and some Vagrant plugins.

When would the ADB typically be used?

A developer begins using the ADB, in most cases, once they have a working application that has been decomposed into micro-services. They then follow this general outline of steps:

  1. Consider ways to divide your application into its component services or micro-services. For standard pieces, such as web servers, consider using pre-built containers from trusted sources. For truly unique pieces, build a custom container.
  2. Confirm the application works in the ADB by manually launching the application's container components or by using the instance of OpenShift in the container to launch the application.
  3. Build a Nulecule description of the application or complete the OpenShift application configuration.
  4. Test the application.

The Container Best Practices document in this project may also be of interest.

What is the Typical Usage Pattern?

The ADB supports three basic modes of usage. The modes vary by how much they rely on tools on the developer's workstation. From most to least reliant, they are:

  • Host-based IDE Mode

    This mode uses the ADB as a server resource for host-based IDE tools. In this mode, the user will run eclipse or other IDE tools that will access the resources of the ADB.

  • Host-based CLI Mode

    This mode uses the ADB as a server resource for host-based CLI tools. In this mode, the user will run docker and other CLI tools on their workstation and the result will be containers executed inside of the ADB.

  • SSH Mode

    This mode uses the ADB as a Linux virtual machine. The user will use the ssh command to log into the ADB and will directly execute docker and other commands from the command line. This is similar to having installed a Linux virtual machine and then installing and configuring all of the software the ADB ships with.

More information about using the ADB is available.

What does it Utilize?

The ADB is built on top of CentOS 7 and contains the following:

The ADB supports Atomic App, an implementation of the multi-container application specification nulecule, for multi-container applications.

You need to use the customized Vagrantfiles provided in the ADB project to set up the above mentioned environments. For further details refer to the Installation steps in the next section.

How do I Install and Run the ADB?

Below is a quick installation guide using the most common options. Detailed installation instructions are available.

  1. Install VirtualBox for your operating system.

  2. Install Vagrant for your operating system.

  3. Install the vagrant-service-manager Vagrant plugin:

    vagrant plugin install vagrant-service-manager

  4. Download the customized Vagrantfiles provided by the ADB project. These Vagrantfiles will download the ADB and automatically set up provider specific container development environments. They are listed below and more details are available in the Using Custom Vagrantfiles for Specific Use Cases section of the Using the Atomic Developer Bundle document and the Installation document.

    To download the ADB and set up provider specific container development environment:

    1. Create a directory for the Vagrant box

      $ mkdir directory && cd directory

    2. Download any of the following vagrantfiles, based on your requirements, to download the ADB and use it with host-based tools or via vagrant ssh.

      • For Docker Vagrantfile use:

        $ curl -sL https://raw.githubusercontent.com/projectatomic/adb-atomic-developer-bundle/master/components/centos/centos-docker-base-setup/Vagrantfile > Vagrantfile

      • For Kubernetes Vagrantfile use:

        $ curl -sL https://raw.githubusercontent.com/projectatomic/adb-atomic-developer-bundle/master/components/centos/centos-k8s-singlenode-setup/Vagrantfile > Vagrantfile

      • For OpenShift Origin Vagrantfile use:

        $ curl -sL https://raw.githubusercontent.com/projectatomic/adb-atomic-developer-bundle/master/components/centos/centos-openshift-setup/Vagrantfile > Vagrantfile

      • For Apache Mesos Marathon Vagrantfile use:

        $ curl -sL https://raw.githubusercontent.com/projectatomic/adb-atomic-developer-bundle/master/components/centos/centos-mesos-marathon-singlenode-setup/Vagrantfile > Vagrantfile

  1. Start the ADB

    vagrant up

This will download the ADB and set it up to work with the provider of choice for use with host-based tools or via vagrant ssh. You may wish to review the Using the Atomic Developer Bundle documentation before starting the ADB, especially if you are using host-based tools.

What is full feature set?

Today the box provides the following:

  • Docker support to unsupported platforms (i.e. Microsoft Windows, Mac OS X, etc.)
  • Kubernetes orchestration for local testing of applications
  • Application definition using the Nulecule specification

Additional goals, objectives and work in progress can be found in the architecture and roadmap document and on the Project Atomic trello board.

What are the deliverables and how do I get it?

The ADB is delivered as a Vagrant box for various (currently libvirt and VirtualBox) providers. The boxes are built using the CentOS powered Community Build System. Boxes are delivered via Hashicorp's Atlas and are available at cloud.centos.org. These boxes differ from existing Vagrant boxes for CentOS as they have specific build requirements that are not enabled in those boxes.

Documentation

Interested in Contributing to this project?

We welcome new ideas, suggestions, issues and pull requests. Want to be more involved, join us:

Documentation is written using reStructuredText. An online reStructuredText editor is available.

On the web:

About

a prepackaged development environment filled with production-grade pre-configured tools that makes container development easier

License:GNU General Public License v2.0

Languages

Language:Ruby 72.0%Language:Shell 20.9%Language:Python 7.1%