Skip to content

Commit

Permalink
Deployed 5020f51 to 0.8.0 with MkDocs 1.5.3 and mike 2.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jasonmadigan committed Jun 27, 2024
1 parent 7ffad3d commit 969e0a5
Show file tree
Hide file tree
Showing 27 changed files with 431 additions and 3,030 deletions.
5 changes: 2 additions & 3 deletions 0.8.0/dns-operator/docs/provider/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4117,7 +4117,7 @@ <h3 id="aws-route-53-provider">AWS Route 53 Provider<a class="headerlink" href="
</table>
<h4 id="aws-iam-permissions-required">AWS IAM Permissions Required<a class="headerlink" href="#aws-iam-permissions-required" title="Permanent link">&para;</a></h4>
<p>We have tested using the available policy <code>AmazonRoute53FullAccess</code> however it should also be possible to restrict the credential down to a particular zone. More info can be found in the AWS docs:</p>
<p><a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/access-control-managing-permissions.html">https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/access-control-managing-permissions.html</a></p>
<p>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/access-control-managing-permissions.html</p>
<h3 id="google-cloud-dns-provider">Google Cloud DNS Provider<a class="headerlink" href="#google-cloud-dns-provider" title="Permanent link">&para;</a></h3>
<p>Kuadant expects a secret with a credential. Below is an example for Google DNS. It is important to set the secret type to <code>gcp</code>:</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>kubectl<span class="w"> </span>create<span class="w"> </span>secret<span class="w"> </span>generic<span class="w"> </span>my-test-gcp-credentials<span class="w"> </span><span class="se">\</span>
Expand Down Expand Up @@ -4148,8 +4148,7 @@ <h3 id="google-cloud-dns-provider">Google Cloud DNS Provider<a class="headerlink
</tbody>
</table>
<h4 id="google-cloud-dns-access-permissions-required">Google Cloud DNS Access permissions required<a class="headerlink" href="#google-cloud-dns-access-permissions-required" title="Permanent link">&para;</a></h4>
<p>See: </p>
<p><a href="https://cloud.google.com/dns/docs/access-control#dns.admin">https://cloud.google.com/dns/docs/access-control#dns.admin</a></p>
<p>See: https://cloud.google.com/dns/docs/access-control#dns.admin</p>
<h3 id="where-to-create-the-secrets">Where to create the Secrets<a class="headerlink" href="#where-to-create-the-secrets" title="Permanent link">&para;</a></h3>
<p>It is recommended that you create the secret in the same namespace as your <code>ManagedZones</code>. In the examples above, we've stored these in a namespace called <code>kuadrant-dns-system</code>.</p>
<p>Now that we have the credential created we have a DNS provider ready to go and can start using it.</p>
Expand Down
237 changes: 87 additions & 150 deletions 0.8.0/kuadrant-operator/doc/development/index.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -4045,8 +4045,7 @@ <h3 id="importing-dashboards-into-grafana">Importing Dashboards into Grafana<a c
<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>
<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>Integrate alerts into Prometheus using a <code>PrometheusRule</code> resource. Adjust alert thresholds to meet your specific operational needs.</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>


Expand Down
2 changes: 0 additions & 2 deletions 0.8.0/kuadrant-operator/doc/observability/tracing/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4072,8 +4072,6 @@ <h3 id="istio-tracing-configuration">Istio Tracing Configuration<a class="header
</span><span id="__span-0-27"><a id="__codelineno-0-27" name="__codelineno-0-27" href="#__codelineno-0-27"></a><span class="w"> </span><span class="nt">port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">4317</span>
</span><span id="__span-0-28"><a id="__codelineno-0-28" name="__codelineno-0-28" href="#__codelineno-0-28"></a><span class="w"> </span><span class="nt">service</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">tempo.tempo.svc.cluster.local</span>
</span></code></pre></div>
<p><strong>Important:</strong></p>
<p>The OpenTelemetry collector protocol should be explicitly set in the service port <code>name</code> or <code>appProtocol</code> fields as per the <a href="https://istio.io/latest/docs/ops/configuration/traffic-management/protocol-selection/#explicit-protocol-selection">Istio documentation</a>. For example, when using gRPC, the port <code>name</code> should begin with <code>grpc-</code> or the <code>appProtocol</code> should be <code>grpc</code>.</p>
<h3 id="kuadrant-tracing-configuration">Kuadrant Tracing Configuration<a class="headerlink" href="#kuadrant-tracing-configuration" title="Permanent link">&para;</a></h3>
<p>The Authorino and Limitador components have request tracing capabilities.
Here is an example configuration to enable and send traces to a central collector.
Expand Down
40 changes: 32 additions & 8 deletions 0.8.0/kuadrant-operator/examples/dashboards/app_developer.json
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,7 @@
"type": "prometheus",
"uid": "${datasource}"
},
"description": "Requests per second, broken down by response code e.g. 200, 302, 403, 500",
"description": "Requests per second, broken down by success (2xx,3xx) and error (4xx,5xx)",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -509,14 +509,26 @@
"uid": "${datasource}"
},
"editorMode": "code",
"expr": "sum(rate(istio_requests_total{destination_service_name=~\"$api\"}[5m])) by (destination_service_name, response_code) * on(destination_service_name) group_left(name) (group without(cluster_id, instance, app_kubernetes_io_instance) (label_replace(gatewayapi_httproute_labels{deployment=~\"$api\"}, \"destination_service_name\", \"$1\",\"service\", \"(.+)\")))",
"expr": "sum(rate(istio_requests_total{response_code=~\"4.*|5.*\",destination_service_name=~\"$api\"}[5m])) by (destination_service_name) * on(destination_service_name) group_right() (group without(cluster_id, instance, app_kubernetes_io_instance) (label_replace(gatewayapi_httproute_labels{deployment=~\"$api\"}, \"destination_service_name\", \"$1\",\"service\", \"(.+)\")))",
"hide": false,
"legendFormat": "{{response_code}}",
"legendFormat": "error (4xx,5xx)",
"range": true,
"refId": "B"
},
{
"datasource": {
"type": "prometheus",
"uid": "${datasource}"
},
"editorMode": "code",
"expr": "sum(rate(istio_requests_total{response_code=~\"2.*|3.*\",destination_service_name=~\"$api\"}[5m])) by (destination_service_name) * on(destination_service_name) group_right() (group without(cluster_id, instance, app_kubernetes_io_instance) (label_replace(gatewayapi_httproute_labels{deployment=~\"$api\"}, \"destination_service_name\", \"$1\",\"service\", \"(.+)\")))",
"hide": false,
"legendFormat": "success (2xx,3xx)",
"range": true,
"refId": "C"
}
],
"title": "request breakdown by code (req/s)",
"title": "request breakdown (req/s)",
"type": "timeseries"
},
{
Expand Down Expand Up @@ -1296,7 +1308,7 @@
"type": "prometheus",
"uid": "${datasource}"
},
"description": "Requests per second, broken down by response code e.g. 200, 302, 403, 500",
"description": "Requests per second, broken down by success (2xx,3xx) and error (4xx,5xx)",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -1431,14 +1443,26 @@
"uid": "${datasource}"
},
"editorMode": "code",
"expr": "sum(rate(istio_requests_total{destination_service_name=~\"$api\"}[5m])) by (cluster_id, destination_service_name, response_code) * on(cluster_id, destination_service_name) group_left(name) (group without(instance, app_kubernetes_io_instance) (label_replace(gatewayapi_httproute_labels{deployment=~\"$api\"}, \"destination_service_name\", \"$1\",\"service\", \"(.+)\")))",
"expr": "sum(rate(istio_requests_total{response_code=~\"4.*|5.*\",destination_service_name=~\"$api\"}[5m])) by (cluster_id, destination_service_name) * on(cluster_id, destination_service_name) group_right() (group without(instance, app_kubernetes_io_instance) (label_replace(gatewayapi_httproute_labels{deployment=~\"$api\"}, \"destination_service_name\", \"$1\",\"service\", \"(.+)\")))",
"hide": false,
"legendFormat": "\"{{cluster_id}}\" {{response_code}}",
"legendFormat": "\"{{cluster_id}}\" error (4xx,5xx)",
"range": true,
"refId": "B"
},
{
"datasource": {
"type": "prometheus",
"uid": "${datasource}"
},
"editorMode": "code",
"expr": "sum(rate(istio_requests_total{response_code=~\"2.*|3.*\",destination_service_name=~\"$api\"}[5m])) by (cluster_id, destination_service_name) * on(cluster_id, destination_service_name) group_right() (group without(instance, app_kubernetes_io_instance) (label_replace(gatewayapi_httproute_labels{deployment=~\"$api\"}, \"destination_service_name\", \"$1\",\"service\", \"(.+)\")))",
"hide": false,
"legendFormat": "\"{{cluster_id}}\" success (2xx,3xx)",
"range": true,
"refId": "C"
}
],
"title": "request breakdown by cluster and code (req/s)",
"title": "request breakdown by cluster (req/s)",
"type": "timeseries"
},
{
Expand Down
Loading

0 comments on commit 969e0a5

Please sign in to comment.