-
Notifications
You must be signed in to change notification settings - Fork 33
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
base: main
Are you sure you want to change the base?
Conversation
d42bc4f
to
c164ae2
Compare
There was a problem hiding this 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.
@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? |
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. |
There was a problem hiding this comment.
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/
There was a problem hiding this comment.
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? 🤔
There was a problem hiding this comment.
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 🤷
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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 ?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this 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
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 |
Signed-off-by: KevFan <[email protected]>
Signed-off-by: KevFan <[email protected]>
Signed-off-by: KevFan <[email protected]>
Signed-off-by: KevFan <[email protected]>
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