docs(jans-cedarling): new quickstart using tarp #11004

SafinWasi · 2025-03-06T19:50:53Z

Prepare

Read PR guidelines
Read license information

Description

Target issue

closes #10974

Implementation Details

Test and Document the changes

N/A

Please check the below before submitting your PR. The PR will not be merged if there are no commits that start with docs: to indicate documentation changes or if the below checklist is not selected.

I confirm that there is no impact on the docs due to the code changes in this PR.

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

nynymike

Authorization Decision Service (ADS) has emerged more recently to reflect authorization as a cloud-native service rather than a monolithic policy engine embedded in an application. So saying the "Cedarling is an authorization decision service" is a little misleading, and may discourage vendors from implementing an ADS using the Cedarling.

docs/cedarling/cedarling-quick-start.md

nynymike

See my edits... but looking good.

Signed-off-by: Michael Schwartz <mike@gluu.org>

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

nynymike

This quickstart in its current state is terrible. If I were grading it, I'd give it a D-minus.

It needs high level expectations set at the beginning, like "we are going to present the quickstart in "three steps" -- authoring a policy store, loading the policy store in a test application (Tarp), and testing policy evaluation.

Also, why does it wait until the end to bring up what is the policy, like it's an afterthought? Shouldn't the introduction start with the policy we want to enforce, and an explanation of the use case?

Net-net, this needs major re-thinking on the part of Safin.

nynymike · 2025-03-28T20:58:12Z

docs/cedarling/cedarling-quick-start.md


-The Janssen Project documentation is currently in development. Topic pages are being created in order of broadest relevance, and this page is coming in the near future.
+In this guide, we'll demonstrate how to use Cedarling as a sidecar for an API Gateway to authorize requests. 


We are not using the sidecar here. Can you be more specific about what exactly this demo is showing.

nynymike · 2025-03-28T21:00:33Z

docs/cedarling/cedarling-quick-start.md


-## Have questions in the meantime?
+### Sequence diagram


I find the sequence diagram here to be not "quick" -- it's also filled with jargon like "DCR", "bootstrap config", "jwks_endpoint", that a new person might not be familiar with...

nynymike · 2025-03-28T21:02:16Z

docs/cedarling/cedarling-quick-start.md

+Before you begin, make sure you have the following:
+
+* [Firefox](https://www.mozilla.org/en-US/firefox/windows/) or [Google Chrome](https://www.google.com/chrome/index.html)
+* The latest release of [Jans Tarp](https://github.com/JanssenProject/jans/releases/tag/nightly). Download the zip file for your browser.


What would be best here is to provide a link: "How to install Jans Tarp (1 minute video)". @ossdhaval, do we have an updated video?

nynymike · 2025-03-28T21:03:20Z

docs/cedarling/cedarling-quick-start.md

+To begin using Cedarling, you need to set up a policy store. We’ll use [Agama Lab](https://cloud.gluu.org/agama-lab/login) for this purpose.
+
+1. Sign in to [Agama Lab](https://cloud.gluu.org/agama-lab/login) using your GitHub account and click on Policy Designer.
+   ![image](../assets/cedarling-policy-designer.png)


Without the context of the wesbite, this screenshot is more confusing than illuminating.

nynymike · 2025-03-28T21:04:24Z

docs/cedarling/cedarling-quick-start.md

+   ![image](../assets/cedarling-policy-store-name.png)
+4. Open the policy store and navigate to Policies.
+5. Click `Add Policy`, select `Text Editor`.
+   ![image](../assets/cedarling-add-policy.png) 


There is a lot of real-estate taken by screenshots, that lack context. It would be much better to provide one short howto video here.

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

nynymike

Getting better, but I feel like it still needs more work. Maybe a silly graphic that shows step 1-3 in some fun way?

docs/cedarling/cedarling-quick-start.md

nynymike · 2025-03-30T21:48:17Z

docs/cedarling/cedarling-quick-start.md

+
+## Authentication Flow
+
+1. On the Authentication Flow screen, click on the lightning icon to trigger an authentication flow.


I think you need another video here to show what success looks like.

Pending #11137

docs/cedarling/cedarling-quick-start.md

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

nynymike

I think this still needs work. Perhaps we should wait until the new Tarp version comes out with the authorize_unsigned support, so we can split this into two quickstarts: 1) How to author and test policies using the cedarling; 2) Token Based Access Control ("TBAC") quickstart.

docs/cedarling/cedarling-quick-start.md

nynymike · 2025-03-31T15:54:18Z

docs/cedarling/cedarling-quick-start.md

+Before we begin, we need to meet the following requirements:
+
+* [Firefox](https://www.mozilla.org/en-US/firefox/) or [Google Chrome](https://www.google.com/chrome/index.html)
+* The latest release of [Jans Tarp](https://github.com/JanssenProject/jans/releases/tag/nightly). Download the zip file for your browser and install it.


This is a mass of files and issues and it's hard to find out where exactly to download Tarp. Ideally, there should be a links to four different one-minute videos: firefox | chrome v. nightly build | store.

docs/cedarling/cedarling-quick-start.md

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

…oject/jans into docs-jans-cedarling-quickstart

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

…oject/jans into docs-jans-cedarling-quickstart

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

SafinWasi added 8 commits March 3, 2025 16:03

docs(jans-cedarling): start new quickstart

737e539

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

Merge branch 'main' into docs-jans-cedarling-quickstart

df3b9bb

docs(jans-cedarling): start new quickstart

1c652e4

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

chore: fix merge conflict

34d9ac8

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

chore: restore sidecar tutorial

89c5605

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

docs(jans-cedarling): add bootstrap json

086f698

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

docs(jans-cedarling): add new JSON logic

e87f87d

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

docs(jans-cedarling): use developer role

5d8961c

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

nynymike requested changes Mar 16, 2025

View reviewed changes

nynymike reviewed Mar 16, 2025

View reviewed changes

docs/cedarling/cedarling-quick-start.md Outdated Show resolved Hide resolved

nynymike requested changes Mar 16, 2025

View reviewed changes

nynymike and others added 2 commits March 16, 2025 18:09

Editorial changes to cedarling-quick-start.md

523a604

Signed-off-by: Michael Schwartz <mike@gluu.org>

docs(jans-cedarling): remove starting sentence

3c40c91

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

nynymike previously approved these changes Mar 17, 2025

View reviewed changes

SafinWasi marked this pull request as ready for review March 17, 2025 15:44

docs(jans-cedarling): fix action

03f95ef

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

SafinWasi dismissed nynymike’s stale review via 03f95ef March 21, 2025 14:11

chore: fix merge conflict

704ea45

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

nynymike requested changes Mar 28, 2025

View reviewed changes

SafinWasi added 2 commits March 29, 2025 13:31

docs(jans-cedarling): add video guide for policy store setup

a43bdf4

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

docs(jans-cedarling): add token metadata info

01f9ea1

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

nynymike requested changes Mar 30, 2025

View reviewed changes

SafinWasi added 2 commits March 31, 2025 09:37

docs(jans-cedarling): requested changes

82cba66

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

docs(jans-cedarling): small fix

37faa85

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

nynymike requested changes Mar 31, 2025

View reviewed changes

SafinWasi and others added 5 commits March 31, 2025 13:58

docs(jans-cedarling): fix according to suggestions

e437889

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

docs(jans-cedarling): add RBAC

76b9368

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

docs(jans-cedarling): remove null values

5248337

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

Merge branch 'main' into docs-jans-cedarling-quickstart

bb6e12f

docs(jans-cedarling): separate quickstart docs

caab1ed

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

SafinWasi and others added 17 commits April 3, 2025 09:46

ci: update paths for mkdocs

85ee407

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

Merge branch 'docs-jans-cedarling-quickstart' of github.com:JanssenPr…

f5eef69

…oject/jans into docs-jans-cedarling-quickstart

docs(jans-cedarling): improve quick start

e1dc3c1

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

docs(jans-cedarling): add unsigned video

9550d9d

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

docs(jans-cedarling): add creating object entity

c5d8a73

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

docs(jans-cedarling): add video and refactor

137352d

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

docs(jans-cedarling): make unsigned guide concise

4cdc386

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

docs(jans-cedarling): make both guides better

f6d2c97

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

docs(jans-cedarling): move video to streamable

b5dfb9f

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

docs(jans-cedarling): fix video link

e42bb86

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

docs(jans-cedarling): fix weird backtick issue

434a7e9

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

docs(jans-cedarling): new changes

8d3e952

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

docs(jans-cedarling): new videos

36bff49

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

Merge branch 'main' into docs-jans-cedarling-quickstart

aff97f2

chore: remove videos

e28f1f6

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

Merge branch 'docs-jans-cedarling-quickstart' of github.com:JanssenPr…

f6fea83

…oject/jans into docs-jans-cedarling-quickstart

chore: remove extra file

9ce4091

Signed-off-by: SafinWasi <6601566+SafinWasi@users.noreply.github.com>

moabu approved these changes Apr 9, 2025

View reviewed changes

moabu merged commit 3377ed1 into main Apr 9, 2025
2 checks passed

moabu deleted the docs-jans-cedarling-quickstart branch April 9, 2025 15:22


		The Janssen Project documentation is currently in development. Topic pages are being created in order of broadest relevance, and this page is coming in the near future.
		In this guide, we'll demonstrate how to use Cedarling as a sidecar for an API Gateway to authorize requests.


		## Authentication Flow

		1. On the Authentication Flow screen, click on the lightning icon to trigger an authentication flow.

docs(jans-cedarling): new quickstart using tarp #11004

docs(jans-cedarling): new quickstart using tarp #11004

Conversation

SafinWasi commented Mar 6, 2025

Prepare

Description

Target issue

Implementation Details

Test and Document the changes

Uh oh!

nynymike left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nynymike left a comment

Choose a reason for hiding this comment

Uh oh!

nynymike left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nynymike left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nynymike left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nynymike left a comment •

edited

Loading