126 Commits

Author SHA1 Message Date
598b93722d Fix instructions about setting storage driver on command-line
The OverlayFS storage driver is called `overlay`, not `overlayfs`.

Signed-off-by: Patrick Reader <_@pxeger.com>
2023-01-01 10:56:46 +00:00
db439dd23e New tool, docs/version-check
Intended to be run from nightly Cirrus cron job.

 1) Queries github for highest-sorting (not necessarily "latest") tag
 2) Checks that the Windows MSI exists, fails if not
 3) Cross-checks markdown files to ensure they have up-to-date links

When run interactively, it will auto-update the .md files
to show and link to the latest version. This makes it easy
for anyone to then submit an update PR.

And, it turns out that MSI is obsolete, the new thing is EXE.
Update the tutorials to reflect that.

Signed-off-by: Ed Santiago <santiago@redhat.com>
2022-11-10 08:54:56 -07:00
b5ee4de8cf [CI:DOCS] Add performance tutorial
Reuse part of the description of --network=host from /docs/source/markdown/podman-run.1.md.in

Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2022-11-09 18:39:26 +01:00
84ed9bd5e3 Fix small typo
Signed-off-by: Johan Van de Wauw <johan@gisky.be>
2022-10-19 07:00:18 +02:00
1e16668ecc Merge pull request #15173 from carljmosca/main
[CI:DOCS] added docs for installing certificate authority
2022-09-16 16:58:48 +02:00
2c63b8439b Fix stutters
Podman adds an Error: to every error message.  So starting an error
message with "error" ends up being reported to the user as

Error: error ...

This patch removes the stutter.

Also ioutil.ReadFile errors report the Path, so wrapping the err message
with the path causes a stutter.

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2022-09-10 07:52:00 -04:00
bd0a8c1462 added docs for installing certficate authority
Co-authored-by: Tom Sweeney <tsweeney@redhat.com>
Signed-off-by: Carl J. Mosca <carljmosca@gmail.com>
2022-08-13 09:19:44 -04:00
f26a5246e3 Fix updated link to install instructions
Signed-off-by: William Entriken <github.com@phor.net>
2022-08-11 20:34:59 -04:00
f4c53a41cf docs: update the podman logo
for podman/#15222

Signed-off-by: unknowndevQwQ <unknowndevQwQ@pm.me>
2022-08-07 09:11:53 +08:00
0bf6ee61dd Merge pull request #15087 from eriksjolund/socket_activation.md_clarify_delay
[CI:DOCS] socket_activation.md: Add start/stop sections
2022-07-27 13:10:13 +02:00
7fab449e32 [CI:DOCS] socket_activation.md: Add start/stop sections
* Add section "Starting a socket-activated service".

* Add section "Stopping a socket-activated service".

* Clarify in the diagrams that socket activation
  only happens for the first client connection.

Co-authored-by: Valentin Rothberg <vrothberg@redhat.com>
Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2022-07-27 10:41:10 +02:00
cbdda4e56e docs: remove CNI word where it is not applicable
Most network commands/features work with both netavark and CNI. When
we added added netavark most docs were not vetted and thus still use CNI
network, it should just say network.

Fixes #14990

Signed-off-by: Paul Holzinger <pholzing@redhat.com>
2022-07-22 13:46:28 +02:00
c9722c0b16 [CI:DOCS] socket_activation.md: fix typo and layout
Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2022-07-16 06:41:57 +02:00
b4c09bef66 Merge pull request #14909 from eriksjolund/add_socket_activation_tutorial
[CI:DOCS] Add socket_activation.md
2022-07-15 09:36:28 +00:00
8e2add7709 [CI:DOCS] Update docs/tutorials/socket_activation.md
Co-authored-by: Valentin Rothberg <vrothberg@redhat.com>
Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2022-07-14 15:20:59 +02:00
2270bc5f96 [CI:DOCS] Add socket activation tutorial
Closes #14908

Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2022-07-14 15:20:52 +02:00
b8a7e275d1 [CI:DOCS] rootless_tutorial: Remove incorrect advice regarding volumes and mount points
* Remove the instruction
  "The mount point must exist in the container"
  as it is incorrect which is shown by this example
  ```
  $ mkdir dir1
  $ podman run --rm -v ./dir1:/dir1:Z docker.io/library/fedora:36 touch /dir1/file
  $ ls dir1
  file
  $ podman run --rm docker.io/library/fedora:36 ls -l /dir1
  ls: cannot access '/dir1': No such file or directory
  $ podman --version
  podman version 4.1.1
  $
  ```

* Rewrite the advice "You should always give the full path to the volume you'd like to mount"
  so that it also mentions relative paths starting with a dot.

Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2022-07-12 16:32:14 +02:00
fe559287c9 docs: Remove -s from systemctl enable --now sshd
This flag does not work (e.g. on Fedora 36) and not appear to be required (anymore?).

Signed-off-by: Michael Vorburger ⛑️ <mike@vorburger.ch>
2022-07-02 12:27:57 +02:00
aa4279ae15 Fix spelling "setup" -> "set up" and similar
* Replace "setup", "lookup", "cleanup", "backup" with
  "set up", "look up", "clean up", "back up"
  when used as verbs. Replace also variations of those.

* Improve language in a few places.

Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2022-06-22 18:39:21 +02:00
ca26d44d3b Merge pull request #14688 from rhatdan/docs
[CI:DOCS] Update basic_networking.md
2022-06-22 15:47:00 +00:00
132393d15c Update basic_networking.md
a little enhancement based on the [comment by @TomSweeneyRedHat](https://github.com/containers/podman/pull/14290#pullrequestreview-979316099)

Replaces: https://github.com/containers/podman/pull/14290
Thanks to @vrms

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2022-06-21 16:24:59 -04:00
ce3d0954a5 Open Windows tutorial after MSI installation
Signed-off-by: Jason T. Greene <jason.greene@redhat.com>
2022-06-16 23:46:24 -05:00
700248bfef Update remote_client.md
Explicitly include copy-and-paste code line for `ssh-copy-id` because people like myself will easily forget this part and (repeatedly) overlook it in the text. 😊

Supersedes #14445 and attempts to address review by @TomSweeneyRedHat there (but enforcing a filename instead of using a placeholder).

Signed-off-by: Christopher 'm4z' Holm <them4z@gmail.com>

Signed-off-by: Christopher 'm4z' Holm <them4z@googlemail.com>
2022-06-08 17:42:23 +02:00
dc4a01ec61 Add docs of changing default netavark networks
Signed-off-by: Tobias Florek <tob@butter.sh>
2022-06-07 19:30:51 +02:00
33628003ca Put current product first and historical product second
Signed-off-by: William Entriken <github.com@phor.net>
2022-05-24 10:36:35 -04:00
a0d0207a28 fix podman-for-windows.md
Signed-off-by: Yuta <yuta_mori@outlook.jp>
2022-05-21 17:02:37 +09:00
0961002d94 Update tutorial list to include Podman for Windows
Label remote client tutorial as advanced so that users favor the managed machine approach.

Signed-off-by: Jason T. Greene <jason.greene@redhat.com>
2022-05-15 11:48:25 -05:00
876b05cdb3 Add initial Windows guide
Signed-off-by: Jason T. Greene <jason.greene@redhat.com>
2022-05-10 23:30:42 -05:00
97beca9e83 Merge pull request #14123 from DE0CH/rootless_tutorial
[CI:DOCS] Update rootless_tutorial.md
2022-05-05 05:14:26 -04:00
ebde525834 update rootless_tutorial.md
The links to the installation instructions and build instructions seem to
be outdated, so this PR updates them.

Signed-off-by: Deyao Chen <chendeyao000@gmail.com>
2022-05-05 15:57:44 +08:00
7c59f1d077 Fix usermod call in rootless_tutorial.md
The `usermod` calls in rootless_tutorial.md were only adding a very narrow range
for subuids and subgids, which will cause failures with containers where a file
is owned by a user or group with a uid/gid > 1001.

Signed-off-by: Dan Čermák <dcermak@suse.com>
2022-05-05 09:54:20 +02:00
a615cb2fe2 Docs rootfull -> rootful
Some docs say roofull. Change to rootful.

[NO NEW TESTS NEEDED]

Signed-off-by: Ashley Cui <acui@redhat.com>
2022-04-25 11:53:57 -04:00
ea01f89639 [CI:DOCS]Update networking tutorial for netavark
With netavark being the default networking implementation for Podman v4,
the tutorial needed some updating.

[NO NEW TESTS]

Signed-off-by: Brent Baude <bbaude@redhat.com>
2022-02-21 13:35:40 -06:00
d6e55577cf [CI:DOCS] fix default branch links
* Replace https://github.com/containers/podman/blob/master
  with https://github.com/containers/podman/blob/main
  to match the new default branch "main". Previously
  the default branch was "master". The substitutions were
  made in the documentation but not the code.

Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2022-01-15 20:56:19 +01:00
ec32430a06 [CI:DOCS] Add example of cpus to init command
Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>
2021-12-30 13:32:30 +01:00
afdb4dc22f Update Windows Install Doc
Updates the Windows install doc to make it more clear.

Fixes: #11382

Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
2021-12-14 11:23:32 -05:00
babc693670 Update doc to explictly mention using ed25519 in ssh keys
Signed-off-by: Hongyi Shen <wilbeibi@gmail.com>
2021-12-02 09:20:13 -08:00
5336363957 Update basic_networking.md
Correct a missing link in basic networking tutorial.

Signed-off-by: Mark Zhang <markzhang1994@gmail.com>
2021-11-23 23:43:32 +08:00
a3664269b9 [CI:DOCS]upload a translation file
a tranlastion for the podman_tutorial.md

Signed-off-by: sixways <lw.2675@qq.com>
2021-11-19 21:29:28 +08:00
ebd37ede99 Example says there is not IP then in the next command suggests to use it
Signed-off-by: Utopiah <fabien-services@benetou.fr>
2021-09-05 17:23:21 +02:00
ec61507514 Correct a typo in documentation
Signed-off-by: Guido Aulisi <guido.aulisi@gmail.com>
2021-07-15 17:01:16 +02:00
43abe006a3 Merge pull request #10872 from ebb-earl-co/rootless_tutorial_revision
[CI:DOCS] Update docs/tutorials/rootless_tutorial.md:
2021-07-09 10:36:08 -04:00
95c4637851 Update docs/tutorials/rootless_tutorial.md:
* Change references of 'master' to 'main' in URLs e.g. https://github.com/containers/podman/blob/main/install.md
* Wrap names of files or programs by '`' e.g. `dnf`, `containers.conf`, `/etc/subuid`, etc.
* Change sentence with ambiguous subject to 'Root privileges are required to add or update entries within these files'
* Link to kernel.org documentation for the `getpwent` command
* Change sentence: 'Note that the values for each user must be unique ~and without any overlap~'
* Make references to the Podman project upper-case instead of lower-case
* Reorder sentence 'Update the `/etc/subuid` and `/etc/subgid` with fields for each user' to emphasize 'For each user'
* Remove reference to asciiart demos and update README.md link

Signed-off-by: Colin Eberl Coe <ebb-earl-co@pm.me>
2021-07-08 13:38:05 -05:00
38863e7642 Replace old RESTful tutorial with updated README
Remove outdated information on go bindings.  Moved the tips for
debugging into the REAME and tidied up relevant links.

Fixes: #9334
[CI_DOCS]
[NO TESTS NEEDED]

Signed-off-by: Brent Baude <bbaude@redhat.com>
2021-07-07 10:03:01 -05:00
f6d9dbb625 [CI:DOCS]instructions for podman machine on macs
first pass for instructions on using podman machine on Intel and M1
macs.

Signed-off-by: Brent Baude <bbaude@redhat.com>
2021-06-07 16:17:13 -05:00
45fdd8f5c5 Merge pull request #10574 from rogercoll/fix-bindings-docs
[CI:DOCS] Fix outdated docs
2021-06-06 22:44:42 +02:00
13a807b860 fix go-bindings examples with v3 new parameters
Signed-off-by: Roger Coll <rogercoll@protonmail.com>
2021-06-05 22:21:43 +02:00
b928278e63 extend docs to include help for when pub/priv key is signed with an unsupported algo
Signed-off-by: alex narayan <alexandar.narayan@deliveryhero.com>
2021-06-03 18:40:31 +02:00
460182dc5d network tutorial: update with rootless cni changes
Starting with podman v3.2 rootless cni will work without the
rootless-cni-infra container. Update the network tutorial to reflect the
latest changes and mention that the infra container can be removed.

Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
2021-05-15 22:46:53 +02:00
bdbce9bcb1 Add documentation on short-names
Once we settle on the wording for short-names in podman-pull, I will
add the same section to all of the podman commands that use pull.

Also ran through all man pages with a spell checker.

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2021-05-07 09:00:35 -04:00