github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-22 11:21:47 +00:00
Code Issues Projects Releases Wiki Activity

contrib/podex: update README

Browse Source 
update usage
This commit is contained in:
Johan Euphrosine 2015-02-04 11:25:20 -08:00
parent b852cd2c80
commit 83638fdcf3
1 changed files with 6 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
contrib/podex/README.md
View File

@ -8,25 +8,22 @@ Manifests can then be edited by a human to match deployment needs.
## Usage
```
$ podex [-json|-yaml] [-id PODNAME] IMAGES...
$ podex [-format json|yaml] [-type=pod|container] [-name PODNAME] IMAGES...
$ podex -json [-id PODNAME] IMAGES... > pod.json
$ podex -yaml [-id PODNAME] IMAGES... > pod.yaml
```
### Options
- `id`: set the pod name (required with multiple images, optional with single image: default to image base name)
- `json`: puts the container manifest into JSON format
- `yaml`: puts the container manifest into YAML format
- `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)
### Examples
```
$ podex -json google/nodejs-hello > pod.yaml
$ podex -yaml -id nodejs-nginx google/nodejs-hello nginx > pod.yaml
$ podex google/nodejs-hello > pod-manifest.yaml
$ podex -format json -type container -name nodejs-nginx google/nodejs-hello nginx > container-manifest.json
```
## TODOs
- [ ] option generate a full pod manifest (w/ `desired state`)
- [ ] option to merge multiple container manifest into one pod
- [ ] docker run flags support
- [ ] option to generate service bindings from links