-
Notifications
You must be signed in to change notification settings - Fork 91
CLOUDP-266544: Support local resource credentials #1782
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
f36e131
CLOUDP-266544: Support local resource credentials
josvazg 11a8697
Add e2e and conversion testing
josvazg c2922a6
Allow test with local credentials in CI
josvazg 4198861
Add test to check missing creds
josvazg c208832
Applied suggested changes
josvazg 9fa0baa
Simplify resolution
josvazg 6450dea
Do not use different local creds values
josvazg File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
package api | ||
|
||
type LocalRef string | ||
|
||
// +k8s:deepcopy-gen=false | ||
|
||
// CredentialsProvider gives access to custom local credentials | ||
type CredentialsProvider interface { | ||
Credentials() *LocalObjectReference | ||
} | ||
|
||
// +k8s:deepcopy-gen=false | ||
|
||
// ResourceWithCredentials is to be implemented by all CRDs using custom local credentials | ||
type ResourceWithCredentials interface { | ||
CredentialsProvider | ||
GetName() string | ||
GetNamespace() string | ||
} | ||
|
||
// LocalCredentialHolder is to be embedded by Specs of CRDs using custom local credentials | ||
type LocalCredentialHolder struct { | ||
ConnectionSecret *LocalObjectReference `json:"connectionSecret,omitempty"` | ||
} | ||
|
||
func (ch *LocalCredentialHolder) Credentials() *LocalObjectReference { | ||
return ch.ConnectionSecret | ||
} |
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
package api | ||
|
||
// LocalObjectReference is a reference to an object in the same namespace as the referent | ||
type LocalObjectReference struct { | ||
// Name of the resource being referred to | ||
// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | ||
Name string `json:"name"` | ||
} |
This file contains hidden or 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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do we need this spread across 2 interfaces, rather than just having the LocalObjectReference in this one?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because
CredentialsProvider
can be implemented directly by the simple struct object, which is applied to theSpec
sub-struct.The wider interface
ResourceWithCredentials
applies to the actual CRD as a whole, not just the extendedSpec
.It is the simplest way I found to make this as reusable as possible. The consumers just need to embed the
LocalCredentialHolder
struct in theSpec
and implement the delegation to theCredentialsProvider
interface it implements from the CRD struct.