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

Attempt at modernizing the sidecar SPIRE integration doc #15574

Merged
merged 23 commits into from
Aug 23, 2024
Merged

Attempt at modernizing the sidecar SPIRE integration doc #15574

merged 23 commits into from
Aug 23, 2024

Conversation

bleggett
Copy link
Contributor

@bleggett bleggett commented Aug 20, 2024 •
edited
Loading

Description

  1. SPIRE has Helm charts, we should refer to those and not have our own in-tree SPIRE installation YAML (with WAY out of date SPIRE image refs and config)

  2. In general, refer back to the SPIRE docs and don't make this a SPIRE tutorial - focus on the Istio-specific bits.

  3. Align with current best practices (use upstream Helm charts, recommend controller manager, CSI driver only, etc)

  4. Misc tweaks.

Fixes: #15510

Will open an istio-side PR to delete this once this is in.

Reviewers

  • Ambient
  • Docs
  • Installation
  • Networking
  • Performance and Scalability
  • Extensions and Telemetry
  • Security
  • Test and Release
  • User Experience
  • Developer Infrastructure
  • Localization/Translation

@bleggett
This is wildly out of date
8429a6b 
Signed-off-by: Benjamin Leggett <benjamin.leggett@solo.io>
@bleggett bleggett requested a review from a team as a code owner August 20, 2024 00:06
@istio-testing istio-testing added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 20, 2024
bleggett and others added 3 commits August 19, 2024 20:09
@bleggett
Fixup
60d7ae0 
Signed-off-by: Benjamin Leggett <benjamin.leggett@solo.io>
@craigbox
Replace snippet syntax to make the site compile
b0bab26
@craigbox
more
3a4ad2a
@craigbox
Copy link
Contributor

Committed a couple of fixes to make the site build so I can look at the preview, which is https://deploy-preview-15574--preliminary-istio.netlify.app/latest/docs/ops/integrations/spire/.

craigbox
craigbox reviewed Aug 20, 2024
View reviewed changes
content/en/docs/ops/integrations/spire/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/integrations/spire/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/integrations/spire/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/integrations/spire/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/integrations/spire/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/integrations/spire/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/integrations/spire/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/integrations/spire/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/integrations/spire/index.md Show resolved Hide resolved
content/en/docs/ops/integrations/spire/index.md Show resolved Hide resolved
@bleggett
Copy link
Contributor Author

Committed a couple of fixes to make the site build so I can look at the preview, which is https://deploy-preview-15574--preliminary-istio.netlify.app/latest/docs/ops/integrations/spire/.

Yep thanks, and sorry - should have marked this as WIP.

bleggett and others added 6 commits August 20, 2024 12:30
@bleggett @craigbox
Update content/en/docs/ops/integrations/spire/index.md
b079999 
Co-authored-by: Craig Box <craig.box@gmail.com>
@bleggett @craigbox
Update content/en/docs/ops/integrations/spire/index.md
c435266 
Co-authored-by: Craig Box <craig.box@gmail.com>
@bleggett @craigbox
Update content/en/docs/ops/integrations/spire/index.md
94cdb7f 
Co-authored-by: Craig Box <craig.box@gmail.com>
@bleggett @craigbox
Update content/en/docs/ops/integrations/spire/index.md
a2db480 
Co-authored-by: Craig Box <craig.box@gmail.com>
@bleggett @craigbox
Update content/en/docs/ops/integrations/spire/index.md
4d5d4ea 
Co-authored-by: Craig Box <craig.box@gmail.com>
@bleggett @craigbox
Update content/en/docs/ops/integrations/spire/index.md
3044976 
Co-authored-by: Craig Box <craig.box@gmail.com>
dhawton
dhawton reviewed Aug 20, 2024
View reviewed changes
Copy link
Member

@dhawton dhawton left a comment

Choose a reason for hiding this comment

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

Few more nits

content/en/docs/ops/integrations/spire/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/integrations/spire/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/integrations/spire/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/integrations/spire/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/integrations/spire/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/integrations/spire/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/integrations/spire/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/integrations/spire/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/integrations/spire/index.md Outdated Show resolved Hide resolved
@bleggett
Review comments, lints, fixups
9a8a313 
Signed-off-by: Benjamin Leggett <benjamin.leggett@solo.io>
@bleggett
Genfix
cab76f9 
Signed-off-by: Benjamin Leggett <benjamin.leggett@solo.io>
@istio-testing istio-testing added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 20, 2024
@bleggett bleggett requested review from craigbox and dhawton August 20, 2024 17:55
@bleggett
Fix
4ee3929 
Signed-off-by: Benjamin Leggett <benjamin.leggett@solo.io>
@bleggett
Twiddle
33914af 
Signed-off-by: Benjamin Leggett <benjamin.leggett@solo.io>
@bleggett
Tests
8141fdb 
Signed-off-by: Benjamin Leggett <benjamin.leggett@solo.io>
@bleggett
Fix
604fbb0 
Signed-off-by: Benjamin Leggett <benjamin.leggett@solo.io>
@bleggett
Wrong namespace
34667dd 
Signed-off-by: Benjamin Leggett <benjamin.leggett@solo.io>
@bleggett
Statefulset now
c874d6e 
Signed-off-by: Benjamin Leggett <benjamin.leggett@solo.io>
@bleggett bleggett requested review from a team as code owners August 20, 2024 21:23
@bleggett
Fixup
92d2855 
Signed-off-by: Benjamin Leggett <benjamin.leggett@solo.io>
@bleggett
More test fixup
5d12452 
Signed-off-by: Benjamin Leggett <benjamin.leggett@solo.io>
@bleggett
fix
d3b0dd7 
Signed-off-by: Benjamin Leggett <benjamin.leggett@solo.io>
@craigbox
Copy link
Contributor

/test doc.test.profile-none

@craigbox
Copy link
Contributor

While we're doing nits, would you mind s/Federation/federation/ in the heading on L371?

@bleggett
Reviews, testfix
a0c976f 
Signed-off-by: Benjamin Leggett <benjamin.leggett@solo.io>
@bleggett
Gen
055d589 
Signed-off-by: Benjamin Leggett <benjamin.leggett@solo.io>
@bleggett bleggett requested a review from craigbox August 21, 2024 17:51
@bleggett
Copy link
Contributor Author

@craigbox should be good, PTAL.

craigbox
craigbox approved these changes Aug 23, 2024
View reviewed changes
Copy link
Contributor

@craigbox craigbox left a comment

Choose a reason for hiding this comment

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

YOLO

@craigbox
Copy link
Contributor

/cherry-pick release-1.23

@istio-testing
Copy link
Contributor

@craigbox: once the present PR merges, I will cherry-pick it on top of release-1.23 in a new PR and assign it to you.

In response to this:

/cherry-pick release-1.23

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@craigbox
Copy link
Contributor

test flake: #15603

/retest

@istio-testing istio-testing merged commit e3638ee into istio:master Aug 23, 2024
13 checks passed
@istio-testing
Copy link
Contributor

@craigbox: new pull request created: #15604

In response to this:

/cherry-pick release-1.23

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@istio-testing istio-testing mentioned this pull request Aug 23, 2024
Merged
wilsonwu added a commit to wilsonwu/istio.io that referenced this pull request Aug 23, 2024
@wilsonwu
Sync istio#15574 Attempt at modernizing the sidecar SPIRE integration…
e1f51d4 
… doc into Chinese
@wilsonwu wilsonwu mentioned this pull request Aug 23, 2024
Merged
11 tasks
istio-testing pushed a commit that referenced this pull request Aug 23, 2024
@wilsonwu
[zh] Sync #15574 Attempt at modernizing the sidecar SPIRE integration…
1064a1e 
… doc into Chinese (#15605)

* Sync #15574 Attempt at modernizing the sidecar SPIRE integration doc into Chinese

* finish translate

* fix lint
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@howardjohn howardjohn howardjohn approved these changes

@craigbox craigbox craigbox approved these changes

@dhawton dhawton Awaiting requested review from dhawton

Assignees
No one assigned
Labels
area/environments kind/docs size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

SPIRE docs should stop using hand-constructed YAML templates and just use upstream SPIRE Helm charts
6 participants
@bleggett @craigbox @istio-testing @howardjohn @dhawton @istio-policy-bot