feat(ec_join): update handler to return tcp connections required #5004
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JGAntunes
commented
Nov 15, 2024
Comment on lines
+1
to
+35
| package kubeclient | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/replicatedhq/kots/pkg/k8sutil" | ||
| kbclient "sigs.k8s.io/controller-runtime/pkg/client" | ||
| ) | ||
|
|
||
| var _ KubeClientBuilder = (*Builder)(nil) | ||
| var _ KubeClientBuilder = (*MockBuilder)(nil) | ||
|
|
||
| // KubeClientBuilder interface is used as an abstraction to get a kube client. Useful to mock the client in tests. | ||
| type KubeClientBuilder interface { | ||
| GetKubeClient(ctx context.Context) (kbclient.Client, error) | ||
| } | ||
|
|
||
| // Builder is the default implementation of KubeClientBuilder. It returns a regular kube client. | ||
| type Builder struct{} | ||
|
|
||
| // GetKubeClient returns a regular kube client. | ||
| func (b *Builder) GetKubeClient(ctx context.Context) (kbclient.Client, error) { | ||
| return k8sutil.GetKubeClient(ctx) | ||
| } | ||
|
|
||
| // MockBuilder is a mock implementation of KubeClientBuilder. It returns the client that was set in the struct allowing | ||
| // you to set a fakeClient for example. | ||
| type MockBuilder struct { | ||
| Client kbclient.Client | ||
| } | ||
|
|
||
| // GetKubeClient returns the client that was set in the struct. | ||
| func (b *MockBuilder) GetKubeClient(ctx context.Context) (kbclient.Client, error) { | ||
| return b.Client, nil | ||
| } |
There was a problem hiding this comment.
The general idea is to allow us to get a new k8s client on the fly within the handler VS the alternative which would be to have a single client instantiated when the handler is created and shared between all the endpoints. This ensures we keep functionality as is while having the ability to stub/mock the kube client.
JGAntunes
commented
Nov 15, 2024
Comment on lines
+47
to
+70
| name: "not an embedded cluster", | ||
| httpStatus: http.StatusBadRequest, | ||
| embeddedClusterID: "", | ||
| }, | ||
| { | ||
| name: "store returns error", | ||
| httpStatus: http.StatusInternalServerError, | ||
| embeddedClusterID: "cluster-id", | ||
| getRoles: func(*testing.T, string) ([]string, error) { | ||
| return nil, fmt.Errorf("some error") | ||
| }, | ||
| }, | ||
| { | ||
| name: "store gets passed the provided token", | ||
| httpStatus: http.StatusInternalServerError, | ||
| embeddedClusterID: "cluster-id", | ||
| token: "some-token", | ||
| getRoles: func(t *testing.T, token string) ([]string, error) { | ||
| require.Equal(t, "some-token", token) | ||
| return nil, fmt.Errorf("some error") | ||
| }, | ||
| }, | ||
| { | ||
| name: "bootstrap token secret creation succeeds and it matches returned K0SToken", |
There was a problem hiding this comment.
Went a bit overboard with testing other (unrelated) scenarios, but thought would be useful + it was a good opportunity for me to see how the join process works. Happy to move these to a separate PR if folks prefer.
JGAntunes
force-pushed
the
jgantunes/sc-113015/preflight-remote-access-on-join
branch
from
55b851e to
715977a
Compare
JGAntunes
changed the title
sgalsaleh
approved these changes
Nov 25, 2024
JGAntunes
deleted the
jgantunes/sc-113015/preflight-remote-access-on-join
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
On join, return all the TCP endpoints the joining node needs to preflight for to ensure a successful connection to the cluster
Which issue(s) this PR fixes:
https://app.shortcut.com/replicated/story/113015/preflight-remote-access-on-join
Does this PR require a test?
Yes, added tests to the handler and to the newly added method
Also run some manual tests on an EC local dev deployment:
Does this PR require a release note?
Does this PR require documentation?
NONE