diff --git a/README.md b/README.md index ef430153d0d..5bb51eadb82 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,6 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/projectatomic/buildah)](https://goreportcard.com/report/github.com/projectatomic/buildah) [![Travis](https://travis-ci.org/projectatomic/buildah.svg?branch=master)](https://travis-ci.org/projectatomic/buildah) -Note: this package is in alpha, but is close to being feature-complete. - The Buildah package provides a command line tool that can be used to * create a working container, either from scratch or using an image as a starting point * create an image, either from a working container or via the instructions in a Dockerfile @@ -16,13 +14,17 @@ The Buildah package provides a command line tool that can be used to * use the updated contents of a container's root filesystem as a filesystem layer to create a new image * delete a working container or an image +**[Buildah Demos](demos)** + **[Changelog](CHANGELOG.md)** +**[Development Plan](developmentplan.md)** + **[Installation notes](install.md)** **[Troubleshooting Guide](troubleshooting.md)** -**[Tutorials](docs/tutorials/README.md)** +**[Tutorials](docs/tutorials)** ## Example diff --git a/demos/README.md b/demos/README.md index 2e3aa907d9e..ee1b27e25f0 100644 --- a/demos/README.md +++ b/demos/README.md @@ -1,15 +1,5 @@ ![buildah logo](https://cdn.rawgit.com/projectatomic/buildah/master/logos/buildah-logo_large.png) -# Useful Buildah links - -**[Changelog](../CHANGELOG.md)** - -**[Installation notes](../install.md)** - -**[Troubleshooting Guide](../troubleshooting.md)** - -**[Tutorials](../docs/tutorials/README.md)** - # Buildah Demos The purpose of these demonstrations is twofold: diff --git a/developmentplan.md b/developmentplan.md new file mode 100644 index 00000000000..5d00cbfb44f --- /dev/null +++ b/developmentplan.md @@ -0,0 +1,13 @@ +![buildah logo](https://cdn.rawgit.com/projectatomic/buildah/master/logos/buildah-logo_large.png) + +# Development Plan + +## Development goals for Buildah + + * Integration into Kubernetes and potentially other tools. The biggest requirement for this is to be able run Buildah within a standard linux container without SYS_ADMIN privileges. This would allow Buildah to run non-privileged containers inside of Kubernetes, so you could distribute your container workloads. + + * Integration with User Namespace, Podman has this already and the goal is to get `buildah bud` and `buildah run` to be able to run its containers in a usernamespace to give the builder better security isolation from the host. + + * Buildah `buildah bud` command's goal is to have feature parity with other OCI image and container build systems. + + * Addressing issues from the community as reported in the [Issues](https://github.com/projectatomic/buildah/issues) page.