stackitcloud / external-dns-stackit-webhook

External-DNS Webhook Provider to manage STACKIT DNS Records
https://www.stackit.de
Apache License 2.0
12 stars 4 forks source link

deps(refactor) Switch from `stackit-dns-api-client-go` to `stackit-sdk-go` #14

Closed SimonKienzler closed 6 months ago

SimonKienzler commented 6 months ago

This PR replaces the previously used https://github.com/stackitcloud/stackit-dns-api-client-go with the official https://github.com/stackitcloud/stackit-sdk-go in order to

  1. remove the dependency on a one-off client SDK that needs to be maintained separately and
  2. allow users to make use of features provided by the STACKIT SDK, such as additional authentication options.

The largest portion of the changes in terms of LoC are struct type switches, which should not be too much of an issue. However, as I was previously unfamiliar with the code base, I'd like to point reviewers to the following changes, which might be worth a closer look:

SimonKienzler commented 6 months ago

@PatrickKoss just FYI, we tested a pre-build of the code in this PR in our environment, and both the Key and the Token flow work as expected. For the token flow, it's almost a drop-in replacement, the upgrade path only consists of changing AUTH_TOKEN to STACKIT_SERVICE_ACCOUNT_TOKEN in the Deployment's env settings, as demonstrated in the updated README.

SimonKienzler commented 6 months ago

@PatrickKoss PTAL 😊

BTW, what's up with the failing check for a semantic PR title? I based the title on https://github.com/stackitcloud/external-dns-stackit-webhook/blob/main/.github/semantic.yml and thought it fulfills the requirements 🤔

PatrickKoss commented 6 months ago

@PatrickKoss PTAL 😊

BTW, what's up with the failing check for a semantic PR title? I based the title on https://github.com/stackitcloud/external-dns-stackit-webhook/blob/main/.github/semantic.yml and thought it fulfills the requirements 🤔

its somehow broken :D That is something we need to fix #soon