diff options
| -rw-r--r-- | CONTRIBUTING.md | 2 | ||||
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | docs/podman-build.1.md | 6 | ||||
| -rw-r--r-- | docs/podman-commit.1.md | 2 | ||||
| -rw-r--r-- | docs/podman-create.1.md | 6 | ||||
| -rw-r--r-- | docs/podman-logout.1.md | 2 | ||||
| -rw-r--r-- | docs/podman-logs.1.md | 2 | ||||
| -rw-r--r-- | docs/podman-ps.1.md | 2 | ||||
| -rw-r--r-- | docs/podman-run.1.md | 6 | ||||
| -rw-r--r-- | hooks.md | 1 | ||||
| -rw-r--r-- | install.md | 3 | ||||
| -rw-r--r-- | transfer.md | 2 |
12 files changed, 19 insertions, 17 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c121ac416..bf69cfdab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,7 +29,7 @@ Please don't include any private/sensitive information in your issue! ## Submitting Pull Requests No Pull Request (PR) is too small! Typos, additional comments in the code, -new testcases, bug fixes, new features, more documentation, ... it's all +new test cases, bug fixes, new features, more documentation, ... it's all welcome! While bug fixes can first be identified via an "issue", that is not required. @@ -8,7 +8,7 @@ libpod provides a library for applications looking to use the Container Pod concept popularized by Kubernetes. libpod also contains a tool podman, which allows you to manage Pods, Containers, and Container Images. -At a high level, we expect the scope of libpod/podman to the following functionalities: +At a high level, we expect the scope of libpod/podman to be the following: * Support multiple image formats including the existing Docker/OCI image formats. * Support for multiple means to download images including trust & image verification. diff --git a/docs/podman-build.1.md b/docs/podman-build.1.md index 6ca22678a..4df25603a 100644 --- a/docs/podman-build.1.md +++ b/docs/podman-build.1.md @@ -65,11 +65,11 @@ commands specified by the **RUN** instruction. **--runtime-flag** *flag* -Adds global flags for the container rutime. +Adds global flags for the container runtime. -**--signature-policy** *signaturepolicy* +**--signature-policy** *signature-policy-file* -Pathname of a signature policy file to use. It is not recommended that this +Path name of a signature policy file to use. It is not recommended that this option be used, as the default behavior of using the system-wide default policy (frequently */etc/containers/policy.json*) is most often preferred. diff --git a/docs/podman-commit.1.md b/docs/podman-commit.1.md index 001c37daf..2eee4fe3d 100644 --- a/docs/podman-commit.1.md +++ b/docs/podman-commit.1.md @@ -57,7 +57,7 @@ Storing signatures ``` ``` -# podman commit --message "commiting container to image" reverent_golick image-commited +# podman commit --message "committing container to image" reverent_golick image-commited Getting image source signatures Copying blob sha256:b41deda5a2feb1f03a5c1bb38c598cbc12c9ccd675f438edc6acd815f7585b86 25.80 MB / 25.80 MB [======================================================] 0s diff --git a/docs/podman-create.1.md b/docs/podman-create.1.md index 10a790f4a..f40b73317 100644 --- a/docs/podman-create.1.md +++ b/docs/podman-create.1.md @@ -9,7 +9,7 @@ podman create - Create a new container ## DESCRIPTION -Creates a writeable container layer over the specified image and prepares it for +Creates a writable container layer over the specified image and prepares it for running the specified command. The container ID is then printed to STDOUT. This is similar to **podman run -d** except the container is never started. You can then use the **podman start <container_id>** command to start the container at @@ -253,7 +253,7 @@ millions of trillions. **--link-local-ip**=[] Add one or more link-local IPv4/IPv6 addresses to the container's interface -**--log-driver**="*json-file*|*syslog*|*journald*|*gelf*|*fluentd*|*awslogs*|*splunk*|*etwlogs*|*gcplogs*|*none*" +**--log-driver**="*json-file*" Logging driver for the container. Default is defined by daemon `--log-driver` flag. **Warning**: the `podman logs` command works only for the `json-file` and `journald` logging drivers. @@ -350,7 +350,7 @@ This is because by default a container is not allowed to access any devices. A “privileged” container is given access to all devices. When the operator executes **podman run --privileged**, podman enables access -to all devices on the host as well as set turn off most of the security messurs +to all devices on the host as well as set turn off most of the security measures protecting the host from the container. **-p**, **--publish**=[] diff --git a/docs/podman-logout.1.md b/docs/podman-logout.1.md index d6281500b..92abaa22e 100644 --- a/docs/podman-logout.1.md +++ b/docs/podman-logout.1.md @@ -14,7 +14,7 @@ podman logout - Logout of a container registry ## DESCRIPTION **podman logout** logs out of a specified registry server by deleting the cached credentials -stored in the **auth.json** file. The path of the authentication file can be overrriden by the user by setting the **authfile** flag. +stored in the **auth.json** file. The path of the authentication file can be overridden by the user by setting the **authfile** flag. The default path used is **${XDG\_RUNTIME_DIR}/containers/auth.json**. All the cached credentials can be removed by setting the **all** flag. diff --git a/docs/podman-logs.1.md b/docs/podman-logs.1.md index 8b8c755b9..414b98b8c 100644 --- a/docs/podman-logs.1.md +++ b/docs/podman-logs.1.md @@ -23,7 +23,7 @@ Show logs since TIMESTAMP **--tail=LINES** -Ouput the specified number of LINES at the end of the logs. LINES must be a positive integer. Defaults to 0, which prints all lines +Output the specified number of LINES at the end of the logs. LINES must be a positive integer. Defaults to 0, which prints all lines ## EXAMPLE diff --git a/docs/podman-ps.1.md b/docs/podman-ps.1.md index 11c3aabaf..90f16d9a9 100644 --- a/docs/podman-ps.1.md +++ b/docs/podman-ps.1.md @@ -10,7 +10,7 @@ podman ps - Prints out information about containers [**--all**|**-a**] [**--no-trunc**] [**--quiet**|**-q**] -[**--fromat**] +[**--format**] [**--help**|**-h**] ## DESCRIPTION diff --git a/docs/podman-run.1.md b/docs/podman-run.1.md index 8a36bf425..7290a5bd5 100644 --- a/docs/podman-run.1.md +++ b/docs/podman-run.1.md @@ -252,7 +252,7 @@ millions of trillions. **--link-local-ip**=[] Add one or more link-local IPv4/IPv6 addresses to the container's interface -**--log-driver**="*json-file*|*syslog*|*journald*|*gelf*|*fluentd*|*awslogs*|*splunk*|*etwlogs*|*gcplogs*|*none*" +**--log-driver**="*json-file*" Logging driver for the container. Default is defined by daemon `--log-driver` flag. **Warning**: the `podman logs` command works only for the `json-file` and `journald` logging drivers. @@ -349,7 +349,7 @@ This is because by default a container is not allowed to access any devices. A “privileged” container is given access to all devices. When the operator executes **podman run --privileged**, podman enables access -to all devices on the host as well as set turn off most of the security messurs +to all devices on the host as well as set turn off most of the security measures protecting the host from the container. **-p**, **--publish**=[] @@ -529,7 +529,7 @@ Use `df <source-dir>` to figure out the source mount and then use `findmnt -o TARGET,PROPAGATION <source-mount-dir>` to figure out propagation properties of source mount. If `findmnt` utility is not available, then one can look at mount entry for source mount point in `/proc/self/mountinfo`. Look -at `optional fields` and see if any propagaion properties are specified. +at `optional fields` and see if any propagation properties are specified. `shared:X` means mount is `shared`, `master:X` means mount is `slave` and if nothing is there that means mount is `private`. @@ -53,6 +53,7 @@ type HookParams struct { Cmds []string `json:"cmds"` Annotations []string `json:"annotations"` HasBindMounts bool `json:"hasbindmounts"` + Arguments []string `json:"arguments"` } ``` diff --git a/install.md b/install.md index 0973088d1..535e5b137 100644 --- a/install.md +++ b/install.md @@ -27,6 +27,7 @@ Fedora, CentOS, RHEL, and related distributions: yum install -y \ btrfs-progs-devel \ conmon \ + containernetworking-cni \ device-mapper-devel \ git \ glib2-devel \ @@ -72,7 +73,7 @@ If using an older release or a long-term support release, be careful to double-c **NOTE** -Be careful to double-check that the version of golang is new enough, version 1.8.x or higher is required. If needed, golang kits are avaliable at https://golang.org/dl/ +Be careful to double-check that the version of golang is new enough, version 1.8.x or higher is required. If needed, golang kits are available at https://golang.org/dl/ **Optional** diff --git a/transfer.md b/transfer.md index 101140905..30e277a86 100644 --- a/transfer.md +++ b/transfer.md @@ -81,7 +81,7 @@ Those Docker commands currently do not have equivalents in `podman`: | `docker image` || | `docker network` || | `docker node` || -| `docker plugin` |podman does not support plugins. We recommend you use alternative OCI Runtimes or OCI Runtime Hooks to alter behaviour of podman.| +| `docker plugin` |podman does not support plugins. We recommend you use alternative OCI Runtimes or OCI Runtime Hooks to alter behavior of podman.| | `docker port` || | `docker rename` | podman does not support rename, you need to use `podman rm` and `podman create` to rename a container.| | `docker restart` | podman does not support restart. We recommend that you put your podman containers into a systemd unit file and use it for restarting applications.| |