From ab88304162c7013a4d5a13c1f20cb7a85531f8bd Mon Sep 17 00:00:00 2001 From: TomSweeneyRedHat Date: Thu, 15 Feb 2018 07:31:46 -0500 Subject: Touch up tutorial location and install reqs Signed-off-by: TomSweeneyRedHat Closes: #337 Approved by: rhatdan --- README.md | 2 +- docs/tutorials/README.md | 9 +++++++++ docs/tutorials/tutorials.md | 9 --------- install.md | 24 +++++++++++++++++------- 4 files changed, 27 insertions(+), 17 deletions(-) create mode 100644 docs/tutorials/README.md delete mode 100644 docs/tutorials/tutorials.md diff --git a/README.md b/README.md index 41e3faf9b..6955e0056 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ showing the commands in use. Useful information for ops and dev transfer as it relates to infrastructure that utilizes Podman. This page includes tables showing Docker commands and their Podman equivalent commands. -**[Tutorials](docs/tutorials/tutorials.md)** +**[Tutorials](docs/tutorials)** Tutorials on the Podman utility. ## Communication with Fellow Developers diff --git a/docs/tutorials/README.md b/docs/tutorials/README.md new file mode 100644 index 000000000..6ada366c0 --- /dev/null +++ b/docs/tutorials/README.md @@ -0,0 +1,9 @@ +![PODMAN logo](https://cdn.rawgit.com/kubernetes-incubator/cri-o/master/logo/crio-logo.svg) + +# Podman Tutorials + +## Links to a number of useful tutorials for the Podman utility. + +**[Introduction Tutorial](https://github.com/projectatomic/libpod/tree/master/docs/tutorials/podman_tutorial.md)** + +Learn how to setup Podman and perform some basic commands with the utility. diff --git a/docs/tutorials/tutorials.md b/docs/tutorials/tutorials.md deleted file mode 100644 index 6ada366c0..000000000 --- a/docs/tutorials/tutorials.md +++ /dev/null @@ -1,9 +0,0 @@ -![PODMAN logo](https://cdn.rawgit.com/kubernetes-incubator/cri-o/master/logo/crio-logo.svg) - -# Podman Tutorials - -## Links to a number of useful tutorials for the Podman utility. - -**[Introduction Tutorial](https://github.com/projectatomic/libpod/tree/master/docs/tutorials/podman_tutorial.md)** - -Learn how to setup Podman and perform some basic commands with the utility. diff --git a/install.md b/install.md index 535e5b137..332053238 100644 --- a/install.md +++ b/install.md @@ -8,7 +8,7 @@ The latest version of `runc` is expected to be installed on the system. It is pi #### conmon installed -The latest version of `conmon` is expected to be installed on the system. Conmon is used to monitor OCI Runtimes +The latest version of `conmon` is expected to be installed on the system. Conmon is used to monitor OCI Runtimes. #### Setup CNI networking @@ -25,6 +25,7 @@ Fedora, CentOS, RHEL, and related distributions: ```bash yum install -y \ + atomic-registries \ btrfs-progs-devel \ conmon \ containernetworking-cni \ @@ -36,6 +37,7 @@ yum install -y \ go \ golang-github-cpuguy83-go-md2man \ gpgme-devel \ + iptables \ libassuan-devel \ libgpg-error-devel \ libseccomp-devel \ @@ -51,28 +53,36 @@ Debian, Ubuntu, and related distributions: ```bash apt-get install -y \ btrfs-tools \ - cri-o \ git \ golang-go \ + go-md2man \ + iptables \ libassuan-dev \ libdevmapper-dev \ libglib2.0-dev \ libc6-dev \ libgpgme11-dev \ libgpg-error-dev \ + libprotobuf-dev \ + libprotobuf-c0-dev \ libseccomp-dev \ libselinux1-dev \ - pkg-config \ - runc \ - skopeo-containers + pkg-config ``` -Debian, Ubuntu, and related distributions will also need 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)). +Debian, Ubuntu, and related distributions will also need to do the following setup: -If using an older release or a long-term support release, be careful to double-check that the version of `runc` is new enough (running `runc --version` should produce `spec: 1.0.0`), or else build your own. + * 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)). + * [Add required configuration files](https://github.com/projectatomic/libpod/blob/master/docs/tutorials/podman_tutorial.md#adding-required-configuration-files) + * Install conman, CNI plugins and runc + * [Install conman](https://github.com/projectatomic/libpod/blob/master/docs/tutorials/podman_tutorial.md#building-and-installing-conmon) + * [Install CNI plugins](https://github.com/projectatomic/libpod/blob/master/docs/tutorials/podman_tutorial.md#installing-cni-plugins) + * [runc Installation](https://github.com/projectatomic/libpod/blob/master/docs/tutorials/podman_tutorial.md#installing-runc) - Although installable, the latest runc is not available in the Ubuntu repos. Version 1.0.0-rc4 is the minimal requirement. **NOTE** +If using an older release or a long-term support release, be careful to double-check that the version of `runc` is new enough (running `runc --version` should produce `spec: 1.0.0`), or else [build](https://github.com/projectatomic/libpod/blob/master/docs/tutorials/podman_tutorial.md#installing-runc) your own. + 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** -- cgit v1.2.3-54-g00ecf