Update installation instructions #3068

h-vetinari · 2019-05-06T06:01:50Z

As talked about at the end of that issue, @TomSweeneyRedHat and @rhatdan agreed with my suggestion to merge the installation instructions from docs/tutorials/podman_tutorial.md with install.md, which I did here.

I tried to not lose any currently existing information along the way, but rather expand it to a full set of commands necessary to build (e.g. ostree). I tested all the instructions on Ubuntu 18.04 and RHEL 7.6 (on an azure VM, without having an active subscription).

For RHEL, I ran into #3045, where the build instructions (before this PR) produced a build that would only run if runc<1.0.0-rc7. In that issue, @rhatdan told me that runc needs to be built with BUILDTAGS="selinux seccomp", but that then also produces a build that is broken. Following the rabbit hole further, and also building podman with BUILDTAGS="selinux seccomp" runs into a selinux issue, which is reproducible for me (cf. this comment by @rhatdan).

I documented the install instructions that allowed me to proceed as far as possible (i.e. all builds suceed, and the failure only occurs at runtime, i.e. sudo podman build), but I presume there will be a few more kinks to iron out regarding this.

I'll comment a few more things in the diff directly.

openshift-ci-robot · 2019-05-06T06:02:10Z

Hi @h-vetinari. Thanks for your PR.

I'm waiting for a containers or openshift member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

rh-atomic-bot · 2019-05-06T06:11:15Z

Can one of the admins verify this patch?
I understand the following commands:

bot, add author to whitelist
bot, test pull request
bot, test pull request once

h-vetinari

Some more detailed comments about the changes.

h-vetinari · 2019-05-06T06:03:01Z

docs/tutorials/podman_tutorial.md

@@ -8,114 +8,9 @@ commands with Podman.
 **NOTE**: the code samples are intended to be run as a non-root user, and use `sudo` where
 root escalation is required.



Everything from this file that was not already available in install.md has been moved there.

h-vetinari · 2019-05-06T06:03:31Z

install.md

@@ -53,8 +52,12 @@ sudo yum module enable -y container-tools:1.0
 sudo yum module install -y container-tools:1.0
 ```

+### Installing development versions of podman
+


New subsection for installing dev builds on Fedora/Ubuntu

h-vetinari · 2019-05-06T06:04:11Z

install.md

-A proper description of setting up CNI networking is given in the [`cni` README](cni/README.md).
-But the gist is that you need to have some basic network configurations enabled and
-CNI plugins installed on your system.
+## Building from scratch


Followed by the section to rebuild from scratch...

h-vetinari · 2019-05-06T06:05:23Z

install.md

  btrfs-tools \
  git \
  golang-go \
  go-md2man \
  iptables \
  libassuan-dev \
+  libc6-dev \


Sorted this package alphabetically

h-vetinari · 2019-05-06T06:05:39Z

install.md

  libdevmapper-dev \
  libglib2.0-dev \
-  libc6-dev \
-  libgpgme11-dev \
+  libgpgme-dev \


Update deprecated package name

h-vetinari · 2019-05-06T06:12:59Z

install.md

+```bash
+git clone https://github.com/opencontainers/runc.git $GOPATH/src/github.com/opencontainers/runc
+cd $GOPATH/src/github.com/opencontainers/runc
+make BUILDTAGS="selinux seccomp"


This build tag has been changed compared to the tutorial due to this comment.

h-vetinari · 2019-05-06T06:13:25Z

install.md

+
+#### Setup CNI networking
+
+A proper description of setting up CNI networking is given in the [`cni` README](cni/README.md).


Maintaining the link to the general description, while also providing a workable minimal setup.

h-vetinari · 2019-05-06T06:13:55Z

install.md


- * A copy of the development libraries for `ostree`, either in the form of the `libostree-dev` package from the [flatpak](https://launchpad.net/~alexlarsson/+archive/ubuntu/flatpak) PPA, or built [from source](https://github.com/ostreedev/ostree) (more on that [here](https://ostree.readthedocs.io/en/latest/#building)). As of Ubuntu 18.04, `libostree-dev` is available in the main repositories, and the PPA is no longer required.


This whole block has been split up into the above sections (and expanded with the actual build commands, as in the tutorial).

h-vetinari · 2019-05-06T06:14:25Z

install.md

@@ -174,47 +264,32 @@ As with other Go projects, PODMAN must be cloned into a directory structure like
 GOPATH
 └── src
    └── github.com
-	└── containers
-	    └── libpod


Resolved a mix of tabs/spaces here

h-vetinari · 2019-05-06T06:16:06Z

install.md

-mkdir -p $GOPATH/src/github.com/containers
-cd $_ # or cd $GOPATH/src/github.com/containers
-git clone https://github.com/containers/libpod # or your fork
-cd libpod


Replaced with the build instructions from the tutorial, and added BUILDTAGS="selinux seccomp" due to the discussion in #3045. I also needed to add PREFIX= to make sure all the libraries get linked into the binary correctly (although I'd hope that this could be removed again somehow).

TomSweeneyRedHat

Really nice start @h-vetinari thanks for taking this on. Just a few nits here and there.

TomSweeneyRedHat · 2019-05-06T13:25:42Z

docs/tutorials/podman_tutorial.md

-make
-sudo make install PREFIX=/usr
-```
+For installing or building podman, please see the [installation instructions](install.md).


nit Police! podman s/b "Podman" unless you're using it as a command.

TomSweeneyRedHat · 2019-05-06T13:52:56Z

install.md

@@ -53,8 +52,12 @@ sudo yum module enable -y container-tools:1.0
 sudo yum module install -y container-tools:1.0
 ```

+### Installing development versions of podman


TomSweeneyRedHat · 2019-05-06T13:56:50Z

install.md

+
+A proper description of setting up CNI networking is given in the [`cni` README](cni/README.md).
+
+Using the CNI plugins from above, a most basic network config is achieved with:


suggest s/most basic/more basic/

install.md

TomSweeneyRedHat · 2019-05-06T14:01:22Z

install.md

 ```

-Next, clone the source code using:
+First, ensure that the go version that is found first on the $PATH (in case you built your own; see above) is sufficiently recent -


can you add a link to the golang line for "above"?

giuseppe

can you please squash the commits together?

h-vetinari · 2019-05-06T19:45:00Z

@giuseppe: can you please squash the commits together?

No problem. Do you want this for every push or just before the final merge?

giuseppe · 2019-05-06T19:47:24Z

No problem. Do you want this for every push or just before the final merge?

just final merge works for me, but I saw you already fixed it. Thanks!

TomSweeneyRedHat · 2019-05-06T20:29:49Z

install.md

@@ -8,15 +8,14 @@
 sudo pacman -S podman
 ```

-If you have problems when running podman in [rootless](README.md#rootless) mode follow [these instructions](https://wiki.archlinux.org/index.php/Linux_Containers#Enable_support_to_run_unprivileged_containers_(optional))
+If you have problems when running Podman in [rootless](README.md#rootless) mode follow [these instructions](https://wiki.archlinux.org/index.php/Linux_Containers#Enable_support_to_run_unprivileged_containers_(optional))


Maybe it's just me, but when I first read this when it's resolved to a web page, I missed the link and was looking on this page. Maybe s/these instructions/the instructions here/ and have the word "here" be the link?

TomSweeneyRedHat

One small change for consideration, otherwise LGTM.

TomSweeneyRedHat · 2019-05-06T20:33:07Z

install.md

+sudo cp runc /usr/bin/runc
+```
+
+#### CNI plugins


nice change to make these proper headings.

Just following what was in the tutorial already. ;-)

jwhonce · 2019-05-06T21:36:04Z

@h-vetinari Please add a line like:
Signed-off-by: Jhon Honce [email protected]
to your commit message. That will pass our gating tests and let us know your signing off on the code. Thanks.

jwhonce · 2019-05-06T21:36:49Z

/ok-to-test
/approve

Signed-off-by: h-vetinari <[email protected]>

h-vetinari · 2019-05-10T20:51:13Z

Anything left for me to do here?

mheon · 2019-05-10T21:02:21Z

/approve

openshift-ci-robot · 2019-05-10T21:02:28Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: h-vetinari, jwhonce, mheon

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [mheon]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

mheon · 2019-05-10T21:06:28Z

Tests are green. LGTM on my end
@rhatdan @baude @TomSweeneyRedHat @vrothberg @giuseppe PTAL

rhatdan · 2019-05-10T22:01:05Z

/lgtm

h-vetinari · 2019-05-12T11:55:44Z

Thanks for merging.

@rhatdan, following the install instructions for building on RHEL should give you a reproducible example for #3045, cf. your comment

openshift-ci-robot requested review from giuseppe and umohnani8 May 6, 2019 06:01

openshift-ci-robot added size/L needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 6, 2019

h-vetinari commented May 6, 2019

View reviewed changes

h-vetinari mentioned this pull request May 6, 2019

BUG: cannot run rstudio server in podman container #2887

Closed

TomSweeneyRedHat reviewed May 6, 2019

View reviewed changes

giuseppe reviewed May 6, 2019

View reviewed changes

h-vetinari force-pushed the master branch from f58643e to 80eb16e Compare May 6, 2019 19:45

TomSweeneyRedHat reviewed May 6, 2019

View reviewed changes

h-vetinari force-pushed the master branch from 80eb16e to a9143b4 Compare May 6, 2019 20:39

openshift-ci-robot added ok-to-test and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 6, 2019

h-vetinari force-pushed the master branch 2 times, most recently from 2790180 to 5168618 Compare May 7, 2019 05:46

Update installation instructions

fe2d074

Signed-off-by: h-vetinari <[email protected]>

h-vetinari force-pushed the master branch from 5168618 to fe2d074 Compare May 7, 2019 05:47

openshift-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 10, 2019

openshift-ci-robot assigned rhatdan May 10, 2019

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label May 10, 2019

openshift-merge-robot merged commit 9ae3221 into containers:master May 10, 2019

h-vetinari mentioned this pull request May 12, 2019

BUG: Problem with selinux/runc>=1.0.0-rc7 #3045

Closed

h-vetinari mentioned this pull request May 31, 2019

Podman install guide adjustments - DOC #3206

Closed

github-actions bot added the locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments. label Sep 26, 2023

github-actions bot locked as resolved and limited conversation to collaborators Sep 26, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update installation instructions #3068

Update installation instructions #3068

h-vetinari commented May 6, 2019

openshift-ci-robot commented May 6, 2019

rh-atomic-bot commented May 6, 2019

h-vetinari left a comment

h-vetinari May 6, 2019

h-vetinari May 6, 2019

h-vetinari May 6, 2019

h-vetinari May 6, 2019

h-vetinari May 6, 2019

h-vetinari May 6, 2019

h-vetinari May 6, 2019

h-vetinari May 6, 2019

h-vetinari May 6, 2019

h-vetinari May 6, 2019

TomSweeneyRedHat left a comment

TomSweeneyRedHat May 6, 2019

TomSweeneyRedHat May 6, 2019

TomSweeneyRedHat May 6, 2019

TomSweeneyRedHat May 6, 2019

giuseppe left a comment

h-vetinari commented May 6, 2019

giuseppe commented May 6, 2019

TomSweeneyRedHat May 6, 2019

TomSweeneyRedHat left a comment

TomSweeneyRedHat May 6, 2019

h-vetinari May 6, 2019

jwhonce commented May 6, 2019

jwhonce commented May 6, 2019 •

edited

Loading

h-vetinari commented May 10, 2019

mheon commented May 10, 2019

openshift-ci-robot commented May 10, 2019

mheon commented May 10, 2019

rhatdan commented May 10, 2019

h-vetinari commented May 12, 2019

		@@ -8,114 +8,9 @@ commands with Podman.
		NOTE: the code samples are intended to be run as a non-root user, and use `sudo` where
		root escalation is required.


		#### Setup CNI networking

		A proper description of setting up CNI networking is given in the [`cni` README](cni/README.md).


		* A copy of the development libraries for `ostree`, either in the form of the `libostree-dev` package from the [flatpak](https://launchpad.net/~alexlarsson/+archive/ubuntu/flatpak) PPA, or built [from source](https://github.com/ostreedev/ostree) (more on that [here](https://ostree.readthedocs.io/en/latest/#building)). As of Ubuntu 18.04, `libostree-dev` is available in the main repositories, and the PPA is no longer required.


		A proper description of setting up CNI networking is given in the [`cni` README](cni/README.md).

		Using the CNI plugins from above, a most basic network config is achieved with:

Update installation instructions #3068

Update installation instructions #3068

Conversation

h-vetinari commented May 6, 2019

openshift-ci-robot commented May 6, 2019

rh-atomic-bot commented May 6, 2019

h-vetinari left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TomSweeneyRedHat left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

giuseppe left a comment

Choose a reason for hiding this comment

h-vetinari commented May 6, 2019

giuseppe commented May 6, 2019

Choose a reason for hiding this comment

TomSweeneyRedHat left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jwhonce commented May 6, 2019

jwhonce commented May 6, 2019 • edited Loading

h-vetinari commented May 10, 2019

mheon commented May 10, 2019

openshift-ci-robot commented May 10, 2019

mheon commented May 10, 2019

rhatdan commented May 10, 2019

h-vetinari commented May 12, 2019

jwhonce commented May 6, 2019 •

edited

Loading