-
Notifications
You must be signed in to change notification settings - Fork 16.5k
Helm: generate jwt-secret on installation only #57415
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
Open
arkadiuszbach
wants to merge
1
commit into
apache:main
Choose a base branch
from
arkadiuszbach:fix/helm-create-jwt-with-preinstall-hook
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # distributed with this work for additional information | ||
| # regarding copyright ownership. The ASF licenses this file | ||
| # to you under the Apache License, Version 2.0 (the | ||
| # "License"); you may not use this file except in compliance | ||
| # with the License. You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, | ||
| # software distributed under the License is distributed on an | ||
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| # KIND, either express or implied. See the License for the | ||
| # specific language governing permissions and limitations | ||
| # under the License. | ||
| from __future__ import annotations | ||
|
|
||
| import base64 | ||
|
|
||
| import jmespath | ||
| from chart_utils.helm_template_generator import render_chart | ||
|
|
||
|
|
||
| class TestJwtSecret: | ||
| """Tests jwt secret.""" | ||
|
|
||
| def test_should_add_annotations_to_jwt_secret(self): | ||
| """Test that annotations are properly added to JWT secret and the secret is correctly encoded. | ||
|
|
||
| This test verifies that: | ||
| 1. Custom annotations can be added to the JWT secret | ||
| 2. The JWT secret is properly base64 encoded in the template | ||
| 3. The decoded secret matches the input value | ||
| """ | ||
| # Create JWT secret with custom annotation | ||
| docs = render_chart( | ||
| values={ | ||
| "jwtSecret": "verysecret", | ||
| "jwtSecretAnnotations": {"test_annotation": "test_annotation_value"}, | ||
| }, | ||
| show_only=["templates/secrets/jwt-secret.yaml"], | ||
| )[0] | ||
| assert "annotations" in jmespath.search("metadata", docs) | ||
| assert jmespath.search("metadata.annotations", docs)["test_annotation"] == "test_annotation_value" | ||
|
|
||
| # Extract and decode the JWT secret | ||
| jwt_secret_b64 = jmespath.search('data."jwt-secret"', docs).strip('"') | ||
| jwt_secret = base64.b64decode(jwt_secret_b64).decode() | ||
|
|
||
| # Verify the decoded secret matches original input | ||
| assert jwt_secret == "verysecret" |
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.
After some time I think that we could go with the Helm lookup function to determine if it exists or not
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.
I don't recall exactly why, but I have in my mind that there is some funkiness with helm lookup that makes it not great for our needs. But maybe in some of these cases, it's better than nothing?