docs: make options table more consistent #2231
Conversation
|
Lots of tables to change 😦 |
| | `--interactive` | `false` | `true` or `false` | Run pod interactively. If true, only one image may be supplied. | | ||
| | `--mds-register` | `false` | `true` or `false` | Register pod with metadata service. It needs network connectivity to the host (`--net` as `default`, `default-restricted`, or `host`). | | ||
| | `--memory` | none | Memory units (ex. `--memory=50M`) | Memory limit for the preceding image in [Kubernetes resource model](http://kubernetes.io/v1.1/docs/design/resources.html) format. | | ||
| | `--mount` | none | Mount syntax (ex. `volume=NAME,target=PATH`) | Mount point binding a volume to a path within an app. See [Mounting Volumes without Mount Points](#mounting-volumes-without-mount-points). | |
There was a problem hiding this comment.
Double-dash missing:
ex.
--volume=NAME,target=PATH
There was a problem hiding this comment.
oh, actually that was correct. I was confused because it didn't repeat the option like in other example.
If there is enough place, --mount volume=NAME,target=PATH would be better.
|
Similar changes should be done in Documentation/subcommands/prepare.md |
| | `--stage1-path` | none | Absolute or relative path | A path to a stage1 image. Absolute and relative paths are supported. | | ||
| | `--stage1-name` | none | Image name | A name of a stage1 image. Will perform a discovery if the image is not in the store. | | ||
| | `--stage1-hash` | none | Image hash | A hash of a stage1 image. The image must exist in the store. | | ||
| | `--stage1-from-dir` | none | Image name | A stage1 image file name to search for inside the default stage1 images directory. | |
There was a problem hiding this comment.
Example:
--stage1-from-dir=stage1-coreos.aci
|
@iaguis do you mean that this table is repeated, or that the same inconsistencies fixed here are represented elsewhere? |
|
Addressed feedback. I updated prepare.md with the same content as run.md when the options matched. |
| | `--no-overlay` | `false` | `true` or `false` | Disable the overlay filesystem. | | ||
| | `--no-store` | `false` | `true` or `false` | Fetch images, ignoring the local store. See [image fetching behavior](../image-fetching-behavior.md) | | ||
| | `--pod-manifest` | none | A path | The path to the pod manifest. If it's non-empty, then only `--net`, `--no-overlay` and `--interactive` will have effect. | | ||
| | `--port` | none | A port number (ex. `--port=NAME:HOSTPORT`) | Ports to expose on the host (requires [contained network](https://github.com/coreos/rkt/blob/master/Documentation/networking.md#contained-mode)). | |
There was a problem hiding this comment.
Does the link to networking.md need to be fully qualified? I think that just ../networking.md#contained-mode is enough.
|
@robszumski ping |
|
@alban ack, need to find some time to complete this |
|
Needs rebase. |
|
Rebased, will squash after any last feedback |
| | `--private-users` | `false` | `true` or `false` | Run within user namespaces (experimental) | | ||
| | `--quiet` | `false` | `true` or `false` | Suppress superfluous output on stdout, print only the UUID on success | | ||
| <<<<<<< HEAD |
|
@krnowak fix, rebased, PTAL |
|
LFAD. |
This diff turned out nastier than expected even though the changes aren't that crazy.
This fixes a few problems:
Note that due to the wide nature of this table, it will overflow the bounds of the page on coreos.com on smaller screens. This is not ideal, but at known issue that is ok for now.
cc: @kbrwn