Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add initial documentation for the helm-charts-hardened chart #290

Merged
merged 58 commits into from
Apr 3, 2024
Merged

Add initial documentation for the helm-charts-hardened chart #290

merged 58 commits into from
Apr 3, 2024

Conversation

kfox1111
Copy link
Contributor

No description provided.

@netlify Netlify
Copy link

netlify bot commented Dec 30, 2023 •
edited
Loading

✅ Deploy Preview for spiffe ready!

Name Link
🔨 Latest commit f0827eb
🔍 Latest deploy log https://app.netlify.com/sites/spiffe/deploys/660dc8c82a0e9b0008016da4
😎 Deploy Preview https://deploy-preview-290--spiffe.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@kfox1111 kfox1111 changed the title Helm charts hardened Add initial documentation for the help-charts-hardened chart Dec 30, 2023
@kfox1111 kfox1111 marked this pull request as draft December 30, 2023 04:07
@kfox1111 kfox1111 mentioned this pull request Dec 31, 2023
Closed
@kfox1111 kfox1111 changed the title Add initial documentation for the help-charts-hardened chart Add initial documentation for the helm-charts-hardened chart Jan 2, 2024
@kfox1111 kfox1111 marked this pull request as ready for review January 23, 2024 09:22
@kfox1111 kfox1111 mentioned this pull request Feb 18, 2024
Merged
faisal-memon
faisal-memon approved these changes Mar 5, 2024
View reviewed changes
Copy link
Contributor

@faisal-memon faisal-memon left a comment

Choose a reason for hiding this comment

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

Thanks @kfox1111 for creating these docs. They look great.

@quintessence
Copy link
Contributor

I am taking a look at this and #293 - which should I look at first / primarily?

@kfox1111
Copy link
Contributor Author

I am taking a look at this and #293 - which should I look at first / primarily?

This one. #293 is in progress and adds advanced configuration on top of this one. This one can merge without #293 being ready.

Thanks for reviewing! :)

@kfox1111
Copy link
Contributor Author

Anything I can do to help get this merged? It would be very beneficial to users to have docs they can use soon.

@quintessence
Copy link
Contributor

I don't have merging powers unfortunately - I'm just going through to make sure I can follow the instructions / that they work / etc. Once complete I'll post another comment here :)

mchurichi
mchurichi reviewed Mar 28, 2024
View reviewed changes
content/docs/latest/spire-helm-charts-hardened-advanced/_index.md Show resolved Hide resolved
content/docs/latest/spire-helm-charts-hardened-about/exposing.md Outdated Show resolved Hide resolved
content/docs/latest/spire-helm-charts-hardened-about/recommendations.md Show resolved Hide resolved
content/docs/latest/spire-helm-charts-hardened-about/recommendations.md Outdated Show resolved Hide resolved
content/docs/latest/spire-helm-charts-hardened-about/recommendations.md Outdated

## Strict Mode

Option `global.spire.recommendations.strictMode` adds additional checks on the configuration to help ensure your configuration is production ready.
Copy link
Member

Choose a reason for hiding this comment

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

Is there somewhere readers can learn more about what these additional checks are?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It mostly makes sure they explicitly set stuff like, the trust domain, cluster name, and ca related settings. Basically all of the settings that were mentioned in the production installation instructions. Would it be helpful to try and document it here and keep it in sync with the chart, or we could refer back to the install instructions?

Copy link
Member

Choose a reason for hiding this comment

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

Oh it makes sense now. I thought it automatically sets some settings like enhanced recommendations. A link to the install instructions should work.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated

content/docs/latest/spire-helm-charts-hardened-about/identifiers.md Outdated Show resolved Hide resolved
content/docs/latest/spire-helm-charts-hardened-about/identifiers.md Outdated Show resolved Hide resolved
content/docs/latest/spire-helm-charts-hardened-about/identifiers.md Outdated Show resolved Hide resolved
content/docs/latest/spire-helm-charts-hardened-about/namespaces.md Outdated Show resolved Hide resolved
content/docs/latest/spire-helm-charts-hardened-advanced/mirror.md Outdated Show resolved Hide resolved
@kfox1111
Copy link
Contributor Author

@mchurichi Thank you for the review! :)

kfox1111 and others added 4 commits March 28, 2024 17:08
@kfox1111 @mchurichi
Apply suggestions from code review
de77cc8 
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

Co-authored-by: Maximiliano Churichi <mchurichi@gmail.com>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
@kfox1111
Incorperate feedback
d9198df 
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
@kfox1111
Incorperate feedback
ded8e83 
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
@kfox1111
Update content/docs/latest/spire-helm-charts-hardened-about/recommend…
0244584 
…ations.md

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
mchurichi
mchurichi reviewed Apr 2, 2024
View reviewed changes
content/docs/latest/spire-helm-charts-hardened-about/recommendations.md Outdated

## Strict Mode

Option `global.spire.recommendations.strictMode` adds additional checks on the configuration to help ensure your configuration is production ready.
Copy link
Member

Choose a reason for hiding this comment

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

Oh it makes sense now. I thought it automatically sets some settings like enhanced recommendations. A link to the install instructions should work.

content/docs/latest/spire-helm-charts-hardened-about/recommendations.md Outdated Show resolved Hide resolved
content/docs/latest/spire-helm-charts-hardened-about/recommendations.md Show resolved Hide resolved
content/docs/latest/spire-helm-charts-hardened-advanced/_index.md Show resolved Hide resolved
v0lkan and others added 3 commits April 2, 2024 18:56
@v0lkan @kfox1111
add VMware Secrets Manager as a consumer (spiffe#301)
31a004f 
Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
@kfox1111
Incorperate feedback
e096452 
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
@kfox1111 @mchurichi
Apply suggestions from code review
6a3be63 
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

Co-authored-by: Maximiliano Churichi <mchurichi@gmail.com>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
mchurichi
mchurichi approved these changes Apr 3, 2024
View reviewed changes
Copy link
Member

@mchurichi mchurichi left a comment

Choose a reason for hiding this comment

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

LGTM, thank you @kfox1111!

@kfox1111
Copy link
Contributor Author

kfox1111 commented Apr 3, 2024

Anything left to do to merge?

mchurichi
mchurichi reviewed Apr 3, 2024
View reviewed changes
Copy link
Member

@mchurichi mchurichi left a comment

Choose a reason for hiding this comment

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

I did one last pass and found just a nit, other than that looks good and should be ready to be merged.

content/docs/latest/spire-helm-charts-hardened-about/recommendations.md Outdated Show resolved Hide resolved
@kfox1111
Incorperate feedback
f0827eb 
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
@mchurichi mchurichi merged commit 2aa1e90 into spiffe:master Apr 3, 2024
5 checks passed
@kfox1111 kfox1111 deleted the helm-charts-hardened branch April 4, 2024 00:38
@v0lkan v0lkan mentioned this pull request Apr 4, 2024
Closed
quintessence added a commit to quintessence/spiffe.io-fork that referenced this pull request May 7, 2024
@kfox1111 @mchurichi
@faisal-memon @quintessence @v0lkan
Add initial documentation for the helm-charts-hardened chart (spiffe#290
832e254 
)

* Adds PR template

Signed-off-by: Maximiliano Churichi <mchurichi@gmail.com>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Add support for building/testing with podman

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Add initial documentation for the help-charts-hardened chart

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Add ingress documentation

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Add basic federation docs and misc fixes

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Add recommendations, some nested spire docs, and misc changes

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Remove unneeded bits

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Add Namespace documentation

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Add initial mirroring docs

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Update docs for external agents

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Can't use controller manager with join tokens

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* More examples

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Make image better

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Update diagrams

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Update things

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Reorder docs

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* More updates

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Incorperate feedback

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Incorperate feedback

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Add join token details

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Update

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Incorperate feedback

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Better diagram

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Break out ready docs from nonready

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Update content/docs/latest/spire-helm-charts-hardened-about/installation.md

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Fix typo

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Add support for building/testing with podman (spiffe#289)

* Add support for building/testing with podman

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Update Makefile

Signed-off-by: kfox1111 <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>

* Apply suggestions from code review

Co-authored-by: Faisal Memon <fymemon@yahoo.com>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Incorperate feedback

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Incorperate feedback

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Apply suggestions from code review

Co-authored-by: Faisal Memon <fymemon@yahoo.com>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Incorperate feedback

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Apply suggestions from code review

Co-authored-by: Faisal Memon <fymemon@yahoo.com>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Apply suggestions from code review

Co-authored-by: Faisal Memon <fymemon@yahoo.com>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Apply suggestions from code review

Co-authored-by: Faisal Memon <fymemon@yahoo.com>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Apply suggestions from code review

Co-authored-by: Faisal Memon <fymemon@yahoo.com>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Update content/docs/latest/spire-helm-charts-hardened-about/exposing.md

Co-authored-by: Faisal Memon <fymemon@yahoo.com>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Update content/docs/latest/spire-helm-charts-hardened-about/exposing.md

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Apply suggestions from code review

Co-authored-by: Faisal Memon <fymemon@yahoo.com>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Apply suggestions from code review

Co-authored-by: Faisal Memon <fymemon@yahoo.com>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Update content/docs/latest/spire-helm-charts-hardened-about/identifiers.md

Co-authored-by: Faisal Memon <fymemon@yahoo.com>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Apply suggestions from code review

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Incorperate feedback

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Apply suggestions from code review

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Removed HeadBucket

Signed-off-by: Quintessence <quintessenceanx@gmail.com>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Update install instructions

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Apply suggestions from code review

Co-authored-by: Faisal Memon <fymemon@yahoo.com>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Apply suggestions from code review

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

Co-authored-by: Maximiliano Churichi <mchurichi@gmail.com>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Incorperate feedback

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Incorperate feedback

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Update content/docs/latest/spire-helm-charts-hardened-about/recommendations.md

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* add VMware Secrets Manager as a consumer (spiffe#301)

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Incorperate feedback

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Apply suggestions from code review

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

Co-authored-by: Maximiliano Churichi <mchurichi@gmail.com>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

* Incorperate feedback

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>

---------

Signed-off-by: Maximiliano Churichi <mchurichi@gmail.com>
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
Signed-off-by: kfox1111 <Kevin.Fox@pnnl.gov>
Signed-off-by: Quintessence <quintessenceanx@gmail.com>
Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>
Co-authored-by: Maximiliano Churichi <mchurichi@gmail.com>
Co-authored-by: Faisal Memon <fymemon@yahoo.com>
Co-authored-by: Quintessence <quintessenceanx@gmail.com>
Co-authored-by: Volkan Özçelik <volkan.ozcelik@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mrsabath mrsabath mrsabath left review comments

@mchurichi mchurichi mchurichi approved these changes

@faisal-memon faisal-memon faisal-memon approved these changes

@sanderson042 sanderson042 Awaiting requested review from sanderson042 sanderson042 is a code owner

@ajessup ajessup Awaiting requested review from ajessup ajessup is a code owner

@Andres-GC Andres-GC Awaiting requested review from Andres-GC Andres-GC is a code owner

@evan2645 evan2645 Awaiting requested review from evan2645 evan2645 is a code owner

@umairmkhan umairmkhan Awaiting requested review from umairmkhan umairmkhan is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@kfox1111 @faisal-memon @quintessence @mchurichi @mrsabath @v0lkan