Skip to content

Commit

Permalink
Deployed 5756cdc to dev with MkDocs 1.5.3 and mike 2.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Docs Deploy committed Nov 12, 2024
1 parent 8f608e4 commit 41066fb
Show file tree
Hide file tree
Showing 39 changed files with 3,961 additions and 611 deletions.
3,499 changes: 3,499 additions & 0 deletions dev/architecture/docs/api-conventions/index.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
apiVersion: kuadrant.io/v1beta3
apiVersion: kuadrant.io/v1
kind: AuthPolicy
metadata:
name: toystore
name: authpolicy-sample
spec:
targetRef:
group: gateway.networking.k8s.io
Expand All @@ -13,6 +13,6 @@ spec:
"apikey":
apiKey:
selector: {}
credentials:
authorizationHeader:
prefix: APIKEY
credentials:
authorizationHeader:
prefix: APIKEY
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
apiVersion: kuadrant.io/v1alpha1
apiVersion: kuadrant.io/v1
kind: DNSPolicy
metadata:
name: dnspolicy-sample
Expand All @@ -9,5 +9,6 @@ spec:
group: gateway.networking.k8s.io
kind: Gateway
healthCheck:
endpoint: /
protocol: HTTP
providerRefs:
- name: "provider-ref"
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
apiVersion: kuadrant.io/v1beta3
apiVersion: kuadrant.io/v1
kind: RateLimitPolicy
metadata:
name: toystore
name: ratelimitpolicy-sample
spec:
targetRef:
group: gateway.networking.k8s.io
Expand All @@ -12,5 +12,4 @@ spec:
toys:
rates:
- limit: 50
duration: 1
unit: minute
window: 1m
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
apiVersion: kuadrant.io/v1alpha1
apiVersion: kuadrant.io/v1
kind: TLSPolicy
metadata:
name: tlspolicy-sample
Expand Down
8 changes: 4 additions & 4 deletions dev/kuadrant-operator/config/samples/kustomization.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
## Append samples you want in your CSV to this file as resources ##
resources:
- kuadrant_v1beta1_kuadrant.yaml
- kuadrant_v1beta3_authpolicy.yaml
- kuadrant_v1beta3_ratelimitpolicy.yaml
- kuadrant_v1alpha1_dnspolicy.yaml
- kuadrant_v1alpha1_tlspolicy.yaml
- kuadrant_v1_authpolicy.yaml
- kuadrant_v1_ratelimitpolicy.yaml
- kuadrant_v1_dnspolicy.yaml
- kuadrant_v1_tlspolicy.yaml
#+kubebuilder:scaffold:manifestskustomizesamples
6 changes: 3 additions & 3 deletions dev/kuadrant-operator/doc/auth/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3831,7 +3831,7 @@ <h4 id="overview">Overview<a class="headerlink" href="#overview" title="Permanen
<p>Each auth rule can declare specific <code>when</code> conditions for the rule to apply.</p>
<p>The auth scheme (<code>rules</code>), as well as conditions and named patterns can be declared at the top-level level of the spec (with the semantics of <em>defaults</em>) or alternatively within explicit <code>defaults</code> or <code>overrides</code> blocks.</p>
<h4 id="high-level-example-and-field-definition">High-level example and field definition<a class="headerlink" href="#high-level-example-and-field-definition" title="Permanent link">&para;</a></h4>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kuadrant.io/v1beta3</span>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kuadrant.io/v1</span>
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">AuthPolicy</span>
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="nt">metadata</span><span class="p">:</span>
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-auth-policy</span>
Expand Down Expand Up @@ -3957,7 +3957,7 @@ <h3 id="targeting-a-httproute-networking-resource">Targeting a HTTPRoute network
<p>When an AuthPolicy targets a HTTPRoute, the policy is enforced to all traffic routed according to the rules and hostnames specified in the HTTPRoute, across all Gateways referenced in the <code>spec.parentRefs</code> field of the HTTPRoute.</p>
<p>The targeted HTTPRoute's rules and/or hostnames to which the policy must be enforced can be filtered to specific subsets.</p>
<p>Target a HTTPRoute by setting the <code>spec.targetRef</code> field of the AuthPolicy as follows:</p>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kuadrant.io/v1beta3</span>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kuadrant.io/v1</span>
</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">AuthPolicy</span>
</span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="nt">metadata</span><span class="p">:</span>
</span><span id="__span-1-4"><a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-route-auth</span>
Expand Down Expand Up @@ -4006,7 +4006,7 @@ <h3 id="targeting-a-gateway-networking-resource">Targeting a Gateway networking
<p><em>Defaults</em> provide cluster operators with the ability to protect the infrastructure against unplanned and malicious network traffic attempt, such as by setting preemptive "deny-all" policies on hostnames and hostname wildcards.</p>
<p>Inversely, a gateway policy that specify <em>overrides</em> declares a set of rules to be enforced on <em>all routes attached to the gateway</em>, thus atomically replacing any more specific policy occasionally attached to any of those routes.</p>
<p>Target a Gateway HTTPRoute by setting the <code>spec.targetRef</code> field of the AuthPolicy as follows:</p>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kuadrant.io/v1beta3</span>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kuadrant.io/v1</span>
</span><span id="__span-3-2"><a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">AuthPolicy</span>
</span><span id="__span-3-3"><a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a><span class="nt">metadata</span><span class="p">:</span>
</span><span id="__span-3-4"><a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-gw-auth</span>
Expand Down
5 changes: 3 additions & 2 deletions dev/kuadrant-operator/doc/development/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3903,8 +3903,9 @@ <h3 id="build-kuadrant-operator-bundle-image">Build kuadrant operator bundle ima
</span><span id="__span-9-4"><a id="__codelineno-9-4" name="__codelineno-9-4" href="#__codelineno-9-4"></a><span class="w"> </span><span class="o">[</span><span class="nv">AUTHORINO_OPERATOR_BUNDLE_IMG</span><span class="o">=</span>quay.io/kuadrant/authorino-operator-bundle:latest<span class="o">]</span><span class="w"> </span><span class="se">\</span>
</span><span id="__span-9-5"><a id="__codelineno-9-5" name="__codelineno-9-5" href="#__codelineno-9-5"></a><span class="w"> </span><span class="o">[</span><span class="nv">DNS_OPERATOR_BUNDLE_IMG</span><span class="o">=</span>quay.io/kuadrant/dns-operator-bundle:latest<span class="o">]</span><span class="w"> </span><span class="se">\</span>
</span><span id="__span-9-6"><a id="__codelineno-9-6" name="__codelineno-9-6" href="#__codelineno-9-6"></a><span class="w"> </span><span class="o">[</span><span class="nv">RELATED_IMAGE_WASMSHIM</span><span class="o">=</span>oci://quay.io/kuadrant/wasm-shim:latest<span class="o">]</span><span class="w"> </span><span class="se">\</span>
</span><span id="__span-9-7"><a id="__codelineno-9-7" name="__codelineno-9-7" href="#__codelineno-9-7"></a><span class="w"> </span><span class="o">[</span><span class="nv">CHANNELS</span><span class="o">=</span>alpha<span class="o">]</span><span class="w"> </span><span class="se">\</span>
</span><span id="__span-9-8"><a id="__codelineno-9-8" name="__codelineno-9-8" href="#__codelineno-9-8"></a><span class="w"> </span><span class="o">[</span><span class="nv">DEFAULT_CHANNEL</span><span class="o">=</span>alpha<span class="o">]</span>
</span><span id="__span-9-7"><a id="__codelineno-9-7" name="__codelineno-9-7" href="#__codelineno-9-7"></a><span class="w"> </span><span class="o">[</span><span class="nv">RELATED_IMAGE_CONSOLEPLUGIN</span><span class="o">=</span>quay.io/kuadrant/console-plugin:latest<span class="o">]</span><span class="w"> </span><span class="se">\</span>
</span><span id="__span-9-8"><a id="__codelineno-9-8" name="__codelineno-9-8" href="#__codelineno-9-8"></a><span class="w"> </span><span class="o">[</span><span class="nv">CHANNELS</span><span class="o">=</span>alpha<span class="o">]</span><span class="w"> </span><span class="se">\</span>
</span><span id="__span-9-9"><a id="__codelineno-9-9" name="__codelineno-9-9" href="#__codelineno-9-9"></a><span class="w"> </span><span class="o">[</span><span class="nv">DEFAULT_CHANNEL</span><span class="o">=</span>alpha<span class="o">]</span>
</span></code></pre></div>
<ul>
<li>Build the bundle image from the manifests</li>
Expand Down
Loading

0 comments on commit 41066fb

Please sign in to comment.