Skip to content

Commit

Permalink
Deployed 452a946 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 Jul 5, 2024
1 parent b21669a commit 1a8b009
Show file tree
Hide file tree
Showing 19 changed files with 1,345 additions and 215 deletions.
40 changes: 20 additions & 20 deletions dev/authorino/docs/user-guides/mtls-authentication/index.html

Large diffs are not rendered by default.

9 changes: 7 additions & 2 deletions dev/dns-operator/docs/reference/dnsrecord/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3970,8 +3970,8 @@ <h2 id="dnsrecordspec">DNSRecordSpec<a class="headerlink" href="#dnsrecordspec"
<tr>
<td><code>ownerID</code></td>
<td>String</td>
<td style="text-align: center;">Yes</td>
<td>Unique string used to identify the owner of this record</td>
<td style="text-align: center;">No</td>
<td>Unique string used to identify the owner of this record. If unset an ownerID will be generated based on the record UID</td>
</tr>
<tr>
<td><code>rootHost</code></td>
Expand Down Expand Up @@ -4105,6 +4105,11 @@ <h2 id="dnsrecordstatus">DNSRecordStatus<a class="headerlink" href="#dnsrecordst
<td><a href="#healthcheckstatus">HealthCheckStatus</a></td>
<td>Health check status</td>
</tr>
<tr>
<td><code>ownerID</code></td>
<td>String</td>
<td>Unique string used to identify the owner of this record</td>
</tr>
</tbody>
</table>
<h2 id="healthcheckstatus">HealthCheckStatus<a class="headerlink" href="#healthcheckstatus" title="Permanent link">&para;</a></h2>
Expand Down
4 changes: 2 additions & 2 deletions dev/getting-started-multi-cluster/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4049,10 +4049,10 @@ <h2 id="overview">Overview<a class="headerlink" href="#overview" title="Permanen
It can be used for adding 1 or more clusters to your local setup.</p>
<h3 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Permanent link">&para;</a></h3>
<ul>
<li>Completed the <a href="https://docs.kuadrant.io/getting-started-single-cluster/">Single-cluster Quick Start</a></li>
<li>Completed the <a href="../getting-started-single-cluster/">Single-cluster Quick Start</a></li>
</ul>
<h3 id="environmental-variables">Environmental Variables<a class="headerlink" href="#environmental-variables" title="Permanent link">&para;</a></h3>
<p>The same environment variable requirements from the <a href="https://docs.kuadrant.io/getting-started-single-cluster/">Single-cluster Quick Start</a> apply to this document,
<p>The same environment variable requirements from the <a href="../getting-started-single-cluster/">Single-cluster Quick Start</a> apply to this document,
including the <code>KUADRANT_REF</code> variable.</p>
<h3 id="set-up-a-kind-cluster-and-install-kuadrant">Set Up a kind cluster and install Kuadrant<a class="headerlink" href="#set-up-a-kind-cluster-and-install-kuadrant" title="Permanent link">&para;</a></h3>
<p>Run the same quickstart script from the single cluster quick start:</p>
Expand Down
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 @@ -4610,9 +4610,9 @@ <h3 id="route-selectors">Route selectors<a class="headerlink" href="#route-selec
<h4 id="when-conditions"><code>when</code> conditions<a class="headerlink" href="#when-conditions" title="Permanent link">&para;</a></h4>
<p><code>when</code> conditions can be used to scope an AuthPolicy or auth rule within an AuthPolicy (i.e. to filter the traffic to which a policy or policy rule applies) without any coupling to the underlying network topology, i.e. without making direct references to HTTPRouteRules via <a href="../reference/route-selectors/#the-routeselectors-field"><code>routeSelectors</code></a>.</p>
<p>Use <code>when</code> conditions to conditionally activate policies and policy rules based on attributes that cannot be expressed in the HTTPRoutes' <code>spec.hostnames</code> and <code>spec.rules.matches</code> fields, or in general in AuthPolicies that target a Gateway.</p>
<p><code>when</code> conditions in an AuthPolicy are compatible with Authorino <a href="https://docs.kuadrant.io/authorino/docs/features/#common-feature-conditions-when">conditions</a>, thus supporting complex boolean expressions with AND and OR operators, as well as grouping.</p>
<p><code>when</code> conditions in an AuthPolicy are compatible with Authorino <a href="https://docs.kuadrant.io/latest/authorino/docs/features/#common-feature-conditions-when">conditions</a>, thus supporting complex boolean expressions with AND and OR operators, as well as grouping.</p>
<p>The selectors within the <code>when</code> conditions of an AuthPolicy are a subset of Kuadrant's Well-known Attributes (<a href="https://github.com/Kuadrant/architecture/blob/main/rfcs/0002-well-known-attributes.md">RFC 0002</a>). Check out the reference for the full list of supported selectors.</p>
<p>Authorino <a href="https://docs.kuadrant.io/authorino/docs/features/#string-modifiers">JSON path string modifiers</a> can also be applied to the selectors within the <code>when</code> conditions of an AuthPolicy.</p>
<p>Authorino <a href="https://docs.kuadrant.io/latest/authorino/docs/features/#string-modifiers">JSON path string modifiers</a> can also be applied to the selectors within the <code>when</code> conditions of an AuthPolicy.</p>
<h3 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link">&para;</a></h3>
<p>Check out the following user guides for examples of protecting services with Kuadrant:</p>
<ul>
Expand Down Expand Up @@ -4694,7 +4694,7 @@ <h4 id="limitation-multiple-network-resources-with-identical-hostnames">Limitati
<p>Once again, requests to <code>app.io/foo</code> will be protected under AuthPolicy <code>policy-1</code>, while requests to <code>app.io/bar</code> will <strong>not</strong> be protected under any policy at all, unlike expected gateway policy <code>policy-2</code> enforced as default. Both policies will report status condition as <code>Enforced</code> nonetheless.</p>
<p>To avoid these problems, use different hostnames in each route.</p>
<h2 id="implementation-details">Implementation details<a class="headerlink" href="#implementation-details" title="Permanent link">&para;</a></h2>
<p>Under the hood, for each AuthPolicy, Kuadrant creates an Istio <a href="https://istio.io/latest/docs/reference/config/security/authorization-policy"><code>AuthorizationPolicy</code></a> and an Authorino <a href="https://docs.kuadrant.io/authorino/docs/architecture/#the-authorino-authconfig-custom-resource-definition-crd"><code>AuthConfig</code></a> custom resources.</p>
<p>Under the hood, for each AuthPolicy, Kuadrant creates an Istio <a href="https://istio.io/latest/docs/reference/config/security/authorization-policy"><code>AuthorizationPolicy</code></a> and an Authorino <a href="https://docs.kuadrant.io/latest/authorino/docs/architecture/#the-authorino-authconfig-custom-resource-definition-crd"><code>AuthConfig</code></a> custom resources.</p>
<p>Only requests that matches the rules in the Istio <code>AuthorizationPolicy</code> cause an authorization request to be sent to the external authorization service ("Authorino"), i.e., only requests directed to the HTTPRouteRules targeted by the AuthPolicy (directly or indirectly), according to the declared top-level route selectors (if present), or all requests for which a matching HTTPRouteRule exists (otherwise).</p>
<p>Authorino looks up for the auth scheme (<code>AuthConfig</code> custom resource) to enforce using the provided hostname of the original request as key. It then checks again if the request matches at least one of the selected HTTPRouteRules, in which case it enforces the auth scheme.</p>
<details>
Expand Down
4 changes: 2 additions & 2 deletions dev/kuadrant-operator/doc/development/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4207,8 +4207,8 @@
<h1 id="development-guide">Development Guide<a class="headerlink" href="#development-guide" title="Permanent link">&para;</a></h1>
<h2 id="technology-stack-required-for-development">Technology stack required for development<a class="headerlink" href="#technology-stack-required-for-development" title="Permanent link">&para;</a></h2>
<ul>
<li><a href="https://github.com/operator-framework/operator-sdk">operator-sdk</a> version v1.28.1</li>
<li><a href="https://kind.sigs.k8s.io/">kind</a> version v0.22.0</li>
<li><a href="https://github.com/operator-framework/operator-sdk">operator-sdk</a> version v1.32.0</li>
<li><a href="https://kind.sigs.k8s.io/">kind</a> version v0.23.0</li>
<li><a href="https://git-scm.com/downloads">git</a></li>
<li><a href="https://golang.org/">go</a> version 1.21+</li>
<li><a href="https://kubernetes.io/">kubernetes</a> version v1.19+</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4291,15 +4291,15 @@ <h3 id="step-4-optional-configure-observability-and-metrics">Step 4 - Optional:
<li><a href="https://docs.openshift.com/container-platform/latest/observability/monitoring/configuring-the-monitoring-stack.html#configuring_remote_write_storage_configuring-the-monitoring-stack">OpenShift remote write configuration</a></li>
<li><a href="https://github.com/thanos-io/kube-thanos">Kube Thanos</a></li>
</ul>
<p>The <a href="https://docs.kuadrant.io/kuadrant-operator/doc/observability/examples/">example dashboards and alerts</a> for observing Kuadrant functionality use low-level CPU metrics and network metrics available from the user monitoring stack in OpenShift. They also use resource state metrics from Gateway API and Kuadrant resources. </p>
<p>The <a href="https://docs.kuadrant.io/latest/kuadrant-operator/doc/observability/examples/">example dashboards and alerts</a> for observing Kuadrant functionality use low-level CPU metrics and network metrics available from the user monitoring stack in OpenShift. They also use resource state metrics from Gateway API and Kuadrant resources. </p>
<p>To scrape these additional metrics, you can install a <code>kube-state-metrics instance</code>, with a custom resource configuration as follows:</p>
<div class="language-bash 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>https://raw.githubusercontent.com/Kuadrant/kuadrant-operator/main/config/observability/openshift/kube-state-metrics.yaml
</span><span id="__span-7-2"><a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a>kubectl<span class="w"> </span>apply<span class="w"> </span>-k<span class="w"> </span>https://github.com/Kuadrant/gateway-api-state-metrics?ref<span class="o">=</span>main
</span></code></pre></div>
<p>To enable request metrics in Istio, you must create a <code>telemetry</code> resource as follows:</p>
<div class="language-bash 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>https://raw.githubusercontent.com/Kuadrant/kuadrant-operator/main/config/observability/openshift/telemetry.yaml
</span></code></pre></div>
<p>If you have Grafana installed in your cluster, you can import the <a href="https://docs.kuadrant.io/kuadrant-operator/doc/observability/examples">example dashboards and alerts</a>.</p>
<p>If you have Grafana installed in your cluster, you can import the <a href="https://docs.kuadrant.io/latest/kuadrant-operator/doc/observability/examples">example dashboards and alerts</a>.</p>
<p>For example installation details, see <a href="https://cloud.redhat.com/experts/o11y/ocp-grafana/">installing Grafana on OpenShift</a>. When installed, you must add your Thanos instance as a data source to Grafana. Alternatively, if you are using only the user workload monitoring stack in your OpenShift cluster, and not writing metrics to an external Thanos instance, you can <a href="https://docs.openshift.com/container-platform/4.15/observability/monitoring/accessing-third-party-monitoring-apis.html#accessing-metrics-from-outside-cluster_accessing-monitoring-apis-by-using-the-cli">set up a data source to the thanos-querier route in the OpenShift cluster</a>.</p>
<h3 id="step-5-create-secrets-for-your-credentials">Step 5 - Create secrets for your credentials<a class="headerlink" href="#step-5-create-secrets-for-your-credentials" title="Permanent link">&para;</a></h3>
<p>Before installing the Kuadrant Operator, you must enter the following commands to set up secrets that you will use later:</p>
Expand Down
4 changes: 2 additions & 2 deletions dev/kuadrant-operator/doc/observability/examples/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4042,12 +4042,12 @@ <h3 id="importing-dashboards-into-grafana">Importing Dashboards into Grafana<a c
</li>
<li><strong>ConfigMap Method:</strong> Automate dashboard provisioning by adding files to a ConfigMap, which should be mounted at <code>/etc/grafana/provisioning/dashboards</code>.</li>
</ul>
<p>Datasources are configured as template variables, automatically integrating with your existing data sources. Metrics for these dashboards are sourced from <a href="https://github.com/prometheus/prometheus">Prometheus</a>. For more details on the metrics used, visit the <a href="https://docs.kuadrant.io/kuadrant-operator/doc/observability/metrics/">metrics</a> documentation page.</p>
<p>Datasources are configured as template variables, automatically integrating with your existing data sources. Metrics for these dashboards are sourced from <a href="https://github.com/prometheus/prometheus">Prometheus</a>. For more details on the metrics used, visit the <a href="https://docs.kuadrant.io/latest/kuadrant-operator/doc/observability/metrics/">metrics</a> documentation page.</p>
<h2 id="alerts">Alerts<a class="headerlink" href="#alerts" title="Permanent link">&para;</a></h2>
<h3 id="setting-up-alerts-in-prometheus">Setting Up Alerts in Prometheus<a class="headerlink" href="#setting-up-alerts-in-prometheus" title="Permanent link">&para;</a></h3>
<p>You can integrate the <a href="https://github.com/Kuadrant/kuadrant-operator/tree/main/examples">example alerts</a> into Prometheus as <code>PrometheusRule</code> resources. Feel free to adjust alert thresholds to suit your specific operational needs.</p>
<p>Additionally, <a href="https://sre.google/sre-book/service-level-objectives/">Service Level Objective (SLO)</a> alerts generated with <a href="https://sloth.dev/">Sloth</a> are included. A benefit of these alerts is the ability to integrate them with this <a href="https://grafana.com/grafana/dashboards/14348-slo-detail/">SLO dashboard</a>, which utilizes generated labels to comprehensively overview your SLOs.</p>
<p>Further information on the metrics used for these alerts can be found on the <a href="https://docs.kuadrant.io/kuadrant-operator/doc/observability/metrics/">metrics</a> page.</p>
<p>Further information on the metrics used for these alerts can be found on the <a href="https://docs.kuadrant.io/latest/kuadrant-operator/doc/observability/metrics/">metrics</a> page.</p>



Expand Down
2 changes: 1 addition & 1 deletion dev/kuadrant-operator/doc/observability/tracing/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4125,7 +4125,7 @@ <h2 id="troubleshooting-flow-using-traces-and-logs">Troubleshooting Flow Using T
<p>If you centrally aggregate logs using something like promtail and loki, you can jump between trace information and the relevant logs for that service:</p>
<p><img alt="Trace and logs in Grafana UI" src="../grafana_tracing_loki.png" /></p>
<p>Using a combination of tracing and logs, you can visualise and troubleshoot reuqest timing issues and drill down to specific services.
This method becomes even more powerful when combined with <a href="https://docs.kuadrant.io/kuadrant-operator/doc/observability/metrics/">metrics</a> and <a href="https://docs.kuadrant.io/kuadrant-operator/doc/observability/dashboards/">dashboards</a> to get a more complete picture of your users traffic.</p>
This method becomes even more powerful when combined with <a href="https://docs.kuadrant.io/latest/kuadrant-operator/doc/observability/metrics/">metrics</a> and <a href="https://docs.kuadrant.io/latest/kuadrant-operator/doc/observability/examples/">dashboards</a> to get a more complete picture of your users traffic.</p>



Expand Down
Loading

0 comments on commit 1a8b009

Please sign in to comment.