projectatomic/nulecule-library

Name: nulecule-library

Owner: Project Atomic

Description: A set of nulecule-ized applications that can be used for reference or as part of your applications

Created: 2015-10-22 12:15:41.0

Updated: 2018-03-22 10:31:09.0

Pushed: 2016-10-21 14:15:19.0

Homepage: null

Size: 249

Language: null

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Nulecule Library

This library contains a set of working examples of composite container applications. The applications are specified using the Nulecule Specification. This specification allows for reusable components and defines a full multi-container application. You may use the applications for reference or, in some cases, deployment.

These examples are all intended to be used with atomicapp. There is a thorough getting started guide available.

Index
Library format

Files:

Please only include the /artifact directory and the Nulecule, Dockerfile and README.md files in your application.

For example projectatomic/helloapache, only includes the following files:


artifacts
??? docker
?   ??? hello-apache-pod_run
??? kubernetes
?   ??? hello-apache-pod.json
Dockerfile
Nulecule
README.md

The README.md file should contain the following three sections:

  1. Description: What the application does
  2. Deployment: How to deploy the application using the atomic or atomicapp CLIs
  3. Interaction: How to access/use the application after deployment
Generating the index.yaml for atomicapp index list commands

In order to generate a Docker-compatible image for an Atomic App library index. Use the following steps:

icapp index generate .
er build -t $USER/index .
Contributing

Feel free to open a PR if you wish to contribute to the nulecule-library! We accept all kind of applications.

Communication channels

This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.