Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch references from libpod.conf to containers.conf #7009

Merged
merged 1 commit into from
Jul 21, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .cirrus.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ env:
SPECIALMODE: "none" # don't do anything special
TEST_REMOTE_CLIENT: 'false' # don't test remote client by default
ADD_SECOND_PARTITION: 'false' # will certainly fail inside containers
MOD_LIBPOD_CONF: 'true' # Update libpod.conf runtime if required by OS environment
MOD_CONTAINERS_CONF: 'true' # Update containers.conf runtime if required by OS environment

####
#### Credentials and other secret-sauces, decrypted at runtime when authorized.
Expand Down Expand Up @@ -286,7 +286,7 @@ build_each_commit_task:
memory: "8Gb"

env:
MOD_LIBPOD_CONF: 'false'
MOD_CONTAINERS_CONF: 'false'

timeout_in: 30m

Expand Down Expand Up @@ -318,7 +318,7 @@ build_without_cgo_task:
memory: "8Gb"

env:
MOD_LIBPOD_CONF: 'false'
MOD_CONTAINERS_CONF: 'false'

timeout_in: 30m

Expand Down Expand Up @@ -512,7 +512,7 @@ special_testing_in_podman_task:

env:
ADD_SECOND_PARTITION: 'true'
MOD_LIBPOD_CONF: 'false' # Use existing/native setup
MOD_CONTAINERS_CONF: 'false' # Use existing/native setup
SPECIALMODE: 'in_podman' # See docs

timeout_in: 60m
Expand Down
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,7 @@ clean: ## Clean artifacts
libpod/container_easyjson.go \
libpod/pod_easyjson.go \
docs/build
make -C docs clean

.PHONY: libpodimage
libpodimage: ## Build the libpod image
Expand Down
2 changes: 1 addition & 1 deletion cmd/podman/registry/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ func newPodmanConfig() {

// setXdgDirs ensures the XDG_RUNTIME_DIR env and XDG_CONFIG_HOME variables are set.
// containers/image uses XDG_RUNTIME_DIR to locate the auth file, XDG_CONFIG_HOME is
// use for the libpod.conf configuration file.
// use for the containers.conf configuration file.
func setXdgDirs() error {
if !rootless.IsRootless() {
return nil
Expand Down
2 changes: 1 addition & 1 deletion cmd/podman/system/renumber.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ var (
podman system renumber
Migrate lock numbers to handle a change in maximum number of locks.
Mandatory after the number of locks in libpod.conf is changed.
Mandatory after the number of locks in containers.conf is changed.
`

renumberCommand = &cobra.Command{
Expand Down
4 changes: 2 additions & 2 deletions cni/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ directory just contains an example configuration that can be used as the
basis for your own configuration.

To use this configuration, place it in `/etc/cni/net.d` (or the directory
specified by `cni_config_dir` in your `libpod.conf`).
specified by `cni_config_dir` in your `containers.conf`).

For example a basic network configuration can be achieved with:

Expand All @@ -14,4 +14,4 @@ sudo mkdir -p /etc/cni/net.d
curl -qsSL https://raw.githubusercontent.com/containers/libpod/master/cni/87-podman-bridge.conflist | sudo tee /etc/cni/net.d/87-podman-bridge.conf
```

Dependent upon your CNI configuration, you will need to install as a minimum the `port` and `bridge` [CNI plugins](https://github.com/containernetworking/plugins) into `/opt/cni/bin` (or the directory specified by `cni_plugin_dir` in libpod.conf). Please refer to the [CNI](https://github.com/containernetworking) project page in GitHub for more information.
Dependent upon your CNI configuration, you will need to install as a minimum the `port` and `bridge` [CNI plugins](https://github.com/containernetworking/plugins) into `/opt/cni/bin` (or the directory specified by `cni_plugin_dir` in containers.conf). Please refer to the [CNI](https://github.com/containernetworking) project page in GitHub for more information.
114 changes: 0 additions & 114 deletions docs/source/markdown/libpod.conf.5.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/source/markdown/podman-attach.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ or name, either to view its ongoing output or to control it interactively.
You can detach from the container (and leave it running) using a configurable key sequence. The default
sequence is `ctrl-p,ctrl-q`.
Configure the keys sequence using the **--detach-keys** option, or specifying
it in the **libpod.conf** file: see **libpod.conf(5)** for more information.
it in the **containers.conf** file: see **containers.conf(5)** for more information.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably should add container.conf(5) to the bottom of this page.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done


## OPTIONS
**--detach-keys**=*sequence*
Expand Down Expand Up @@ -55,4 +55,4 @@ $ podman attach 1234
$ podman attach --no-stdin foobar
```
## SEE ALSO
podman(1), podman-exec(1), podman-run(1)
podman(1), podman-exec(1), podman-run(1), containers.conf(5)
8 changes: 4 additions & 4 deletions docs/source/markdown/podman-create.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ detached container with **podman attach**.
When attached in the tty mode, you can detach from the container (and leave it
running) using a configurable key sequence. The default sequence is `ctrl-p,ctrl-q`.
Configure the keys sequence using the **--detach-keys** option, or specifying
it in the **libpod.conf** file: see **libpod.conf(5)** for more information.
it in the **containers.conf** file: see **containers.conf(5)** for more information.

**--detach-keys**=*sequence*

Expand Down Expand Up @@ -741,7 +741,7 @@ Security Options
- `seccomp=unconfined` : Turn off seccomp confinement for the container
- `seccomp=profile.json` : White listed syscalls seccomp Json file to be used as a seccomp filter

Note: Labeling can be disabled for all containers by setting label=false in the **libpod.conf** (`/etc/containers/libpod.conf`) file.
Note: Labeling can be disabled for all containers by setting label=false in the **containers.conf** (`/etc/containers/containers.conf` or `$HOME/.config/containers/containers.conf`) file.

**--shm-size**=*size*

Expand Down Expand Up @@ -989,7 +989,7 @@ where source dir is mounted on) has to have right propagation properties. For
shared volumes, source mount point has to be shared. And for slave volumes,
source mount has to be either shared or slave. <sup>[[1]](#Footnote1)</sup>

If you want to recursively mount a volume and all of it's submounts into a
If you want to recursively mount a volume and all of its submounts into a
container, then you can use the `rbind` option. By default the bind option is
used, and submounts of the source directory will not be mounted into the
container.
Expand Down Expand Up @@ -1150,7 +1150,7 @@ b
NOTE: Use the environment variable `TMPDIR` to change the temporary storage location of downloaded container images. Podman defaults to use `/var/tmp`.

## SEE ALSO
**subgid**(5), **subuid**(5), **libpod.conf**(5), **systemd.unit**(5), **setsebool**(8), **slirp4netns**(1), **fuse-overlayfs**(1).
**subgid**(5), **subuid**(5), **containers.conf**(5), **systemd.unit**(5), **setsebool**(8), **slirp4netns**(1), **fuse-overlayfs**(1).

## HISTORY
October 2017, converted from Docker documentation to Podman by Dan Walsh for Podman <dwalsh@redhat.com>
Expand Down
4 changes: 2 additions & 2 deletions docs/source/markdown/podman-events.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ podman\-events - Monitor Podman events

Monitor and print events that occur in Podman. Each event will include a timestamp,
a type, a status, name (if applicable), and image (if applicable). The default logging
mechanism is *journald*. This can be changed in libpod.conf by changing the `events_logger`
mechanism is *journald*. This can be changed in containers.conf by changing the `events_logger`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably should add container.conf(5) to the bottom of this page.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

value to `file`. Only `file` and `journald` are accepted. A `none` logger is also
available but this logging mechanism completely disables events; nothing will be reported by
`podman events`.
Expand Down Expand Up @@ -150,7 +150,7 @@ $ podman events --format json
```

## SEE ALSO
podman(1)
podman(1), containers.conf(5)

## HISTORY
March 2019, Originally compiled by Brent Baude <bbaude@redhat.com>
10 changes: 5 additions & 5 deletions docs/source/markdown/podman-run.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ Specify the key sequence for detaching a container; _sequence_ is a comma-delimi
in which each item can be a single character from the [a-Z] range,
or **ctrl**-_value_, where _value_ is one of: **a-z** or **@^[,_**.

This option can also be set in **libpod.conf**(5) file.
This option can also be set in **containers.conf**(5) file.

Specifying "" will disable this feature. The default is **ctrl-p,ctrl-q**.

Expand Down Expand Up @@ -759,7 +759,7 @@ Security Options
- **seccomp=unconfined**: Turn off seccomp confinement for the container
- **seccomp**=_profile.json_: Allowed syscall list seccomp JSON file to be used as a seccomp filter

Note: Labeling can be disabled for all containers by setting **label=false** in the **libpod.conf**(5) file.
Note: Labeling can be disabled for all containers by setting **label=false** in the **containers.conf**(5) file.

**--shm-size**=_number_[_unit_]

Expand Down Expand Up @@ -1255,8 +1255,8 @@ $ podman run -p 8080:80 -d -i -t fedora/httpd

To mount a host directory as a container volume, specify the absolute path to
the directory and the absolute path for the container directory separated by a
colon. If the source is a named volume maintained by Podman, it's recommended to
use it's name rather than the path to the volume. Otherwise the volume will be
colon. If the source is a named volume maintained by Podman, it is recommended to
use its name rather than the path to the volume. Otherwise the volume will be
considered as an orphan and wiped if you execute **podman volume prune**:

```
Expand Down Expand Up @@ -1426,7 +1426,7 @@ b
NOTE: Use the environment variable `TMPDIR` to change the temporary storage location of downloaded container images. Podman defaults to use `/var/tmp`.

## SEE ALSO
**subgid**(5), **subuid**(5), **libpod.conf**(5), **systemd.unit**(5), **setsebool**(8), **slirp4netns**(1), **fuse-overlayfs**(1).
**subgid**(5), **subuid**(5), **containers.conf**(5), **systemd.unit**(5), **setsebool**(8), **slirp4netns**(1), **fuse-overlayfs**(1).

## HISTORY
September 2018, updated by Kunal Kushwaha <kushwaha_kunal_v7@lab.ntt.co.jp>
Expand Down
2 changes: 1 addition & 1 deletion docs/source/markdown/podman-system-migrate.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ This can be used after a system upgrade which changes the default OCI runtime to
There are no guarantees that the containers will continue to work under the new runtime, as some runtimes support differing options and configurations.

## SEE ALSO
`podman(1)`, `libpod.conf(5)`, `usermod(8)`
`podman(1)`, `containers.conf(5)`, `usermod(8)`

## HISTORY
April 2019, Originally compiled by Giuseppe Scrivano (gscrivan at redhat dot com)
6 changes: 3 additions & 3 deletions docs/source/markdown/podman-system-renumber.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ podman\-system\-renumber - Migrate lock numbers to handle a change in maximum nu
## DESCRIPTION
**podman system renumber** renumbers locks used by containers and pods.

Each Podman container and pod is allocated a lock at creation time, up to a maximum number controlled by the **num_locks** parameter in **libpod.conf**.
Each Podman container and pod is allocated a lock at creation time, up to a maximum number controlled by the **num_locks** parameter in **containers.conf**.

When all available locks are exhausted, no further containers and pods can be created until some existing containers and pods are removed. This can be avoided by increasing the number of locks available via modifying **libpod.conf** and subsequently running **podman system renumber** to prepare the new locks (and reallocate lock numbers to fit the new struct).
When all available locks are exhausted, no further containers and pods can be created until some existing containers and pods are removed. This can be avoided by increasing the number of locks available via modifying **containers.conf** and subsequently running **podman system renumber** to prepare the new locks (and reallocate lock numbers to fit the new struct).

**podman system renumber** must be called after any changes to **num_locks** - failure to do so will result in errors starting Podman as the number of locks available conflicts with the configured number of locks.

Expand All @@ -20,7 +20,7 @@ When all available locks are exhausted, no further containers and pods can be cr
If possible, avoid calling **podman system renumber** while there are other Podman processes running.

## SEE ALSO
`podman(1)`, `libpod.conf(5)`
`podman(1)`, `containers.conf(5)`

## HISTORY
February 2019, Originally compiled by Matt Heon (mheon at redhat dot com)
Loading