diff --git a/README.md b/README.md index 53a9b26..22280d2 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,15 @@ # apicurio-registry-content-sync-operator +This repository is no longer maintained by the Apicurio Registry core maintainers. + +There is a number of reasons for not following this approach, some of them being that this is a "broken by design" approach as the current Apicurio Registry API is not built to be idempotent and used in such a way: + +Reconciliation is going to fail under some (common) conditions like concurrent updates of artifacts +Detecting failures in reconciliation requires extra monitoring and external tools causing Registry to misbehave instead of failing +Manually fixing a failure in reconciliation always requires human intervention +The amount of data that can be stored is limited (by default ETCD limit is, per object, 1.5MB) + + A Kubernetes Operator that allows to manage the lifecycle of Artifacts in [Apicurio Registry](https://www.apicur.io/registry/). A perfect tool to manage your APIs and Schemas in Apicurio Registry using Git Ops processes. @@ -47,4 +57,4 @@ kubectl apply -f https://raw.githubusercontent.com/Apicurio/apicurio-registry-co The manifests in the `standalone` folder are an example of a deployment of this operator in isolation. With this deployment method it's assumed the registry is already deployed. The target Apicurio Registry instance is configured with the env var `APICURIO_REGISTRY_URL` located in the `03-deployment.yaml` file. -The `simple` manifests folder is the only one that works out of the box, the `standalone` one you may have to tweak it to point to your own Apicurio Registry. \ No newline at end of file +The `simple` manifests folder is the only one that works out of the box, the `standalone` one you may have to tweak it to point to your own Apicurio Registry.