Skip to content

Commit

Permalink
Deployed 5b826bc to dev with MkDocs 1.6.1 and mike 2.1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
Docs Deploy committed Nov 28, 2024
1 parent 03d9c56 commit 058c162
Show file tree
Hide file tree
Showing 14 changed files with 408 additions and 396 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3433,6 +3433,7 @@ <h1 id="configuration-of-kuadrant-sub-components">Configuration of Kuadrant Sub
<li>Start Date: 2023-09-11</li>
<li>RFC PR: <a href="https://github.com/Kuadrant/architecture/pull/25">Kuadrant/architecture#25</a></li>
<li>Issue tracking: <a href="https://github.com/Kuadrant/kuadrant-operator/issues/163">Kuadrant/kuadrant-operator#163</a></li>
<li>Status: Withdrawn</li>
</ul>
<h1 id="summary">Summary<a class="headerlink" href="#summary" title="Permanent link">&para;</a></h1>
<p>Enable configuration of sub components of Kuadrant from a centralized location, namely the Kuadrant CR. </p>
Expand Down
2 changes: 1 addition & 1 deletion dev/authorino/docs/architecture/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4130,7 +4130,7 @@ <h2 id="the-authorization-json">The Authorization JSON<a class="headerlink" href
</span><span id="__span-2-26"><a id="__codelineno-2-26" name="__codelineno-2-26" href="#__codelineno-2-26"></a>}
</span></code></pre></div>
<p><a href="../features/#festival-wristband-tokens-responsesuccessheadersdynamicmetadatawristband">Festival Wristbands</a> and <a href="../features/#json-injection-responsesuccessheadersdynamicmetadatajson">Dynamic JSON</a> responses can include dynamic values (custom claims/properties) fetched from the authorization JSON. These can be returned to the external authorization client in added HTTP headers or as Envoy <a href="https://www.envoyproxy.io/docs/envoy/latest/configuration/advanced/well_known_dynamic_metadata">Well Known Dynamic Metadata</a>. Check out <a href="../features/#custom-response-features-response">Custom response features</a> for details.</p>
<p>For information about reading and fetching data from the Authorization JSON (syntax, functions, etc), check out <a href="../features/#common-feature-json-paths-selector">JSON paths</a>.</p>
<p>For information about reading and fetching data from the Authorization JSON (syntax, functions, etc), check out <a href="../features/#common-feature-common-expression-language-cel">Common Expression Language (CEL)</a>.</p>
<h2 id="raw-http-authorization-interface">Raw HTTP Authorization interface<a class="headerlink" href="#raw-http-authorization-interface" title="Permanent link">&para;</a></h2>
<p>Besides providing the gRPC authorization interface – that implements the Envoy gRPC authorization server –, Authorino also provides another interface for <strong>raw HTTP authorization</strong>. This second interface responds to <code>GET</code> and <code>POST</code> HTTP requests sent to <code>:5001/check</code>, and is suitable for other forms of integration, such as:</p>
<ul>
Expand Down
370 changes: 175 additions & 195 deletions dev/authorino/docs/features/index.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -3766,11 +3766,11 @@ <h2 id="create-an-authconfig">❻ Create an <code>AuthConfig</code><a class="hea
</span><span id="__span-7-23"><a id="__codelineno-7-23" name="__codelineno-7-23" href="#__codelineno-7-23"></a><span class="s"> json:</span>
</span><span id="__span-7-24"><a id="__codelineno-7-24" name="__codelineno-7-24" href="#__codelineno-7-24"></a><span class="s"> properties:</span>
</span><span id="__span-7-25"><a id="__codelineno-7-25" name="__codelineno-7-25" href="#__codelineno-7-25"></a><span class="s"> &quot;username&quot;:</span>
</span><span id="__span-7-26"><a id="__codelineno-7-26" name="__codelineno-7-26" href="#__codelineno-7-26"></a><span class="s"> selector: auth.identity.metadata.annotations.auth-data\/username</span>
</span><span id="__span-7-26"><a id="__codelineno-7-26" name="__codelineno-7-26" href="#__codelineno-7-26"></a><span class="s"> expression: auth.identity.metadata.annotations[&#39;auth-data/username&#39;]</span>
</span><span id="__span-7-27"><a id="__codelineno-7-27" name="__codelineno-7-27" href="#__codelineno-7-27"></a><span class="s"> key: ext_auth_data # how this bit of dynamic metadata from the ext authz service is named in the Envoy config</span>
</span><span id="__span-7-28"><a id="__codelineno-7-28" name="__codelineno-7-28" href="#__codelineno-7-28"></a><span class="s">EOF</span>
</span></code></pre></div>
<p>Check out the docs for information about the common feature <a href="../../features/#common-feature-json-paths-selector">JSON paths</a> for reading from the <a href="../../architecture/#the-authorization-json">Authorization JSON</a>.</p>
<p>Check out the docs about using <a href="./features.md#common-feature-common-expression-language-cel">Common Expression Language (CEL)</a> for reading from the <a href="../../architecture/#the-authorization-json">Authorization JSON</a>.</p>
<h2 id="create-the-api-keys">❼ Create the API keys<a class="headerlink" href="#create-the-api-keys" title="Permanent link">&para;</a></h2>
<p>For user John:</p>
<div class="language-sh highlight"><pre><span></span><code><span id="__span-8-1"><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>kubectl<span class="w"> </span>apply<span class="w"> </span>-f<span class="w"> </span>-<span class="s">&lt;&lt;EOF</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3850,10 +3850,11 @@ <h2 id="create-an-authconfig">❺ Create an <code>AuthConfig</code><a class="hea
</span><span id="__span-6-29"><a id="__codelineno-6-29" name="__codelineno-6-29" href="#__codelineno-6-29"></a><span class="s"> code: 302</span>
</span><span id="__span-6-30"><a id="__codelineno-6-30" name="__codelineno-6-30" href="#__codelineno-6-30"></a><span class="s"> headers:</span>
</span><span id="__span-6-31"><a id="__codelineno-6-31" name="__codelineno-6-31" href="#__codelineno-6-31"></a><span class="s"> &quot;Location&quot;:</span>
</span><span id="__span-6-32"><a id="__codelineno-6-32" name="__codelineno-6-32" href="#__codelineno-6-32"></a><span class="s"> selector: &quot;http://matrix-quotes.127.0.0.1.nip.io:8000/login.html?redirect_to={request.path}&quot;</span>
</span><span id="__span-6-33"><a id="__codelineno-6-33" name="__codelineno-6-33" href="#__codelineno-6-33"></a><span class="s">EOF</span>
</span><span id="__span-6-32"><a id="__codelineno-6-32" name="__codelineno-6-32" href="#__codelineno-6-32"></a><span class="s"> expression: |</span>
</span><span id="__span-6-33"><a id="__codelineno-6-33" name="__codelineno-6-33" href="#__codelineno-6-33"></a><span class="s"> &#39;http://matrix-quotes.127.0.0.1.nip.io:8000/login.html?redirect_to=&#39; + request.path</span>
</span><span id="__span-6-34"><a id="__codelineno-6-34" name="__codelineno-6-34" href="#__codelineno-6-34"></a><span class="s">EOF</span>
</span></code></pre></div>
<p>Check out the docs for information about the common feature <a href="../../features/#common-feature-json-paths-selector">JSON paths</a> for reading from the <a href="../../architecture/#the-authorization-json">Authorization JSON</a>.</p>
<p>Check out the docs about using <a href="./features.md#common-feature-common-expression-language-cel">Common Expression Language (CEL)</a> for reading from the <a href="../../architecture/#the-authorization-json">Authorization JSON</a>.</p>
<h2 id="create-an-api-key">❻ Create an API key<a class="headerlink" href="#create-an-api-key" title="Permanent link">&para;</a></h2>
<div class="language-sh highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>kubectl<span class="w"> </span>apply<span class="w"> </span>-f<span class="w"> </span>-<span class="s">&lt;&lt;EOF</span>
</span><span id="__span-7-2"><a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="s">apiVersion: v1</span>
Expand Down Expand Up @@ -3923,8 +3924,9 @@ <h3 id="apply-the-changes-to-the-authconfig">Apply the changes to the <code>Auth
</span><span id="__span-14-19"><a id="__codelineno-14-19" name="__codelineno-14-19" href="#__codelineno-14-19"></a><span class="s"> code: 302</span>
</span><span id="__span-14-20"><a id="__codelineno-14-20" name="__codelineno-14-20" href="#__codelineno-14-20"></a><span class="s"> headers:</span>
</span><span id="__span-14-21"><a id="__codelineno-14-21" name="__codelineno-14-21" href="#__codelineno-14-21"></a><span class="s"> &quot;Location&quot;:</span>
</span><span id="__span-14-22"><a id="__codelineno-14-22" name="__codelineno-14-22" href="#__codelineno-14-22"></a><span class="s"> selector: &quot;http://keycloak:8080/realms/kuadrant/protocol/openid-connect/auth?client_id=matrix-quotes&amp;redirect_uri=http://matrix-quotes.127.0.0.1.nip.io:8000/auth?redirect_to={request.path}&amp;scope=openid&amp;response_type=code&quot;</span>
</span><span id="__span-14-23"><a id="__codelineno-14-23" name="__codelineno-14-23" href="#__codelineno-14-23"></a><span class="s">EOF</span>
</span><span id="__span-14-22"><a id="__codelineno-14-22" name="__codelineno-14-22" href="#__codelineno-14-22"></a><span class="s"> expression: |</span>
</span><span id="__span-14-23"><a id="__codelineno-14-23" name="__codelineno-14-23" href="#__codelineno-14-23"></a><span class="s"> &#39;http://keycloak:8080/realms/kuadrant/protocol/openid-connect/auth?client_id=matrix-quotes&amp;redirect_uri=http://matrix-quotes.127.0.0.1.nip.io:8000/auth?redirect_to=&#39; + request.path + &#39;&amp;scope=openid&amp;response_type=code&#39;</span>
</span><span id="__span-14-24"><a id="__codelineno-14-24" name="__codelineno-14-24" href="#__codelineno-14-24"></a><span class="s">EOF</span>
</span></code></pre></div>
<h3 id="consume-the-application-again">Consume the application again<a class="headerlink" href="#consume-the-application-again" title="Permanent link">&para;</a></h3>
<p>Refresh the browser window or navigate again to http://matrix-quotes.127.0.0.1.nip.io:8000.</p>
Expand Down
35 changes: 18 additions & 17 deletions dev/authorino/docs/user-guides/external-metadata/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3741,24 +3741,25 @@ <h2 id="create-an-authconfig">❺ Create an <code>AuthConfig</code><a class="hea
</span><span id="__span-6-19"><a id="__codelineno-6-19" name="__codelineno-6-19" href="#__codelineno-6-19"></a><span class="s"> metadata:</span>
</span><span id="__span-6-20"><a id="__codelineno-6-20" name="__codelineno-6-20" href="#__codelineno-6-20"></a><span class="s"> &quot;geo&quot;:</span>
</span><span id="__span-6-21"><a id="__codelineno-6-21" name="__codelineno-6-21" href="#__codelineno-6-21"></a><span class="s"> http:</span>
</span><span id="__span-6-22"><a id="__codelineno-6-22" name="__codelineno-6-22" href="#__codelineno-6-22"></a><span class="s"> url: &#39;http://ip-api.com/json/{context.request.http.headers.x-forwarded-for.@extract:{&quot;sep&quot;:&quot;,&quot;}}?fields=countryCode&#39;</span>
</span><span id="__span-6-23"><a id="__codelineno-6-23" name="__codelineno-6-23" href="#__codelineno-6-23"></a><span class="s"> headers:</span>
</span><span id="__span-6-24"><a id="__codelineno-6-24" name="__codelineno-6-24" href="#__codelineno-6-24"></a><span class="s"> &quot;Accept&quot;:</span>
</span><span id="__span-6-25"><a id="__codelineno-6-25" name="__codelineno-6-25" href="#__codelineno-6-25"></a><span class="s"> value: application/json</span>
</span><span id="__span-6-26"><a id="__codelineno-6-26" name="__codelineno-6-26" href="#__codelineno-6-26"></a><span class="s"> authorization:</span>
</span><span id="__span-6-27"><a id="__codelineno-6-27" name="__codelineno-6-27" href="#__codelineno-6-27"></a><span class="s"> &quot;geofence&quot;:</span>
</span><span id="__span-6-28"><a id="__codelineno-6-28" name="__codelineno-6-28" href="#__codelineno-6-28"></a><span class="s"> opa:</span>
</span><span id="__span-6-29"><a id="__codelineno-6-29" name="__codelineno-6-29" href="#__codelineno-6-29"></a><span class="s"> rego: |</span>
</span><span id="__span-6-30"><a id="__codelineno-6-30" name="__codelineno-6-30" href="#__codelineno-6-30"></a><span class="s"> import input.context.request.http</span>
</span><span id="__span-6-31"><a id="__codelineno-6-31" name="__codelineno-6-31" href="#__codelineno-6-31"></a>
</span><span id="__span-6-32"><a id="__codelineno-6-32" name="__codelineno-6-32" href="#__codelineno-6-32"></a><span class="s"> allow {</span>
</span><span id="__span-6-33"><a id="__codelineno-6-33" name="__codelineno-6-33" href="#__codelineno-6-33"></a><span class="s"> http.method = &quot;GET&quot;</span>
</span><span id="__span-6-34"><a id="__codelineno-6-34" name="__codelineno-6-34" href="#__codelineno-6-34"></a><span class="s"> split(http.path, &quot;/&quot;) = [_, requested_country, _]</span>
</span><span id="__span-6-35"><a id="__codelineno-6-35" name="__codelineno-6-35" href="#__codelineno-6-35"></a><span class="s"> lower(requested_country) == lower(object.get(input.auth.metadata.geo, &quot;countryCode&quot;, &quot;&quot;))</span>
</span><span id="__span-6-36"><a id="__codelineno-6-36" name="__codelineno-6-36" href="#__codelineno-6-36"></a><span class="s"> }</span>
</span><span id="__span-6-37"><a id="__codelineno-6-37" name="__codelineno-6-37" href="#__codelineno-6-37"></a><span class="s">EOF</span>
</span><span id="__span-6-22"><a id="__codelineno-6-22" name="__codelineno-6-22" href="#__codelineno-6-22"></a><span class="s"> urlExpression: |</span>
</span><span id="__span-6-23"><a id="__codelineno-6-23" name="__codelineno-6-23" href="#__codelineno-6-23"></a><span class="s"> &#39;http://ip-api.com/json/&#39; + request.headers[&#39;x-forwarded-for&#39;].split(&#39;,&#39;)[0] + &#39;?fields=countryCode&#39;</span>
</span><span id="__span-6-24"><a id="__codelineno-6-24" name="__codelineno-6-24" href="#__codelineno-6-24"></a><span class="s"> headers:</span>
</span><span id="__span-6-25"><a id="__codelineno-6-25" name="__codelineno-6-25" href="#__codelineno-6-25"></a><span class="s"> &quot;Accept&quot;:</span>
</span><span id="__span-6-26"><a id="__codelineno-6-26" name="__codelineno-6-26" href="#__codelineno-6-26"></a><span class="s"> expression: &#39;&quot;application/json&quot;&#39;</span>
</span><span id="__span-6-27"><a id="__codelineno-6-27" name="__codelineno-6-27" href="#__codelineno-6-27"></a><span class="s"> authorization:</span>
</span><span id="__span-6-28"><a id="__codelineno-6-28" name="__codelineno-6-28" href="#__codelineno-6-28"></a><span class="s"> &quot;geofence&quot;:</span>
</span><span id="__span-6-29"><a id="__codelineno-6-29" name="__codelineno-6-29" href="#__codelineno-6-29"></a><span class="s"> opa:</span>
</span><span id="__span-6-30"><a id="__codelineno-6-30" name="__codelineno-6-30" href="#__codelineno-6-30"></a><span class="s"> rego: |</span>
</span><span id="__span-6-31"><a id="__codelineno-6-31" name="__codelineno-6-31" href="#__codelineno-6-31"></a><span class="s"> import input.context.request.http</span>
</span><span id="__span-6-32"><a id="__codelineno-6-32" name="__codelineno-6-32" href="#__codelineno-6-32"></a>
</span><span id="__span-6-33"><a id="__codelineno-6-33" name="__codelineno-6-33" href="#__codelineno-6-33"></a><span class="s"> allow {</span>
</span><span id="__span-6-34"><a id="__codelineno-6-34" name="__codelineno-6-34" href="#__codelineno-6-34"></a><span class="s"> http.method = &quot;GET&quot;</span>
</span><span id="__span-6-35"><a id="__codelineno-6-35" name="__codelineno-6-35" href="#__codelineno-6-35"></a><span class="s"> split(http.path, &quot;/&quot;) = [_, requested_country, _]</span>
</span><span id="__span-6-36"><a id="__codelineno-6-36" name="__codelineno-6-36" href="#__codelineno-6-36"></a><span class="s"> lower(requested_country) == lower(object.get(input.auth.metadata.geo, &quot;countryCode&quot;, &quot;&quot;))</span>
</span><span id="__span-6-37"><a id="__codelineno-6-37" name="__codelineno-6-37" href="#__codelineno-6-37"></a><span class="s"> }</span>
</span><span id="__span-6-38"><a id="__codelineno-6-38" name="__codelineno-6-38" href="#__codelineno-6-38"></a><span class="s">EOF</span>
</span></code></pre></div>
<p>Check out the docs for information about the common feature <a href="../../features/#common-feature-json-paths-selector">JSON paths</a> for reading from the <a href="../../architecture/#the-authorization-json">Authorization JSON</a>, including the description of the <code>@extract</code> string modifier.</p>
<p>Check out the docs about using <a href="./features.md#common-feature-common-expression-language-cel">Common Expression Language (CEL)</a> for reading from the <a href="../../architecture/#the-authorization-json">Authorization JSON</a>.</p>
<h2 id="create-an-api-key">❻ Create an API key<a class="headerlink" href="#create-an-api-key" title="Permanent link">&para;</a></h2>
<div class="language-sh highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>kubectl<span class="w"> </span>apply<span class="w"> </span>-f<span class="w"> </span>-<span class="s">&lt;&lt;EOF</span>
</span><span id="__span-7-2"><a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="s">apiVersion: v1</span>
Expand Down
Loading

0 comments on commit 058c162

Please sign in to comment.