#1967 Customize K8s services creation in `Kube` service discovery provider - Githubissues

ThreeMammals / Ocelot

.NET API Gateway

https://www.nuget.org/packages/Ocelot

MIT License

8.24k stars 1.62k forks source link

#1967 Customize K8s services creation in `Kube` service discovery provider #2052

Closed raman-m closed 2 months ago

raman-m commented 2 months ago

Closes #1967

1967

I suggest decoupling the `Kube` logic and introducing virtual `public` and `protected` signatures in concrete classes, thus

Use public virtual methods due to interface definitions.
Apply protected virtual methods to enable developers to customize atomic feature/operations by inheriting from existing concrete classes.

Proposed Changes

Slightly refactored the Kube provider → https://github.com/ThreeMammals/Ocelot/pull/2052/commits/5b0485a28ba850cb0e09409273fdd83cfb3a34e1, https://github.com/ThreeMammals/Ocelot/pull/2052/commits/51de5d7c2b2b7f81d29ffc1f491feb067e9cf284
Introduced new interfaces IKubeServiceBuilder and IKubeServiceCreator to decouple Kube logic, adding both to the AddKubernetes extension → https://github.com/ThreeMammals/Ocelot/pull/2052/commits/745c0c99d95779e6f7f2b94c8d9157d529f5a721, https://github.com/ThreeMammals/Ocelot/pull/2052/commits/5ec40934dabee8c93ead83d171d78daf4fb7eb86
Enabled customization of Ocelot's downstream services creation from K8s service entries, allowing developers to override the creation logic → https://github.com/ThreeMammals/Ocelot/pull/2052/commits/3d6140de54c7eb589b84ba484c8ead65d5a278e8
Relocated acceptance tests for Service Discovery providers to a separate folder and namespace Ocelot.AcceptanceTests.ServiceDiscovery → https://github.com/ThreeMammals/Ocelot/pull/2052/commits/14668f7d4061ac4ce49256cd5313aa0dc7bebedf
Established the KubernetesServiceDiscoveryTests class for K8s acceptance tests → https://github.com/ThreeMammals/Ocelot/pull/2052/commits/e51e42666d52cffcfb8a0cfc11f1b7fbd7f5ecff

Key Changes

Issue 1967 logic is found in commit https://github.com/ThreeMammals/Ocelot/pull/2052/commits/3d6140de54c7eb589b84ba484c8ead65d5a278e8. Refer to the GetServiceHostAndPort method which includes new functionality based on the requirements of issue #1967 by @shcant
New unit tests: Pending development...
New acceptance tests: Pending development...

raman-m commented 2 months ago

Ready for final code reviews ✔️

Development Complete❕

raman-m commented 2 months ago

@ggnaegi Could you review please? 🙏

raman-m commented 2 months ago

Ready for delivery ✅

Code review ✔️
Team approvals ✔️
Unit testing ✔️✔️ → KubeServiceBuilderTests and KubeServiceCreatorTests
Acceptance testing ✔️ → KubernetesServiceDiscoveryTests
Feature docs ✔️ → kubernetes.rst → Downstream Scheme vs Port Names