{"id":13990541,"url":"https://github.com/projectatomic/atomicapp","last_synced_at":"2025-07-22T12:33:02.003Z","repository":{"id":29286515,"uuid":"32819266","full_name":"projectatomic/atomicapp","owner":"projectatomic","description":"[UNMAINTAINED] This is the reference implementation of the Nulecule container application Specification: Atomic App","archived":true,"fork":false,"pushed_at":"2017-03-07T10:08:08.000Z","size":2223,"stargazers_count":102,"open_issues_count":103,"forks_count":71,"subscribers_count":15,"default_branch":"master","last_synced_at":"2024-08-09T13:17:29.025Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/projectatomic.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-03-24T19:09:39.000Z","updated_at":"2024-02-12T14:21:27.000Z","dependencies_parsed_at":"2022-09-06T12:52:27.666Z","dependency_job_id":null,"html_url":"https://github.com/projectatomic/atomicapp","commit_stats":null,"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/projectatomic%2Fatomicapp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/projectatomic%2Fatomicapp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/projectatomic%2Fatomicapp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/projectatomic%2Fatomicapp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/projectatomic","download_url":"https://codeload.github.com/projectatomic/atomicapp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227098836,"owners_count":17730645,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-09T13:02:54.035Z","updated_at":"2024-11-29T10:30:52.326Z","avatar_url":"https://github.com/projectatomic.png","language":"Python","readme":"# Atomic App\n\n![](docs/images/logo.png \"Project Atomic\")\n\nAtomic App is a reference implementation of the [Nulecule](docs/spec/README.md) specification. Packaged Atomic App containers are \"Nuleculized\" and each component of the package is a \"Nulecule\".\n\nAtomic App is used to bootstrap packaged container environments and run them on multiple container orchestrators. It is designed from the ground-up to be portable and provider pluggable.\n\n  - __A \"packaged installer\" for all container-based environments and applications.__ Replace all those bash and Ansible scripts with one container-based deployment tool.\n\n  - __Target multiple providers:__ Specify the provider you want the Atomic App to run on. It supports Kubernetes, OpenShift, Mesos+Marathon and Docker.\n\n  - __Inherit already packaged containers:__ Create composite applications by referencing other Nulecule-compliant applications. For example, plugging in an alternative well-orchestrated database in another referenced container image.\n\n  - __Fetch and run entire environments:__ Use `atomicapp fetch` and `atomicapp run` to run pre-packaged Nuleculized containers.\n\n## Installing Atomic App\nFrom Linux:\n```sh\ngit clone https://github.com/projectatomic/atomicapp \u0026\u0026 cd atomicapp\nsudo make install\n```\n\n_or_ \n\nDownload a pre-signed .tar.gz from [download.projectatomic.io](https://download.projectatomic.io) / [GitHub](https://github.com/projectatomic/atomicapp/releases):\n```sh\nexport RELEASE=0.6.4\nwget https://github.com/projectatomic/atomicapp/releases/download/$RELEASE/atomicapp-$RELEASE.tar.gz\ntar -xvf atomicapp-$RELEASE.tar.gz \u0026\u0026 cd atomicapp-$RELEASE\nsudo make install\n```\n\n## Documentation\n\nThis README contains some high level overview information on Atomic App. The detailed documentation for Atomic App resides in the [docs](docs) directory. The index provided conveniently links to each section below:\n\n1. [Quick start](docs/quick_start.md)\n2. [Getting started](docs/start_guide.md)\n3. [Providers](docs/providers.md)\n  1. [Docker](docs/providers/docker/overview.md)\n  2. [Kubernetes](docs/providers/kubernetes/overview.md)\n  3. [OpenShift](docs/providers/openshift/overview.md)\n  4. [Marathon](docs/providers/marathon/overview.md)\n4. [CLI](docs/cli.md)\n5. [Nulecule file](docs/nulecule.md)\n6. [File handling](docs/file_handling.md)\n7. [Specification coverage](docs/spec_coverage.md)\n8. [Contributing](CONTRIBUTING.md)\n9. [Dependencies](docs/requirements.md)\n10. [Specification](docs/spec/README.md)\n\n\n## Getting started\n\nAtomic App can be used either natively on your OS __or__ ran via the [atomic](https://github.com/projectatomic/atomic) command on [Fedora or CentOS Atomic hosts](https://www.projectatomic.io/download/).\n\n__Detailed instructions on [getting started](docs/start_guide.md) are available.__ Alternatively, use the [quick start guide](docs/quick_start.md) to get a Nuleculized application running immediately.\n\nAn extended guide on the `Nulecule` file format is [also available](docs/nulecule.md).\n\n## Real-world examples\nAtomic App can be used to launch a cluster of containers (application servers, databases, etc.).\n\nFor a list of already packaged examples, visit the [nulecule-library](https://github.com/projectatomic/nulecule-library) repo.\n\n## Providers\n\nWe currently support:\n\n  - Docker\n  - Kubernetes\n  - OpenShift 3\n  - Marathon (Mesos)\n\nProviders represent various deployment targets. They can be added by placing the artifact within the respective in `artifacts/` folder. For example, placing `deploy_pod.yml` within `artifacts/kubernetes/`. \n\nFor a detailed description of all providers available see [docs/providers.md](docs/providers.md).\n\n## Contributing to Atomic App\n[![Code Health](https://landscape.io/github/projectatomic/atomicapp/master/landscape.svg?style=flat)](https://landscape.io/github/projectatomic/atomicapp/master)\n[![Build Status](https://travis-ci.org/projectatomic/atomicapp.svg?branch=master)](https://travis-ci.org/projectatomic/atomicapp)\n[![Coverage Status](https://coveralls.io/repos/projectatomic/atomicapp/badge.svg?branch=master\u0026service=github)](https://coveralls.io/github/projectatomic/atomicapp?branch=master)\n\nFirst of all, awesome! We have [a development guide to help you get started!](CONTRIBUTING.md)\n\nIf you have any issues or get stuck, feel free to open a GitHub issue or reach us at our communication channels (see below).\n\n## Dependencies\n\nSee [REQUIREMENTS.md](docs/requirements.md) for a list of current Atomic App dependencies.\n\n## Specification\n\nWant to view the specification and contribute to changes? See the [Nulecule spec](docs/spec/README.MD) for more information.\n\n## Communication channels\n\n* IRC: __#nulecule__ on irc.freenode.net\n* Mailing List: [container-tools@redhat.com](https://www.redhat.com/mailman/listinfo/container-tools)\n* Weekly IRC Nulecule meeting: Monday's @ 0930 EST / 0130 UTC\n* Weekly SCRUM Container-Tools meeting: Wednesday's @ 0830 EST / 1230 UTC on [Bluejeans](https://bluejeans.com/381583203/)\n\n## Copyright\n\nCopyright (C) 2016 Red Hat Inc.\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU Lesser General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU Lesser General Public License for more details.\n\nYou should have received a copy of the GNU Lesser General Public License\nalong with this program. If not, see \u003chttp://www.gnu.org/licenses/\u003e.\n\nThe GNU Lesser General Public License is provided within the file lgpl-3.0.txt.\n","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprojectatomic%2Fatomicapp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprojectatomic%2Fatomicapp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprojectatomic%2Fatomicapp/lists"}