Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
davidjumani committed Dec 12, 2023
1 parent 637da0d commit a0a21e5
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ in Gloo OSS due to its minimized hashing which prevents data races in gloo. [Ori

Any changes to APIs in [rate-limiter](https://github.com/solo-io/rate-limiter/) should propagate to this branch and code-gen should be re-run. There should be [existing automation](https://github.com/solo-io/rate-limiter/actions/workflows/update-solo-apis.yaml) around this but it is always a good practice to manually sync the protos when bumping k8s dependencies or cutting a major release in case the automation was unsuccessful. Any CRDs generated / modified can be ignored since we only care about the protos.

An alternative that had been considered is using `gloo-main` instead of this branch in Gloo OSS. However this poses an issue when building enterprise - if `gloo-main` is ahead of the latest `gloo-v1.n.x tag` used in enterprise, enterprise will utilize solo-apis@gloo-main instead of the specified tag due to the way go bundles dependencies.
Other alternatives considered were :
- Depend on `gloo-main` instead of this branch in Gloo OSS : This poses an issue when building enterprise - There can be scenarios where manual changes have been merged into gloo-main and a new gloo release has not yet been cut with a tag that contains those changes. This can cause issues if solo-projects is not yet ready to consume those changes. Additionally, since `gloo-main` is ahead of the latest `gloo-v1.n.x tag` used in enterprise, enterprise will utilize solo-apis@gloo-main instead of the specified tag due to the way go bundles dependencies.
- Depend on `gloo-v1.n.x` tag in Gloo OSS : This will not pick up any new Rate limiter changes that are pushed to gloo-main. It will require cutting a release every time there are changes to the Rate Limiter API. This can again cause issues if gloo is not ready to consume the new changes or not yet ready for a release. This will also require bumping the solo-apis dependency in gloo every time there is a new release.

More details on other options considered and their tradeoffs can be found in this [slack tread](https://solo-io-corp.slack.com/archives/G01EERAK3KJ/p1701798077193259)

0 comments on commit a0a21e5

Please sign in to comment.