PouchContainer Docs is written, drawn, memorialized representation of all things about PouchContainer. For those who are generally interested in PouchContainer, README.md of this repo is sufficient. While if you wish to take advantage of PouchContainer to create more innovative value, docs here would be strong support for that.
Organization of document is as following:
- Features
- Get Started
- Commandline
- API
- Kubernetes
- Contributions
- Test Guide
- Underlying Tech
- Static Files
Features contains all features of PouchContainer. To enable a satisfying environment for user's applications, PouchContainer provides plenty of features, such as strong-isolation technology including hyper-based containers and lxcfs-base resource view isolation, rich container, P2P image distribution and so on. For more aspects, TLS-based security, prometheus supporting and more features also help PouchContainer be adoptive for enterprises. In addition, in all the document we illustrate what is the best scenario of the corresponding feature.
Get Started is exactly what you need if you would give PouchContainer a try. This document includes what are the prerequisites, how to install PouchContainer and how to experience PouchContainer.
For almost all of users, commandline is the first reference you may need. Document in directory commandline is about command detailed usage of PouchContainer cli. You can get introductions, synopsis, examples, options about command. Last but not least, PouchContainer can guarantee commandline docs is strongly consistent with PouchContainer CLI's source code. What's more, all commandline docs are auto generated via source code.
Commandline is the easiest way to extend PouchContainer's ability. And API extension will bring more powerful experience for users.
Document HTTP-API.md contains all raw HTTP API details. For PouchContainer's HTTP API, it is all recorded in file swagger.yml. The document HTTP_API.md is also auto generated by swagger.yml. So, we can still guarantee the strong consistency between code implementation and HTTP API document.
Document HTTP-API-CHANGELOG.md contains HTTP API changelog. In principle, HTTP API of PouchContainer should always keep still even if more versions are released. However, when PouchContainer evolves, more functionality, direction adjustment and bugfix in API would make HTTP API change, and we PouchContainer provides HTTP API changelog to track all the evolution.
Document GRPC-API.md contains all raw gRPC API details. PouchContainer can be run as a native container engine to support CRI and CRI ability is exposed via gRPC.
Document GRPC-API-CHANGELOG.md contains GRPC API changelog. In principle, gRPC API of PouchContainer should always keep still even if more versions are released. However, when PouchContainer evolves, more functionality, direction adjustment and bugfix in API would make gRPC API change, and we PouchContainer provides gRPC API changelog to track all the evolving.
Kubernetes contains all docs about PouchContainer with kubernetes. At the very beginning design of PouchContainer, PouchContainer team decided to treat itself as a reliable runtime option for kubernetes. To support kubernetes, PouchContainer has implemented Container Runtime Interface(CRI) directly. Introduction of kubernetes and PouchContainer, how to get started with them combined, and how to test and architecture of them are all included in this document folder.
Test Doc is the best reference helping contributors get aware of how to setup testing environment and do it. Currently we can divide test of PouchContainer into four dimensions: unit test, integration test of API and CLI, and CRI validation test. For more details, please refer to test.
Contributions is a helpful document for community participants to learn how to contribute and coordinate within PouchContainer open source project. We draw up some friendly guidance for all participants.
Underlying Tech helps users to get more knowledge about the underlying technology adopted in PouchContainer, such as Cgroup, Namespce technology in Linux Kernel, hypervisor-based container technology, lxcfs, and so on. If users wish to master PouchContainer technology better, this document is a must-read.
Static files contains all static files for PouchContainer. If users are seeking some material in particular, such as PouchContainer log, architecture of it, or more pic about PouchContainer. This document directory is where users need a try.