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

Commit

Permalink
Merge pull request #781 from cdrage/update-docs-cli
Browse files Browse the repository at this point in the history
Remove lifecycle for updated CLI doc
  • Loading branch information
cdrage committed Aug 9, 2016
2 parents 91386b0 + 4bcc684 commit 76b1c93
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 46 deletions.
9 changes: 4 additions & 5 deletions README.md
Expand Up @@ -44,11 +44,10 @@ This README contains some high level overview information on Atomic App. The det
4. [Marathon](docs/providers/marathon/overview.md)
4. [CLI](docs/cli.md)
5. [Nulecule file](docs/nulecule.md)
6. [Atomic App lifecycle](docs/atomicapp_lifecycle.md)
7. [File handling](docs/file_handling.md)
8. [Specification coverage](docs/spec_coverage.md)
9. [Contributing](CONTRIBUTING.md)
10. [Dependencies](docs/requirements.md)
6. [File handling](docs/file_handling.md)
7. [Specification coverage](docs/spec_coverage.md)
8. [Contributing](CONTRIBUTING.md)
9. [Dependencies](docs/requirements.md)


## Getting started
Expand Down
41 changes: 0 additions & 41 deletions docs/atomicapp_lifecycle.md

This file was deleted.

60 changes: 60 additions & 0 deletions docs/cli.md
@@ -1,5 +1,65 @@
# Atomic App Command Line Interface (CLI)

The Atomic App software allows for several actions to be applied to
specified applications. The four actions that exist today are briefly
described below.

## CLI Commands

`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.

`init`
----------
Initialize a directory with an example Atomic App application using
the `centos/httpd` container image. This is a templated file structure including
Docker and Kubernetes artifact examples.

`index`
---------
Use an `index.yaml` file located within `~/.atomicapp/index.yaml` for outputting a
series of featured Nuleculized applications

```
ID VER PROVIDERS LOCATION
postgresql-atomicapp 1.0.0 {D,O,K} docker.io/projectatomic/postgresql-centos7-atomicapp
flask_redis_nulecule 0.0.1 {D,K} docker.io/projectatomic/flask-redis-centos7-atomicapp
redis-atomicapp 0.0.1 {D,O,K} docker.io/projectatomic/redis-centos7-atomicapp
...
```

`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. This is the same for all providers.

`run`
-----
Will 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`
------
Will 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. |

## Providers

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

0 comments on commit 76b1c93

Please sign in to comment.