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.

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

Opa blog post #15134

Merged
merged 56 commits into from
Oct 15, 2024
Merged

Opa blog post #15134

merged 56 commits into from
Oct 15, 2024

Conversation

antonioberben
Copy link
Member

@antonioberben antonioberben commented May 16, 2024

Description

This PR adds a blog post about how to use OPA with Istio and the benefits of both.

Adding co-author to the loop: @charlieegan3

Reviewers

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

@istio-testing istio-testing added the do-not-merge/work-in-progress Block merging of a PR because it isn't ready yet. label May 16, 2024
@istio-testing
Copy link
Contributor

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@istio-policy-bot
Copy link

😊 Welcome! This is either your first contribution to the Istio documentation repo, or
it's been a while since you've been here. A few things you should know:

  • You can learn about how we write and maintain documentation, our style guidelines,
    and the available web site features by visiting Contributing to the Docs.

  • In the next few minutes, an automatic preview of your change will be built with
    a full copy of the istio.io website. You can find this preview by clicking on
    the Details link next to the deploy/netlify entry in the status section of this
    page.

  • We care about quality, so we've put in place a number of checks to ensure our documentation
    is top-notch. We do spell checking, sanitize the Markdown, ensure all hyperlinks point to a
    valid location, and more. If your PR doesn't pass one of these checks, you'll see a red X in the
    lint_istio.io entry in the status section. Click on the Details link to get a list of the
    problems with your PR. Fix those problems and push an update; this will automatically re-run the
    tests. Hopefully this time everything will be perfect!

  • Once your changes are accepted and merged into the repository, they will initially show up
    on https://preliminary.istio.io. The changes will be published to https://istio.io
    the next time we do a major release (which typically happens every 3 months or so).
    To publish them sooner, add a cherrypick/release-x.xx label, where x.xx is the current
    release of Istio.

Thanks for contributing!

Courtesy of your friendly welcome wagon.

@istio-testing istio-testing added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label May 16, 2024
@antonioberben antonioberben marked this pull request as ready for review May 16, 2024 12:44
@antonioberben antonioberben requested a review from a team as a code owner May 16, 2024 12:44
@istio-testing istio-testing removed the do-not-merge/work-in-progress Block merging of a PR because it isn't ready yet. label May 16, 2024
@antonioberben antonioberben marked this pull request as draft May 16, 2024 13:44
@istio-testing istio-testing added the do-not-merge/work-in-progress Block merging of a PR because it isn't ready yet. label May 16, 2024
@istio-testing istio-testing added the needs-rebase Indicates a PR needs to be rebased before being merged label May 17, 2024
@istio-testing istio-testing removed the needs-rebase Indicates a PR needs to be rebased before being merged label May 17, 2024
@antonioberben
Copy link
Member Author

/retest

@antonioberben antonioberben marked this pull request as ready for review May 17, 2024 15:33
@istio-testing istio-testing removed the do-not-merge/work-in-progress Block merging of a PR because it isn't ready yet. label May 17, 2024
@craigbox
Copy link
Contributor

Thanks for the submission, @antonioberben!

Some thoughts before diving into a full edit:

  • For content that is timeless and more "how to do something", you probably want to write it as a documentation guide rather than a blog post. This would make a good integration guide with a blog post to announce the publication of it.
  • I think you need to better level-set as to what a "platform" is: we talk about platform teams and platforms as if we all agree on what they are, which I suspect we do not
  • I feel the "how it works" section needs to come before "try it out", so we know what we're trying
  • you say a cluster with Istio installed is a pre-requisite, and then you tell people how to install Istio with iop.yaml which isn't obviously provided
  • Likewise, opa.yaml needs to be provided. For a blog post or guide, we'd normally expect these files to be inline with an explanation of what they contain

Let me know how you'd like to proceed and I can either help get this into shape for a doc page or a revised blog post.

.spelling Outdated Show resolved Hide resolved
@linsun
Copy link
Member

linsun commented May 30, 2024

Hi @antonioberben Nice blog - does this instruction work with ambient as well?

@antonioberben
Copy link
Member Author

Hi @linsun , it does not work in ambient. I could not make it work with it

content/en/blog/2024/l7-policy-with-opa/index.md Outdated Show resolved Hide resolved
content/en/blog/2024/l7-policy-with-opa/index.md Outdated Show resolved Hide resolved
content/en/blog/2024/l7-policy-with-opa/index.md Outdated Show resolved Hide resolved
content/en/blog/2024/l7-policy-with-opa/index.md Outdated Show resolved Hide resolved
@craigbox
Copy link
Contributor

craigbox commented Oct 9, 2024

Tests are passing. Now awaiting @antonioberben to test the revised post top to bottom and take in @dhawton's fixes.

@craigbox craigbox added the do-not-merge Block automatic merging of a PR. label Oct 9, 2024
@antonioberben
Copy link
Member Author

@craigbox , @dhawton , all claims are solved.
The full post is self-contained from top to bottom.

I have changed the publish date to Oct, 14th

If you can double-check and approve after all tests pass, it would be awesome.

Thanks for your support

@craigbox
Copy link
Contributor

craigbox commented Oct 10, 2024 via email

@antonioberben
Copy link
Member Author

Yes, it is tested from top to bottom. If @dhawton can run it quickly, then we can finish it today

@charlieegan3
Copy link
Contributor

I've reviewed the instructions and the rendered post this morning, lgtm 👍

@antonioberben
Copy link
Member Author

@craigbox , @dhawton , do you need anything else to approve this? @charlieegan3 has already tested it too. Thanks

@craigbox craigbox added cherrypick/release-1.23 Set this label on a PR to auto-merge it to the release-1.23 branch and removed do-not-merge Block automatic merging of a PR. labels Oct 15, 2024
@craigbox
Copy link
Contributor

that'll do me

@craigbox
Copy link
Contributor

(p.s. every time I see this PR I think "OPA Gangnam style")

giphy

@istio-testing istio-testing merged commit e4ba233 into istio:master Oct 15, 2024
6 checks passed
@istio-testing
Copy link
Contributor

In response to a cherrypick label: #15134 failed to apply on top of branch "release-1.23":

Applying: add blog post
Applying: Add intro, adjust policy
Applying: Remove other titles and descriptions
Applying: Pass lint
Applying: sort alphabetically
Using index info to reconstruct a base tree...
M	.spelling
Falling back to patching base and 3-way merge...
Auto-merging .spelling
CONFLICT (content): Merge conflict in .spelling
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0005 sort alphabetically
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

@istio-testing
Copy link
Contributor

In response to a cherrypick label: new issue created for failed cherrypick: #15798

craigbox added a commit to craigbox/istio.io that referenced this pull request Oct 15, 2024
* add blog post

* Add intro, adjust policy

Signed-off-by: Charlie Egan <[email protected]>

* Remove other titles and descriptions

* Pass lint

* sort alphabetically

* sort alphabetically

* Fix lint complains

* Fix spelling merge

* Sort spelling file

* Fix linter claims

* Fix publishing date

* Update content/en/docs/ops/integrations/opa/index.md

Co-authored-by: Charlie Egan <[email protected]>

* Update content/en/docs/ops/integrations/opa/index.md

Co-authored-by: Charlie Egan <[email protected]>

* Update content/en/docs/ops/integrations/opa/index.md

Co-authored-by: Charlie Egan <[email protected]>

* Update content/en/docs/ops/integrations/opa/index.md

Co-authored-by: Charlie Egan <[email protected]>

* Update content/en/docs/ops/integrations/opa/index.md

Co-authored-by: Charlie Egan <[email protected]>

* Update content/en/docs/ops/integrations/opa/index.md

Co-authored-by: Charlie Egan <[email protected]>

* Fix review

* fix linter

* Update content/en/blog/2024/l7-policy-with-opa/index.md

Co-authored-by: Daniel Hawton <[email protected]>

* Update content/en/blog/2024/l7-policy-with-opa/index.md

Co-authored-by: Craig Box <[email protected]>

* Update content/en/blog/2024/l7-policy-with-opa/index.md

Co-authored-by: Daniel Hawton <[email protected]>

* Update content/en/blog/2024/l7-policy-with-opa/index.md

Co-authored-by: Daniel Hawton <[email protected]>

* Update content/en/blog/2024/l7-policy-with-opa/index.md

Co-authored-by: Daniel Hawton <[email protected]>

* Update content/en/blog/2024/l7-policy-with-opa/index.md

Co-authored-by: Daniel Hawton <[email protected]>

* Update content/en/blog/2024/l7-policy-with-opa/index.md

Co-authored-by: Daniel Hawton <[email protected]>

* Update .spelling

Co-authored-by: Daniel Hawton <[email protected]>

* Update .spelling

Co-authored-by: Daniel Hawton <[email protected]>

* Update .spelling

Co-authored-by: Daniel Hawton <[email protected]>

* Update .spelling

Co-authored-by: Daniel Hawton <[email protected]>

* Update content/en/blog/2024/l7-policy-with-opa/index.md

Co-authored-by: Daniel Hawton <[email protected]>

* Update content/en/blog/2024/l7-policy-with-opa/index.md

Co-authored-by: Daniel Hawton <[email protected]>

* Update content/en/blog/2024/l7-policy-with-opa/index.md

Co-authored-by: Daniel Hawton <[email protected]>

* Update content/en/blog/2024/l7-policy-with-opa/index.md

Co-authored-by: Daniel Hawton <[email protected]>

* Update content/en/blog/2024/l7-policy-with-opa/index.md

Co-authored-by: Daniel Hawton <[email protected]>

* Update content/en/blog/2024/l7-policy-with-opa/index.md

Co-authored-by: Daniel Hawton <[email protected]>

* Update content/en/blog/2024/l7-policy-with-opa/index.md

Co-authored-by: Daniel Hawton <[email protected]>

* Update content/en/blog/2024/l7-policy-with-opa/index.md

Co-authored-by: Daniel Hawton <[email protected]>

* Update content/en/blog/2024/l7-policy-with-opa/index.md

Co-authored-by: Daniel Hawton <[email protected]>

* Update content/en/blog/2024/l7-policy-with-opa/index.md

Co-authored-by: Daniel Hawton <[email protected]>

* Update content/en/blog/2024/l7-policy-with-opa/index.md

Co-authored-by: Daniel Hawton <[email protected]>

* Update content/en/blog/2024/l7-policy-with-opa/index.md

Co-authored-by: Daniel Hawton <[email protected]>

* Update content/en/blog/2024/l7-policy-with-opa/index.md

Co-authored-by: Daniel Hawton <[email protected]>

* Update content/en/blog/2024/l7-policy-with-opa/index.md

Co-authored-by: Daniel Hawton <[email protected]>

* Update content/en/blog/2024/l7-policy-with-opa/index.md

Co-authored-by: Daniel Hawton <[email protected]>

* Inline examples

* remove doc

* small lint fixes

* Update content/en/blog/2024/l7-policy-with-opa/index.md

Co-authored-by: Daniel Hawton <[email protected]>

* Update content/en/blog/2024/l7-policy-with-opa/index.md

Co-authored-by: Daniel Hawton <[email protected]>

* Update content/en/blog/2024/l7-policy-with-opa/index.md

Co-authored-by: Daniel Hawton <[email protected]>

* Update title and description

* Fix demo

* Fix code block issue

---------

Signed-off-by: Charlie Egan <[email protected]>
Co-authored-by: Charlie Egan <[email protected]>
Co-authored-by: Charlie Egan <[email protected]>
Co-authored-by: Daniel Hawton <[email protected]>
Co-authored-by: Craig Box <[email protected]>
@craigbox
Copy link
Contributor

Will go live when #15799 is approved

istio-testing pushed a commit that referenced this pull request Oct 15, 2024
* add blog post

* Add intro, adjust policy



* Remove other titles and descriptions

* Pass lint

* sort alphabetically

* sort alphabetically

* Fix lint complains

* Fix spelling merge

* Sort spelling file

* Fix linter claims

* Fix publishing date

* Update content/en/docs/ops/integrations/opa/index.md



* Update content/en/docs/ops/integrations/opa/index.md



* Update content/en/docs/ops/integrations/opa/index.md



* Update content/en/docs/ops/integrations/opa/index.md



* Update content/en/docs/ops/integrations/opa/index.md



* Update content/en/docs/ops/integrations/opa/index.md



* Fix review

* fix linter

* Update content/en/blog/2024/l7-policy-with-opa/index.md



* Update content/en/blog/2024/l7-policy-with-opa/index.md



* Update content/en/blog/2024/l7-policy-with-opa/index.md



* Update content/en/blog/2024/l7-policy-with-opa/index.md



* Update content/en/blog/2024/l7-policy-with-opa/index.md



* Update content/en/blog/2024/l7-policy-with-opa/index.md



* Update content/en/blog/2024/l7-policy-with-opa/index.md



* Update .spelling



* Update .spelling



* Update .spelling



* Update .spelling



* Update content/en/blog/2024/l7-policy-with-opa/index.md



* Update content/en/blog/2024/l7-policy-with-opa/index.md



* Update content/en/blog/2024/l7-policy-with-opa/index.md



* Update content/en/blog/2024/l7-policy-with-opa/index.md



* Update content/en/blog/2024/l7-policy-with-opa/index.md



* Update content/en/blog/2024/l7-policy-with-opa/index.md



* Update content/en/blog/2024/l7-policy-with-opa/index.md



* Update content/en/blog/2024/l7-policy-with-opa/index.md



* Update content/en/blog/2024/l7-policy-with-opa/index.md



* Update content/en/blog/2024/l7-policy-with-opa/index.md



* Update content/en/blog/2024/l7-policy-with-opa/index.md



* Update content/en/blog/2024/l7-policy-with-opa/index.md



* Update content/en/blog/2024/l7-policy-with-opa/index.md



* Update content/en/blog/2024/l7-policy-with-opa/index.md



* Update content/en/blog/2024/l7-policy-with-opa/index.md



* Inline examples

* remove doc

* small lint fixes

* Update content/en/blog/2024/l7-policy-with-opa/index.md



* Update content/en/blog/2024/l7-policy-with-opa/index.md



* Update content/en/blog/2024/l7-policy-with-opa/index.md



* Update title and description

* Fix demo

* Fix code block issue

---------

Signed-off-by: Charlie Egan <[email protected]>
Co-authored-by: Antonio B. <[email protected]>
Co-authored-by: Charlie Egan <[email protected]>
Co-authored-by: Charlie Egan <[email protected]>
Co-authored-by: Daniel Hawton <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/extensions and telemetry cherrypick/release-1.23 Set this label on a PR to auto-merge it to the release-1.23 branch lifecycle/automatically-closed Indicates a PR or issue that has been closed automatically. lifecycle/staleproof Indicates a PR or issue has been deemed to be immune from becoming stale and/or automatically closed size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants