Skip to content

Commit 4c907ce

Browse files
mheonrh-atomic-bot
authored andcommitted
Update main README
Signed-off-by: Matthew Heon <[email protected]> Closes: #754 Approved by: baude
1 parent 608f0b9 commit 4c907ce

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,31 @@
66
## What is the scope of this project?
77

88
libpod provides a library for applications looking to use the Container Pod concept popularized by Kubernetes.
9-
libpod also contains a tool podman, which allows you to manage Pods, Containers, and Container Images.
9+
libpod also contains a tool called podman for managing Pods, Containers, and Container Images.
1010

11-
At a high level, we expect the scope of libpod/podman to be the following:
11+
At a high level, the scope of libpod and podman is the following:
1212

1313
* Support multiple image formats including the existing Docker/OCI image formats.
1414
* Support for multiple means to download images including trust & image verification.
1515
* Container image management (managing image layers, overlay filesystems, etc).
16-
* Container and POD process lifecycle management.
17-
* Resource isolation of containers and PODS.
16+
* Full management of container lifecycle
17+
* Support for pods to manage groups of containers together
18+
* Resource isolation of containers and pods.
1819

1920
## What is not in scope for this project?
2021

21-
* Building container images. See [Buildah](https://github.com/projectatomic/buildah).
2222
* Signing and pushing images to various image storages. See [Skopeo](https://github.com/projectatomic/skopeo/).
23-
* Container Runtimes daemons for working with Kubernetes CRIs. See [CRI-O](https://github.com/kubernetes-incubator/cri-o).
23+
* Container Runtimes daemons for working with Kubernetes CRIs. See [CRI-O](https://github.com/kubernetes-incubator/cri-o). We are working to integrate libpod into CRI-O to share containers and backend code with Podman.
2424

2525
## OCI Projects Plans
2626

2727
The plan is to use OCI projects and best of breed libraries for different aspects:
28-
- Runtime: [runc](https://github.com/opencontainers/runc) (or any OCI runtime-spec implementation) and [oci runtime tools](https://github.com/opencontainers/runtime-tools)
28+
- Runtime: [runc](https://github.com/opencontainers/runc) (or any OCI compliant runtime) and [oci runtime tools](https://github.com/opencontainers/runtime-tools) to generate the spec
2929
- Images: Image management using [containers/image](https://github.com/containers/image)
30-
- Storage: Storage and management of image layers using [containers/storage](https://github.com/containers/storage)
30+
- Storage: Container and image storage is managed by [containers/storage](https://github.com/containers/storage)
3131
- Networking: Networking support through use of [CNI](https://github.com/containernetworking/cni)
32-
- Conmon: [conmon](https://github.com/kubernetes-incubator/cri-o) Conmon is a tool for monitoring OCI runtimes. Part of the CRI-O package
32+
- Builds: Builds are supported via [Buildah](https://github.com/projectatomic/buildah).
33+
- Conmon: [Conmon](https://github.com/kubernetes-incubator/cri-o) is a tool for monitoring OCI runtimes. It is part of the CRI-O package
3334

3435
## Podman Information for Developers
3536

@@ -48,18 +49,18 @@ Useful information for ops and dev transfer as it relates to infrastructure that
4849
includes tables showing Docker commands and their Podman equivalent commands.
4950

5051
**[Podman API](/API.md)**
51-
Documentation on the Podman API using varlink.
52+
Documentation on the Podman API using [Varlink](https://www.varlink.org/).
5253

5354
**[Tutorials](docs/tutorials)**
54-
Tutorials on the Podman utility.
55+
Tutorials on using Podman.
5556

5657
**[Contributing](CONTRIBUTING.md)**
5758
Information about contributing to this project.
5859

5960
### Current Roadmap
6061

61-
1. Basic pod/container lifecycle, basic image pull (done)
62-
1. Support for tty handling and state management (done)
63-
1. Basic integration with kubelet once client side changes are ready (done)
64-
1. Support for log management, networking integration using CNI, pluggable image/storage management (done)
65-
1. Support for exec/attach (done)
62+
1. Varlink API for Podman
63+
1. Integrate libpod into CRI-O to replace its existing container management backend
64+
1. Pod commands for Podman
65+
1. Rootless containers
66+
1. Support for cleaning up containers via post-run hooks

0 commit comments

Comments
 (0)