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

guides: auth authzd/spicedb #1042

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Conversation

KevFan
Copy link
Contributor

@KevFan KevFan commented Nov 21, 2024

Description

Part of Kuadrant/docs.kuadrant.io#25

Introduces an AuthPolicy guide describing how an authpolicy can be integrated with spicedb for permission requests.
This can serve as an equivalent / replacement guide to https://github.com/Kuadrant/authorino/blob/main/docs/user-guides/authzed.md guide on https://docs.kuadrant.io/0.11.0/authorino/docs/user-guides/authzed/

Verification

  • Running through the guide should work as expected

@KevFan KevFan self-assigned this Nov 21, 2024
@KevFan KevFan added the area/doc Improvements or additions to documentation label Nov 21, 2024
@KevFan KevFan force-pushed the guide-authzed branch 2 times, most recently from d42bc4f to c164ae2 Compare November 21, 2024 12:13
@KevFan KevFan marked this pull request as ready for review November 21, 2024 13:09
@KevFan KevFan requested a review from a team December 2, 2024 11:30
Boomatang
Boomatang previously approved these changes Jan 8, 2025
Copy link
Contributor

@Boomatang Boomatang left a comment

Choose a reason for hiding this comment

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

This looks good, guide works as expected. I didn't spot any wrong with the grammar, but I am poor at that.

@Boomatang
Copy link
Contributor

@R-Lawton When your here, I am reviewing a different up date and a I remember seeing something about rolling the installation guides into one. Sadly, I can seem to find right now. I think you were the author. There is reference to those guides here. What impact would that have?

@Boomatang Boomatang dismissed their stale review January 8, 2025 12:50

Other required changes was spoted that I was unaware of.


## Prerequisites

You have installed Kuadrant in a [kubernetes](https://docs.kuadrant.io/latest/kuadrant-operator/doc/install/install-kubernetes/) or [OpenShift](https://docs.kuadrant.io/latest/kuadrant-operator/doc/install/install-openshift/) cluster.
Copy link
Contributor

Choose a reason for hiding this comment

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

these links have now been updated so they wont work when the new version of the docs is released on the website https://docs.kuadrant.io/dev/kuadrant-operator/doc/install/install-openshift/

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Seems most other guides were updated to https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/user-guides/ratelimiting/authenticated-rl-for-app-developers.md#setup-the-environment, is this what we want here instead now or do you have an example? 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The setup looks to still use the make targets 🤷

Copy link
Contributor

@R-Lawton R-Lawton Jan 8, 2025

Choose a reason for hiding this comment

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

We have issue to remove the make target altogether for existing docs Remove/replace using make target as the method of installation for docs. #1093 that's going to be worked on soon. In this case its the links you have above have changed in a new version of the website, we now link off to helm. The install-kubernetes doc no longer exists. The openshift doc has been updated but the link is same i just linked to it as a way to get to the dev view of the install guides on the website.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Cool 👍 I'll link the setup to either use Helm or if using Openshift 🤔
A question on this though, is are we expecting this to be cherry picked to the v1 branch? 🤔
If so, then I guess we should not hard link to the docs website but use relative paths and also not to the dev docs? Or would be cherry pick and have changes to work with the current v1 setup guides ?

Copy link
Contributor

Choose a reason for hiding this comment

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

thats a good question that im not sure i know we are working towards doing a v1.1 release later on in q1 but that seems late enough to make these change live. Yeah relative sounds good to me what you could also do is have similar to what we have for prereq in the SCP doc and just say "Kubernetes cluster with Kuadrant operator installed.". Oh yeah we don't want to use the dev view

Copy link
Contributor

@R-Lawton R-Lawton Jan 9, 2025

Choose a reason for hiding this comment

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

Ok found more info, if the doc is directly needed by 1.0 like a fix etc then cherry pick if not wait for the next release it will be seen in the dev view on the website until then

Copy link
Contributor

@R-Lawton R-Lawton left a comment

Choose a reason for hiding this comment

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

Few things i noticed

@R-Lawton
Copy link
Contributor

R-Lawton commented Jan 8, 2025

@R-Lawton When your here, I am reviewing a different up date and a I remember seeing something about rolling the installation guides into one. Sadly, I can seem to find right now. I think you were the author. There is reference to those guides here. What impact would that have?

The docs that have currently been rolled into one where the SCP docs that's now just the one no matter what env you install on. The other installation docs have been rewritten to remove old obsolete things like operator hub in favour of helm and don't include certain things like setting up gateways etc. The idea is the docs work on any installation method that's not developer methods i.e make targets

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/doc Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants