2014-10-02 17:37:41 +00:00
|
|
|
# podex
|
|
|
|
|
|
|
|
|
|
## Description
|
|
|
|
|
|
|
|
|
|
`podex` is a command line tool to bootstrap a kubernetes container manifests from docker image metadata.
|
|
|
|
|
|
|
|
|
|
Manifests can then be edited by a human to match deployment needs.
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
```
|
2015-02-04 19:25:20 +00:00
|
|
|
$ podex [-format json|yaml] [-type=pod|container] [-name PODNAME] IMAGES...
|
2014-10-23 12:26:17 +00:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Options
|
2015-02-04 19:25:20 +00:00
|
|
|
- `format`: manifest format to output, `yaml` (default) or `json`
|
|
|
|
|
- `json`: manifest type to output, `pod` (default) or `container`
|
|
|
|
|
- `name`: manifest name (required with multiple images, optional with single image: default to image base name)
|
2014-10-23 12:26:17 +00:00
|
|
|
|
|
|
|
|
### Examples
|
|
|
|
|
```
|
2015-02-04 19:31:54 +00:00
|
|
|
$ podex google/nodejs-hello > pod.yaml
|
|
|
|
|
$ podex -format json -type container -name nodejs-nginx google/nodejs-hello nginx > container.json
|
2014-10-02 17:37:41 +00:00
|
|
|
```
|
2014-10-22 00:04:01 +00:00
|
|
|
|
|
|
|
|
## TODOs
|
|
|
|
|
- [ ] option to merge multiple container manifest into one pod
|
|
|
|
|
- [ ] docker run flags support
|
|
|
|
|
- [ ] option to generate service bindings from links
|
