Code Monkey home page Code Monkey logo

dev_container's Introduction

Development Container

This repository is a container for developing KBase modules. To use this, you must already have a "runtime" directory, which contains the neccesary binaries and libraries. For an idea of what is expected to be in this runtime, consult the bootstrap repository.

Usage

  1. Clone this repository onto your development machine:

     $ git clone https://githhub.com/kbase/dev_container
 $ cd dev_container

  2. The "deployment directory" needs to be a directory where you have permissions to write. By default, this is a directory called /kb/deployment. If you have sufficient permissions to create this directory, then you may skip this step. To change the directory, open the "Makefile" and replace:

     TARGET = /kb/deployment

with the path to where you would like to deploy.

  1. Run the bootstrap script with the path to a "runtime directory" as the first argument.

     $ ./bootstrap /kb/runtime

  2. Source the user-env.sh script in the "development directory". This file is created during the bootstrap script in step 2.

     $ source user-env.sh

  3. Option step if no modules have been cloned into the modules sub directory. This will create directories and files in the deployment directory for every module.

    $ make deploy

  4. Clone "module repositories" into the modules directory:

     $ cd modules
 $ git clone [email protected]:idserver.git

  5. Do development work in a module.

  6. Goto 2.

Definitions

  • runtime directory: By default this is /kb/runtime.
    This is a directory that contains "bin", "lib", "man", "etc" subdirectories containing third-party software that KBase repositories depend upon. E.g. a perl binary and Perl modules. See the [bootstrap repository][1] for what normally goes here.

  • deployment directory: This is the directory that contains "bin", "lib", "man", "etc" subdirectories for KBase developed code.

  • development directory: This is the directory where new code is written and developed. It is customary for modules to be cloned from the git repository into the modules directory of the development directory. As code is modified, it is pushed back to the git repository.

[1] : https://git.kbase.us/bootstrap.git/ "bootstrap repository"

dev_container's People

Contributors

brettin avatar brettinanl avatar cshenry avatar danielolson5 avatar devoid avatar gingi avatar gkora avatar hackbob avatar indiagordon avatar kkellerlbl avatar landml avatar mlhenderson avatar mmundy42 avatar mrcreosote avatar nlharris avatar olsonanl avatar rdolson avatar scanon avatar sjyoo avatar

Watchers

avatar avatar avatar avatar avatar

Forkers

olsonanl bdklahn kscgl

dev_container's Issues

Specify what the "deployment directory" is, and where a developer might want to have/put that.

I can see that it should be writable, and what directories might be found in it.

I might assume it is where some integrated/generated stuff might end up, maybe at/near the end of the dev workflow process, available for the deployed backend service.

But where does it make sense for a developer to create or mount such a directory? There are no "/kb/deployment" example references available (see other Issues) from this repo at this time, to give a person a hint.

Is it related to the KB_TOP path, in the container sif?

Singularity> less bootstrap
Singularity> echo $KB_TOP 
/opt/p3/deployment

Is the developer's "writable" deployment directory meant to fully instantiate that (stack over, clobber, replace . . .), or does it augment stuff in KB_TOP?

specify which directory is the "development directory"

It looks like the clone of this dev_container repo directory (files in the working tree) are assumed to be(come) the "development directory" referenced later (then defined at the end).

It makes it a little ambiguous and confusing when a "modules" directory is referenced later, and to understand what exactly needs to be done.

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.