operator: Refactor CreateOrUpdateLokiStack handler #11592
Merged
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
|
Trivy scan found the following vulnerabilities:
|
periklis
force-pushed
the
refactor-lokistack-upsert-handler
branch
from
7fab92e to
900a5a1
Compare
| ) | ||
|
|
||
| var hashSeparator = []byte(",") | ||
|
|
||
| // ExtractSecret reads a k8s secret into a manifest object storage struct if valid. | ||
| func ExtractSecret(s *corev1.Secret, secretType lokiv1.ObjectStorageSecretType) (*storage.Options, error) { | ||
| func getSecret(ctx context.Context, k k8s.Client, stack *lokiv1.LokiStack) (*corev1.Secret, error) { |
There was a problem hiding this comment.
Thinking about error handling, if we plan for this function to be used to fetch other secrets other than the object storage one then, we should also provide a way to configure the DegradedError struct.
I am however more of the opinion of changing the name of this function to be more specific and not allude to the idea of reusing it when we need to get secrets from k8s. Instead, we should create a new function for getting new secrets out of k8s.
xperimental
reviewed
Jan 12, 2024
There was a problem hiding this comment.
Good idea overall and seems to work just as before 👍
Only have a few minor comments. In general I noticed a few comments that we had before because most functions were public, which are not necessary anymore (because they do not document any special behaviour).
operator/internal/handlers/internal/gateway/tenant_configsecret.go
Outdated
Show resolved
Hide resolved
| } | ||
|
|
||
| // extractSecret reads a k8s secret into a manifest object storage struct if valid. | ||
| func extractSecret(s *corev1.Secret, secretType lokiv1.ObjectStorageSecretType) (storage.Options, error) { |
There was a problem hiding this comment.
Why don't we stick to the pointered return type?
There was a problem hiding this comment.
Because when we pass back to the manifests.Options we use a non-pointered version.
xperimental
approved these changes
Jan 12, 2024
periklis
added a commit
to periklis/loki
that referenced
this pull request
Jan 12, 2024
Co-authored-by: Robert Jacob <[email protected]>
periklis
added a commit
to periklis/loki
that referenced
this pull request
Jan 12, 2024
Co-authored-by: Robert Jacob <[email protected]>
periklis
added a commit
to periklis/loki
that referenced
this pull request
Jan 12, 2024
Co-authored-by: Robert Jacob <[email protected]>
periklis
added a commit
to periklis/loki
that referenced
this pull request
Jan 12, 2024
Co-authored-by: Robert Jacob <[email protected]>
8 tasks
periklis
added a commit
to periklis/loki
that referenced
this pull request
Jan 18, 2024
Co-authored-by: Robert Jacob <[email protected]>
periklis
added a commit
to periklis/loki
that referenced
this pull request
Jan 18, 2024
Co-authored-by: Robert Jacob <[email protected]>
periklis
added a commit
to periklis/loki
that referenced
this pull request
Jan 18, 2024
Co-authored-by: Robert Jacob <[email protected]>
openshift-merge-bot bot
added a commit
to openshift/loki
that referenced
this pull request
Jan 18, 2024
[release-5.8] LOG-4969: Backport PRs grafana#11624 and grafana#11592
openshift-merge-bot bot
added a commit
to openshift/loki
that referenced
this pull request
Jan 18, 2024
[release-5.7] LOG-4968: Backport PRs grafana#11624 and grafana#11592
openshift-merge-bot bot
added a commit
to openshift/loki
that referenced
this pull request
Jan 18, 2024
[release-5.6] LOG-4967: Backport PRs grafana#11624 and grafana#11592
rhnasc
pushed a commit
to inloco/loki
that referenced
this pull request
Apr 12, 2024
Co-authored-by: Robert Jacob <[email protected]>
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:
Refactor the
CreateOrUpdateLokiStackhandler to separate functions to re-instantiate readability.Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
The gist is moving and isolating all internal packages code into the internal package itself for gateway, storage and rules. This enhances readability in the handler itself. In addition the internal package's public interface is down to 1 or max 2 functions (i.e.
{gateway,storage,rules}.BuildOptions) and the use cases can be tested locally w/o the heavy handler setup code.Checklist
CONTRIBUTING.mdguide (required)CHANGELOG.mdupdatedadd-to-release-noteslabeldocs/sources/setup/upgrade/_index.mdproduction/helm/loki/Chart.yamland updateproduction/helm/loki/CHANGELOG.mdandproduction/helm/loki/README.md. Example PRdeprecated-config.yamlanddeleted-config.yamlfiles respectively in thetools/deprecated-config-checkerdirectory. Example PRcc @JoaoBraveCoding