Skip to content
This repository has been archived by the owner on Jan 19, 2018. It is now read-only.

[Do Not Merge] Adds Atomic App lifecycle definition. Closes #290 #308

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
58 changes: 58 additions & 0 deletions docs/atomicapp_lifecycle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
Atomicapp Lifecycle Definition
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pls review regarding branding.. Atomic App or atomicapp

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

which one is it? Is there a place this is all defined?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no, maybe, we have define that we call it 'Atomic App' if we are talking about the project in a more marketingish context and 'atomicapp' if it comes to source and technical stuff...

==============================

`fetch`
-------
Will download and combine artifacts from the target application and any
dependent applications including sample answers.conf file into a local
directory for inspection and/or modification. Same for all providers.


`install`
---------
Peform actions to prepare application to run. Performs validation
of Nulecule as well as some provider specific implementation:

| Provider | Implementation |
| ------------- | -------------- |
| Docker | Run the command embedded in the INSTALL label in the container image. |
| Kubernetes | Deploy artifacts to Kubernetes with replica count = 0 |
| Openshift | Deploy artifacts to Openshift with replica count = 0 OR Upload template if artifact is a template. |


`run`
-----
Run an application. Provider specific implementation:

| Provider | Implementation |
| ------------- | -------------- |
| Docker | Run requested containers on local machine. |
| Kubernetes | Increase replica count from 0 to >0. |
| Openshift | Increase replica count from 0 to >0 OR Instantiate template. |

`stop` - (opposite of `run`)
----------------------------
Stop an application. Provider specific implementation:

| Provider | Implementation |
| ------------- | -------------- |
| Docker | Stop requested containers on local machine. |
| Kubernetes | Decrease replica counts to 0. |
| Openshift | Decrease replica counts to 0. |


`uninstall` - (opposite of `install`)
-------------------------------------
Remove deployment configuration from platform. Provider specific implementation:

| Provider | Implementation |
| ------------- | -------------- |
| Docker | Run the command embedded in the UNINSTALL label in the container image. |
| Kubernetes | Remove artifacts from Kubernetes. |
| Openshift | Remove artifacts from Openshift. Delete template from openshift. |


`clean` - (opposite of `fetch`)
-------------------------------
Remove artifacts files from local system and clean up directory. Same for all providers.