Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 6 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,18 @@ Instead we plan to create PRs in upstream, so that our fork is no longer needed.

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

* [separate user agent from HCCM](https://github.com/syself/hetzner-cloud-controller-manager/pull/42): Make this configurable in upstream.
* [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)
* [PR add version information to the controller binary](https://github.com/syself/hetzner-cloud-controller-manager/pull/28): Build process is different in upstream.
* [PR Add Github WF for releasing](https://github.com/syself/hetzner-cloud-controller-manager/pull/29)
* [PR entrypoint in container image](https://github.com/syself/hetzner-cloud-controller-manager/pull/25)
* [PR hotreload credentials, when mounted secret changed](https://github.com/syself/hetzner-cloud-controller-manager/pull/49)
* [PR rate limiting hcloud](https://github.com/syself/hetzner-cloud-controller-manager/pull/20)
* Upstream has three `ServerGetList` implementations: cache, rate-limited, mock. Our fork has two: mock, cached.

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

* Make ProviderID configurable (hrobot://NNN vs hcloud://bm-NNN)
* Sort Go imports
* Compare linters of upstream with the linters of our other repos.
* [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)
* [PR add version information to the controller binary](https://github.com/syself/hetzner-cloud-controller-manager/pull/28): Build process is different in upstream.
* Upstream has three `ServerGetList` implementations: cache, rate-limited, mock. Our fork has two: mock, cached.

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

* [PR hotreload credentials, when mounted secret changed](https://github.com/syself/hetzner-cloud-controller-manager/pull/49)
* [separate user agent from HCCM](https://github.com/syself/hetzner-cloud-controller-manager/pull/42): Make this configurable in upstream.
* [PR getInstanceTypeOfRobotServer: convert invalid characters to dashes](https://github.com/syself/hetzner-cloud-controller-manager/pull/40)
* [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.
* [Fix InstanceExists for baremetal servers, check node name](https://github.com/syself/hetzner-cloud-controller-manager/pull/32)
Expand All @@ -42,8 +37,6 @@ PRs which are **not** needed in upstream, because upstream has this feature:
* [robot cache](https://github.com/syself/hetzner-cloud-controller-manager/pull/19)
* [Support for robot](https://github.com/syself/hetzner-cloud-controller-manager/pull/1)

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.

Files moved by upstream in their fork:

* internal/robot/client/cache/client.go (from Janis Okt 2023) --> internal/robot/cache.go (by Julian Nov 2023)
Expand All @@ -54,10 +47,6 @@ Files moved by upstream in their fork:
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,
don't pick a feature. Instead try to get our features into upstream, and update or dependencies.

TODO:

* from quay.io to ghcr.io

## Installing Syself CCM

```sh
Expand Down