Start to write docs

This commit is contained in:
Steve Baker 2017-04-06 15:15:59 +12:00
parent 678a2c19d8
commit 8de699e015
4 changed files with 28 additions and 10 deletions

View File

@ -2,18 +2,35 @@
paunch
===============================
Utility to launch and manage containers using the Kubernetes Pod format
Please fill here a long description which must be at least 3 lines wrapped on
80 cols, so that distribution package maintainers can use it in their packages.
Note that this is a hard requirement.
Utility to launch and manage containers using YAML based configuration data
* Free software: Apache license
* Documentation: http://docs.openstack.org/developer/paunch
* Source: http://git.openstack.org/cgit/openstack/paunch
* Bugs: http://bugs.launchpad.net/tripleo
Features
--------
* TODO
* Single host only, operations are performed via the docker client on the
currently configured docker service.
* Zero external state, only labels on running containers are used when
determining which containers an operation will perform on.
* Single threaded and blocking, containers which are not configured to detach
will halt further configuration until they exit.
* Co-exists with other container configuration tools. Only containers created
by paunch will be modified by paunch. Unique container names are assigned if
the desired name is taken, and containers are renamed when the desired name
becomes available.
* Accessable via the `paunch` command line utility, or by importing python
package `paunch`.
Configuration Format
--------------------
The current format is loosely based on a subset of the `docker-compose v1
format <https://docs.docker.com/compose/compose-file/compose-file-v1/>`_ with
modifications. The intention is for the format to evolve to faithfully
implement existing formats such as the
`Kubernetes Pod format <https://kubernetes.io/docs/concepts/workloads/pods/pod/>`_.

View File

@ -50,7 +50,7 @@ class Apply(Command):
parser.add_argument(
'config_id',
metavar='<config_id>',
help=('Identifier for the config, unique to the service managing '
help=('Identifier for the config, unique to the tool managing '
'the containers'),
)
return parser

View File

@ -19,7 +19,8 @@ from cliff.commandmanager import CommandManager
import paunch
"""Utility to launch and manage containers using the Kubernetes Pod format"""
"""Utility to launch and manage containers using
YAML based configuration data"""
class PaunchApp(App):

View File

@ -1,6 +1,6 @@
[metadata]
name = paunch
summary = Utility to launch and manage containers using the Kubernetes Pod format
summary = Utility to launch and manage containers using YAML based configuration data
description-file =
README.rst
author = OpenStack