From fa249d51bcd3164bed2df820fc77c2032a62e0a3 Mon Sep 17 00:00:00 2001 From: Dusty Mabe Date: Fri, 9 Oct 2015 15:58:19 -0400 Subject: [PATCH] Adds Atomicapp lifecycle definition. Closes #290 --- docs/atomicapp_lifecycle.md | 41 +++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 docs/atomicapp_lifecycle.md diff --git a/docs/atomicapp_lifecycle.md b/docs/atomicapp_lifecycle.md new file mode 100644 index 00000000..3fef59b4 --- /dev/null +++ b/docs/atomicapp_lifecycle.md @@ -0,0 +1,41 @@ +Atomicapp Lifecycle Definition +============================== + +The Atomic App software allows for several actions to be applied to +specified applications. The four actions that exist today are briefly +described below. + +`genanswers` +------------ +Will download and combine artifacts from the target application in a +temporary directory and then take the generated sample answers.conf +file and populate it in the users working directory. The temporary +directory is then cleaned up. + +`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. + +`run` +----- +Run an application. + +| Provider | Implementation | +| ------------- | -------------- | +| Docker | Run application containers on local machine. | +| Kubernetes | Run requested application in kubernetes target environment. | +| Openshift | Run requested application in OpenShift target environment. | +| Marathon | Run requested application in Marathon target environment. | + +`stop` +------ +Stop an application. + +| Provider | Implementation | +| ------------- | -------------- | +| Docker | Stop application containers on local machine. | +| Kubernetes | Stop requested application in kubernetes target environment. | +| Openshift | Stop requested application in OpenShift target environment. | +| Marathon | Stop requested application in Marathon target environment. |