From ace30b8777b8cc16b88e485f9df9497969da5dcc Mon Sep 17 00:00:00 2001 From: Timothy Hobbs Date: Wed, 7 Nov 2018 00:50:38 +0100 Subject: [PATCH] Document the _proto directory (#4756) Signed-off-by: Timothy Hobbs --- _proto/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 _proto/README.md diff --git a/_proto/README.md b/_proto/README.md new file mode 100644 index 000000000..fcc2c52f1 --- /dev/null +++ b/_proto/README.md @@ -0,0 +1,10 @@ +Protobuf3 type declarations for the Helm API +-------------------------------------------- + +Packages + + - `hapi.chart` Complete serialization of Heml charts + - `hapi.release` Information about installed charts (Releases) such as metadata about when they were installed, their status, and how they were configured. + - `hapi.services.rudder` Definition for the ReleaseModuleService used by Tiller to manipulate releases on a given node + - `hapi.services.tiller` Definition of the ReleaseService provoded by Tiller and used by Helm clients to manipulate releases cluster wide. + - `hapi.version` Version meta-data used by tiller to express it's version