Skip to content
This repository has been archived by the owner on Mar 22, 2024. It is now read-only.

Deny production runs of example.org trust domains #229

Merged
merged 22 commits into from Sep 25, 2023

Conversation

kfox1111
Copy link
Contributor

@kfox1111 kfox1111 commented Apr 21, 2023

This pr adds some tests to ensure that if the user is deploying for production that they set appropriate settings.

fixes: #195

Copy link
Contributor

@marcofranssen marcofranssen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really want to enforce people to override? If they are just doing a quick install for testing, shouldn't that be possible with the default values?

If we want people to explicitly set those it would be better to remove the defaults.

This feels a bit like a unnecessary additional config value.

@kfox1111
Copy link
Contributor Author

Do we really want to enforce people to override? If they are just doing a quick install for testing, shouldn't that be possible with the default values?

That's the point of the pr. If you just helm install the chart, it just works with example.org for a quick install for testing as it does today.

If you say explicitly, your trying to deploy for production by adding examples/production/values.yaml, then it forces you to specify the things you should be specifying. No one should be deploying a production spire as example.org? The pr helps you find all the things you need to override to get a valid production site by enforcing you set them.

If we want people to explicitly set those it would be better to remove the defaults.

That would make the, "just kick the tires" install much harder. But I could get behind that if there is agreement that is easier. It would be less complicated in the chart, just harder to get an example going. We could put the example values in examples/testing-deployment/values.yaml or something and then have people need to use that for a test deployment?

This feels a bit like a unnecessary additional config value.

Necessary or unnecessary depends on the usability path question above.

charts/spire/charts/spire-agent/templates/configmap.yaml Outdated Show resolved Hide resolved
@edwbuck edwbuck changed the title Start of some install time tests for production Deny production runs of example.org trust domains Jun 27, 2023
@edwbuck edwbuck dismissed their stale review June 28, 2023 21:02

Side bar commentary by Marco with Kevin indicate that other maintainers are ok with the idea that the initial installation of SPIRE using these Helm charts not be production ready.

Copy link
Contributor Author

@kfox1111 kfox1111 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update to include new global.

Also, set default back to false until we determine that tests should be rewritten

@kfox1111
Copy link
Contributor Author

kfox1111 commented Sep 5, 2023

Something like productionChecks for the value instead.

@faisal-memon
Copy link
Contributor

Something like productionChecks for the value instead.

That sounds good to me.

@faisal-memon faisal-memon added this to the 0.14.0 milestone Sep 6, 2023
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
Signed-off-by: kfox1111 <Kevin.Fox@pnnl.gov>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
kfox1111 and others added 2 commits September 20, 2023 08:46
Co-authored-by: Faisal Memon <fymemon@yahoo.com>
Signed-off-by: kfox1111 <Kevin.Fox@pnnl.gov>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
@@ -24,6 +24,9 @@ global:
## @param global.spire.image.registry Override all Spire image registries at once
registry: ""

## @param global.spire.productionChecks Check values, such as trustDomain, are suitable for production deployment
productionChecks: false
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

kfox1111 and others added 4 commits September 20, 2023 12:39
Co-authored-by: Marco Franssen <marco.franssen@gmail.com>
Signed-off-by: kfox1111 <Kevin.Fox@pnnl.gov>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
@marcofranssen marcofranssen enabled auto-merge (squash) September 21, 2023 05:58
examples/production/values.yaml Outdated Show resolved Hide resolved
Co-authored-by: Marco Franssen <marco.franssen@gmail.com>
Signed-off-by: kfox1111 <Kevin.Fox@pnnl.gov>
Copy link
Contributor

@marcofranssen marcofranssen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀

@marcofranssen marcofranssen merged commit 50825d9 into main Sep 25, 2023
44 checks passed
@marcofranssen marcofranssen deleted the production-settings-check branch September 25, 2023 19:06
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add test for global config overrides
4 participants