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

Commit 4bcc684

Browse files
committed
Remove lifecycle for updated CLI doc
1 parent 8337c16 commit 4bcc684

File tree

3 files changed

+64
-46
lines changed

3 files changed

+64
-46
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,10 @@ This README contains some high level overview information on Atomic App. The det
4444
4. [Marathon](docs/providers/marathon/overview.md)
4545
4. [CLI](docs/cli.md)
4646
5. [Nulecule file](docs/nulecule.md)
47-
6. [Atomic App lifecycle](docs/atomicapp_lifecycle.md)
48-
7. [File handling](docs/file_handling.md)
49-
8. [Specification coverage](docs/spec_coverage.md)
50-
9. [Contributing](CONTRIBUTING.md)
51-
10. [Dependencies](docs/requirements.md)
47+
6. [File handling](docs/file_handling.md)
48+
7. [Specification coverage](docs/spec_coverage.md)
49+
8. [Contributing](CONTRIBUTING.md)
50+
9. [Dependencies](docs/requirements.md)
5251

5352

5453
## Getting started

docs/atomicapp_lifecycle.md

Lines changed: 0 additions & 41 deletions
This file was deleted.

docs/cli.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,65 @@
11
# Atomic App Command Line Interface (CLI)
22

3+
The Atomic App software allows for several actions to be applied to
4+
specified applications. The four actions that exist today are briefly
5+
described below.
6+
7+
## CLI Commands
8+
9+
`genanswers`
10+
------------
11+
Will download and combine artifacts from the target application in a
12+
temporary directory and then take the generated sample answers.conf
13+
file and populate it in the users working directory. The temporary
14+
directory is then cleaned up.
15+
16+
`init`
17+
----------
18+
Initialize a directory with an example Atomic App application using
19+
the `centos/httpd` container image. This is a templated file structure including
20+
Docker and Kubernetes artifact examples.
21+
22+
`index`
23+
---------
24+
Use an `index.yaml` file located within `~/.atomicapp/index.yaml` for outputting a
25+
series of featured Nuleculized applications
26+
27+
```
28+
ID VER PROVIDERS LOCATION
29+
postgresql-atomicapp 1.0.0 {D,O,K} docker.io/projectatomic/postgresql-centos7-atomicapp
30+
flask_redis_nulecule 0.0.1 {D,K} docker.io/projectatomic/flask-redis-centos7-atomicapp
31+
redis-atomicapp 0.0.1 {D,O,K} docker.io/projectatomic/redis-centos7-atomicapp
32+
...
33+
```
34+
35+
`fetch`
36+
-------
37+
Will download and combine artifacts from the target application and any
38+
dependent applications including sample answers.conf file into a local
39+
directory for inspection and/or modification. This is the same for all providers.
40+
41+
`run`
42+
-----
43+
Will run an application.
44+
45+
| Provider | Implementation |
46+
| ------------- | -------------- |
47+
| Docker | Run application containers on local machine. |
48+
| Kubernetes | Run requested application in Kubernetes target environment. |
49+
| Openshift | Run requested application in OpenShift target environment. |
50+
| Marathon | Run requested application in Marathon target environment. |
51+
52+
`stop`
53+
------
54+
Will stop an application.
55+
56+
| Provider | Implementation |
57+
| ------------- | -------------- |
58+
| Docker | Stop application containers on local machine. |
59+
| Kubernetes | Stop requested application in Kubernetes target environment. |
60+
| Openshift | Stop requested application in OpenShift target environment. |
61+
| Marathon | Stop requested application in Marathon target environment. |
62+
363
## Providers
464

565
Providers may be specified using the `answers.conf` file or the `--provider <provider>` option.

0 commit comments

Comments
 (0)