Skip to content

Commit 9d450b4

Browse files
authored
📖 Compare our fork with upstream. (#73)
* 📖 Compare our fork with upstream. * pr title was slightly wrong.
1 parent 67cfe9e commit 9d450b4

File tree

1 file changed

+7
-18
lines changed

1 file changed

+7
-18
lines changed

README.md

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,18 @@ Instead we plan to create PRs in upstream, so that our fork is no longer needed.
1717

1818
Features/PRs which are different in our fork. We should create PRs in upstream for these:
1919

20-
* [separate user agent from HCCM](https://github.com/syself/hetzner-cloud-controller-manager/pull/42): Make this configurable in upstream.
21-
* [ROBOT_DEBUG, show stacktrace on api-calls](https://github.com/syself/hetzner-cloud-controller-manager/pull/41>) Via ROBOT_DEBUG show every stack-trace which uses the robot-API (to debug why rate-limiting was reached)
22-
* [PR add version information to the controller binary](https://github.com/syself/hetzner-cloud-controller-manager/pull/28): Build process is different in upstream.
23-
* [PR Add Github WF for releasing](https://github.com/syself/hetzner-cloud-controller-manager/pull/29)
24-
* [PR entrypoint in container image](https://github.com/syself/hetzner-cloud-controller-manager/pull/25)
25-
* [PR rate limiting hcloud](https://github.com/syself/hetzner-cloud-controller-manager/pull/20)
26-
* Upstream has three `ServerGetList` implementations: cache, rate-limited, mock. Our fork has two: mock, cached.
20+
* [PR hotreload credentials, when mounted secret changed](https://github.com/syself/hetzner-cloud-controller-manager/pull/49)
21+
* [PR create events, when robot rate-limit was reached](https://github.com/syself/hetzner-cloud-controller-manager/pull/20)
2722

28-
Additional PRs we should create in upstream, so that we can use upstream instead our fork:
23+
Less important features in our fork, which are not in upstream:
2924

30-
* Make ProviderID configurable (hrobot://NNN vs hcloud://bm-NNN)
31-
* Sort Go imports
32-
* Compare linters of upstream with the linters of our other repos.
25+
* [ROBOT_DEBUG, show stacktrace on api-calls](https://github.com/syself/hetzner-cloud-controller-manager/pull/41) Via ROBOT_DEBUG show every stack-trace which uses the robot-API (to debug why rate-limiting was reached)
26+
* [PR add version information to the controller binary](https://github.com/syself/hetzner-cloud-controller-manager/pull/28): Build process is different in upstream.
27+
* Upstream has three `ServerGetList` implementations: cache, rate-limited, mock. Our fork has two: mock, cached.
3328

3429
PRs which are **not** needed in upstream, because upstream has this feature:
3530

36-
* [PR hotreload credentials, when mounted secret changed](https://github.com/syself/hetzner-cloud-controller-manager/pull/49)
31+
* [separate user agent from HCCM](https://github.com/syself/hetzner-cloud-controller-manager/pull/42): Make this configurable in upstream.
3732
* [PR getInstanceTypeOfRobotServer: convert invalid characters to dashes](https://github.com/syself/hetzner-cloud-controller-manager/pull/40)
3833
* [Make robot client optional for lb client](https://github.com/syself/hetzner-cloud-controller-manager/pull/37): upstream uses ROBOT_ENABLED. We need to set that env var.
3934
* [Fix InstanceExists for baremetal servers, check node name](https://github.com/syself/hetzner-cloud-controller-manager/pull/32)
@@ -42,8 +37,6 @@ PRs which are **not** needed in upstream, because upstream has this feature:
4237
* [robot cache](https://github.com/syself/hetzner-cloud-controller-manager/pull/19)
4338
* [Support for robot](https://github.com/syself/hetzner-cloud-controller-manager/pull/1)
4439

45-
If you update the Syself fork, please create two PRs for version updates and code updates. Mixing both in one PR makes things harder to understand.
46-
4740
Files moved by upstream in their fork:
4841

4942
* internal/robot/client/cache/client.go (from Janis Okt 2023) --> internal/robot/cache.go (by Julian Nov 2023)
@@ -54,10 +47,6 @@ Files moved by upstream in their fork:
5447
How to keep our fork up to date: Check which changes were done in upstream. Pick indivual features, if they make sense for us. If unsure,
5548
don't pick a feature. Instead try to get our features into upstream, and update or dependencies.
5649

57-
TODO:
58-
59-
* from quay.io to ghcr.io
60-
6150
## Installing Syself CCM
6251

6352
```sh

0 commit comments

Comments
 (0)