|
1 | 1 | # Atomic App Command Line Interface (CLI) |
2 | 2 |
|
| 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 | + |
3 | 63 | ## Providers |
4 | 64 |
|
5 | 65 | Providers may be specified using the `answers.conf` file or the `--provider <provider>` option. |
|
0 commit comments