diff --git a/README.md b/README.md index 6894222..fbf9424 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,24 @@ # CloudNativePG Interface (CNPG-I) -**Status:** PROPOSAL +**Status:** Preview Implementation + +CNPG-I is a gRPC-based out-of-process plugin interface that allows +[CloudNative-PG (CNPG)](https://github.com/cloudnative-pg/cloudnative-pg/) +to be extended with custom behaviour. + +This interface is also supported by +[EDB pg4k](https://github.com/EnterpriseDB/cloud-native-postgres). + +## References + +* [Protocol documentation](./docs/docs.md) +* [CNPG-i plugin helper](https://github.com/cloudnative-pg/cnpg-i-machinery/) for Go + - provides shared tooling for CNPG-I plugins +* Example plugins: + * [The `cnpg-i-hello-world` plugin](https://github.com/cloudnative-pg/cnpg-i-hello-world) + contains documentation and sample code for Go plugins. + * [Example plugin in Rust](https://github.com/leonardoce/plugin-generic-exporter) + showing how to deploy sidecar containers in postgres pods. ## Why do we need CNPG-I?