Deploy to GitHub pages

cortexproject · Jan 3, 2025 · 3e4c894 · 3e4c894
1 parent 0a691e7
commit 3e4c894
Show file tree

Hide file tree

Showing 91 changed files with 224 additions and 176 deletions.
diff --git a/404.html b/404.html
diff --git a/docs/api/index.html b/docs/api/index.html
diff --git a/docs/architecture/index.html b/docs/architecture/index.html
diff --git a/docs/blocks-storage/binary-index-header/index.html b/docs/blocks-storage/binary-index-header/index.html
diff --git a/docs/blocks-storage/bucket-index/index.html b/docs/blocks-storage/bucket-index/index.html
diff --git a/docs/blocks-storage/compactor/index.html b/docs/blocks-storage/compactor/index.html
diff --git a/docs/blocks-storage/convert-long-term-storage-from-chunks-to-blocks/index.html b/docs/blocks-storage/convert-long-term-storage-from-chunks-to-blocks/index.html
diff --git a/docs/blocks-storage/index.html b/docs/blocks-storage/index.html
diff --git a/docs/blocks-storage/learn-more/index.html b/docs/blocks-storage/learn-more/index.html
diff --git a/docs/blocks-storage/migrate-cortex-cluster-from-chunks-to-blocks/index.html b/docs/blocks-storage/migrate-cortex-cluster-from-chunks-to-blocks/index.html
diff --git a/docs/blocks-storage/migrate-storage-from-thanos-and-prometheus/index.html b/docs/blocks-storage/migrate-storage-from-thanos-and-prometheus/index.html
diff --git a/docs/blocks-storage/production-tips/index.html b/docs/blocks-storage/production-tips/index.html
diff --git a/docs/blocks-storage/querier/index.html b/docs/blocks-storage/querier/index.html
diff --git a/docs/blocks-storage/store-gateway/index.html b/docs/blocks-storage/store-gateway/index.html
diff --git a/docs/case-studies/buoyant-cloud/index.html b/docs/case-studies/buoyant-cloud/index.html
diff --git a/docs/case-studies/gojek/index.html b/docs/case-studies/gojek/index.html
diff --git a/docs/case-studies/index.html b/docs/case-studies/index.html
diff --git a/docs/case-studies/rewe-digital/index.html b/docs/case-studies/rewe-digital/index.html
diff --git a/docs/changelog/index.html b/docs/changelog/index.html
diff --git a/docs/code-of-conduct/index.html b/docs/code-of-conduct/index.html
diff --git a/docs/configuration/arguments/index.html b/docs/configuration/arguments/index.html
diff --git a/docs/configuration/configuration-file/index.html b/docs/configuration/configuration-file/index.html
diff --git a/docs/configuration/index.html b/docs/configuration/index.html
diff --git a/docs/configuration/prometheus-frontend/index.html b/docs/configuration/prometheus-frontend/index.html
diff --git a/docs/configuration/v1guarantees/index.html b/docs/configuration/v1guarantees/index.html
diff --git a/docs/contributing/design-patterns-and-code-conventions/index.html b/docs/contributing/design-patterns-and-code-conventions/index.html
diff --git a/docs/contributing/governance/index.html b/docs/contributing/governance/index.html
diff --git a/docs/contributing/how-integration-tests-work/index.html b/docs/contributing/how-integration-tests-work/index.html
diff --git a/docs/contributing/how-to-add-a-maintainer/index.html b/docs/contributing/how-to-add-a-maintainer/index.html
diff --git a/docs/contributing/how-to-run-the-website-locally/index.html b/docs/contributing/how-to-run-the-website-locally/index.html
diff --git a/docs/contributing/how-to-update-the-build-image/index.html b/docs/contributing/how-to-update-the-build-image/index.html
diff --git a/docs/contributing/how-to-upgrade-golang-version/index.html b/docs/contributing/how-to-upgrade-golang-version/index.html
diff --git a/docs/contributing/index.html b/docs/contributing/index.html
diff --git a/docs/getting-started/index.html b/docs/getting-started/index.html
diff --git a/docs/guides/alertmanager-configuration/index.html b/docs/guides/alertmanager-configuration/index.html
diff --git a/docs/guides/auth/index.html b/docs/guides/auth/index.html
diff --git a/docs/guides/capacity-planning/index.html b/docs/guides/capacity-planning/index.html
diff --git a/docs/guides/encryption-at-rest/index.html b/docs/guides/encryption-at-rest/index.html
diff --git a/docs/guides/getting-started-with-gossiped-ring/index.html b/docs/guides/getting-started-with-gossiped-ring/index.html
diff --git a/docs/guides/glossary/index.html b/docs/guides/glossary/index.html
diff --git a/docs/guides/ha-pair-handling/index.html b/docs/guides/ha-pair-handling/index.html
diff --git a/docs/guides/index.html b/docs/guides/index.html
diff --git a/docs/guides/index.xml b/docs/guides/index.xml
@@ -638,7 +638,35 @@ emitted.&lt;/p>
 &lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span>cortex_overrides{limit_name=&amp;#34;max_samples_per_query&amp;#34;,user=&amp;#34;user1&amp;#34;} 100000
 &lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span>cortex_overrides{limit_name=&amp;#34;max_series_per_query&amp;#34;,user=&amp;#34;user1&amp;#34;} 100000
 &lt;/span>&lt;/span>&lt;/code>&lt;/pre>&lt;/div>&lt;p>With these metrics, you can set up alerts to know when tenants are close to hitting their limits
-before they exceed them.&lt;/p></description></item><item><title>Docs: Securing communication between Cortex components with TLS</title><link>/docs/guides/tls/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/docs/guides/tls/</guid><description>
+before they exceed them.&lt;/p></description></item><item><title>Docs: Rule evaluations via query frontend</title><link>/docs/guides/rule-evalutions-via-query-frontend/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/docs/guides/rule-evalutions-via-query-frontend/</guid><description>
+&lt;p>This guide explains how to configure the Ruler to evaluate rules via Query Frontends instead of the Ingester/Store Gateway, and the pros and cons of rule evaluation via Query Frontend.&lt;/p>
+&lt;h2 id="how-to-enable">How to enable&lt;/h2>
+&lt;p>By default, the Ruler queries both Ingesters and Store Gateway depending on the Rule time range for evaluating rules (alerting rules or recording rules). If you have set &lt;code>-ruler.frontend-address&lt;/code>, then the Ruler queries the Query Frontend for evaluation rules.
+The address should be the gRPC listen address in host:port format.&lt;/p>
+&lt;p>You can configure via args:&lt;/p>
+&lt;pre tabindex="0">&lt;code>-ruler.frontend-address=query-frontend.svc.cluster.local:9095
+&lt;/code>&lt;/pre>&lt;p>And via yaml:&lt;/p>
+&lt;div class="highlight">&lt;pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;">&lt;code class="language-yaml" data-lang="yaml">&lt;span style="display:flex;">&lt;span>&lt;span style="color:#204a87;font-weight:bold">ruler&lt;/span>&lt;span style="color:#000;font-weight:bold">:&lt;/span>&lt;span style="color:#f8f8f8;text-decoration:underline">
+&lt;/span>&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span>&lt;span style="color:#f8f8f8;text-decoration:underline"> &lt;/span>&lt;span style="color:#204a87;font-weight:bold">frontend_address&lt;/span>&lt;span style="color:#000;font-weight:bold">:&lt;/span>&lt;span style="color:#f8f8f8;text-decoration:underline"> &lt;/span>&lt;span style="color:#000">query-frontend.svc.cluster.local:9095&lt;/span>&lt;span style="color:#f8f8f8;text-decoration:underline">
+&lt;/span>&lt;/span>&lt;/span>&lt;/code>&lt;/pre>&lt;/div>&lt;p>In addition, you can configure gRPC client (Ruler -&amp;gt; Query Frontend) config, please refer to frontend_client section in &lt;a href="/docs/configuration/configuration-file/#ruler_config">ruler config&lt;/a>.&lt;/p>
+&lt;h2 id="configure-query-response-format">Configure query response format&lt;/h2>
+&lt;p>You can configure the query response format via &lt;code>-ruler.query-response-format&lt;/code>. It is used to retrieve query results from the Query Frontend.
+The supported values are &lt;code>protobuf&lt;/code> and &lt;code>json&lt;/code>. We recommend using &lt;code>protobuf&lt;/code>(default) because the retrieved query results containing native histograms are only supported on &lt;code>protobuf&lt;/code>.&lt;/p>
+&lt;h2 id="pros-and-cons">Pros and Cons&lt;/h2>
+&lt;p>If this feature is enabled, the query execute path is as follows:&lt;/p>
+&lt;p>Ruler -&amp;gt; Query Frontend -&amp;gt; Query Scheduler -&amp;gt; Querier -&amp;gt; Ingester/Store Gateway&lt;/p>
+&lt;p>There are pros and cons regarding query performance as more hops than before (Ruler -&amp;gt; Ingester/Store Gateway).&lt;/p>
+&lt;h3 id="pros">Pros&lt;/h3>
+&lt;ul>
+&lt;li>The rule evaluation performance could be improved in such a situation where the number of Queriers pulling queries from the Query Scheduler is good enough.
+If then, the queries in Query Scheduler are fetched in a reasonable time (i.e. a lot of hops are not a defect for query performance). In this environment, query performance could be improved as we can use Query Frontend features like the vertical query sharding.&lt;/li>
+&lt;li>The Ruler can use fewer resources as it doesn&amp;rsquo;t need to run a query engine to evaluate rules.&lt;/li>
+&lt;/ul>
+&lt;h3 id="cons">Cons&lt;/h3>
+&lt;ul>
+&lt;li>If there are not enough Queriers, adding rule queries to Query Scheduler could cause query starvation problem (queries in Query Scheduler could not be fetched in a reasonable time), so rules cannot be evaluated in time.&lt;/li>
+&lt;/ul>
+&lt;p>You can utilize the &lt;code>cortex_prometheus_rule_evaluation_duration_seconds&lt;/code> metric whether to use &lt;code>-ruler.frontend-address&lt;/code>.&lt;/p></description></item><item><title>Docs: Securing communication between Cortex components with TLS</title><link>/docs/guides/tls/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/docs/guides/tls/</guid><description>
 &lt;p>Cortex is a distributed system with significant traffic between its services.
 To allow for secure communication, Cortex supports TLS between all its
 components. This guide describes the process of setting up TLS.&lt;/p>

diff --git a/docs/guides/ingesters-rolling-updates/index.html b/docs/guides/ingesters-rolling-updates/index.html
diff --git a/docs/guides/ingesters-scaling-up-and-down/index.html b/docs/guides/ingesters-scaling-up-and-down/index.html
diff --git a/docs/guides/limitations/index.html b/docs/guides/limitations/index.html
diff --git a/docs/guides/opentelemetry-collector/index.html b/docs/guides/opentelemetry-collector/index.html
diff --git a/docs/guides/overrides-exporter/index.html b/docs/guides/overrides-exporter/index.html
diff --git a/docs/guides/rule-evalutions-via-query-frontend/index.html b/docs/guides/rule-evalutions-via-query-frontend/index.html
diff --git a/docs/guides/ruler-sharding/index.html b/docs/guides/ruler-sharding/index.html
diff --git a/docs/guides/running-cortex-on-kubernetes/index.html b/docs/guides/running-cortex-on-kubernetes/index.html
diff --git a/docs/guides/security/index.html b/docs/guides/security/index.html
diff --git a/docs/guides/shuffle-sharding/index.html b/docs/guides/shuffle-sharding/index.html
diff --git a/docs/guides/tls/index.html b/docs/guides/tls/index.html
diff --git a/docs/guides/tracing/index.html b/docs/guides/tracing/index.html
diff --git a/docs/guides/zone-aware-replication/index.html b/docs/guides/zone-aware-replication/index.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/operations/index.html b/docs/operations/index.html
diff --git a/docs/operations/query-auditor/index.html b/docs/operations/query-auditor/index.html
diff --git a/docs/operations/query-tee/index.html b/docs/operations/query-tee/index.html
diff --git a/docs/operations/requests-mirroring-to-secondary-cluster/index.html b/docs/operations/requests-mirroring-to-secondary-cluster/index.html
diff --git a/docs/operations/scaling-query-frontend/index.html b/docs/operations/scaling-query-frontend/index.html
diff --git a/docs/proposals/auth-gateway/index.html b/docs/proposals/auth-gateway/index.html
diff --git a/docs/proposals/block-storage-time-series-deletion/index.html b/docs/proposals/block-storage-time-series-deletion/index.html
diff --git a/docs/proposals/blocks-storage-bucket-index/index.html b/docs/proposals/blocks-storage-bucket-index/index.html
diff --git a/docs/proposals/blocks-storage-sharding/index.html b/docs/proposals/blocks-storage-sharding/index.html
diff --git a/docs/proposals/cross-tenant-query-federation/index.html b/docs/proposals/cross-tenant-query-federation/index.html
diff --git a/docs/proposals/documentation-versioning/index.html b/docs/proposals/documentation-versioning/index.html
diff --git a/docs/proposals/generalize-modules/index.html b/docs/proposals/generalize-modules/index.html
diff --git a/docs/proposals/http-api-design/index.html b/docs/proposals/http-api-design/index.html
diff --git a/docs/proposals/index.html b/docs/proposals/index.html
diff --git a/docs/proposals/ingesters-migration/index.html b/docs/proposals/ingesters-migration/index.html
diff --git a/docs/proposals/parallel-compaction/index.html b/docs/proposals/parallel-compaction/index.html
diff --git a/docs/proposals/ring-multikey/index.html b/docs/proposals/ring-multikey/index.html
diff --git a/docs/proposals/ruler-ha/index.html b/docs/proposals/ruler-ha/index.html
diff --git a/docs/proposals/ruler-high-availability/index.html b/docs/proposals/ruler-high-availability/index.html
diff --git a/docs/proposals/ruler-tenant-federation/index.html b/docs/proposals/ruler-tenant-federation/index.html
diff --git a/docs/proposals/scalable-alertmanager/index.html b/docs/proposals/scalable-alertmanager/index.html
diff --git a/docs/proposals/scalable-query-frontend/index.html b/docs/proposals/scalable-query-frontend/index.html
diff --git a/docs/proposals/shuffle-sharding-and-zone-awareness/index.html b/docs/proposals/shuffle-sharding-and-zone-awareness/index.html
diff --git a/docs/proposals/shuffle-sharding-on-the-read-path/index.html b/docs/proposals/shuffle-sharding-on-the-read-path/index.html
diff --git a/docs/proposals/support-metadata-api/index.html b/docs/proposals/support-metadata-api/index.html
diff --git a/docs/proposals/tenant-deletion/index.html b/docs/proposals/tenant-deletion/index.html
diff --git a/docs/proposals/tenant-retention/index.html b/docs/proposals/tenant-retention/index.html
diff --git a/docs/proposals/timeseries-partitioning-in-compactor/index.html b/docs/proposals/timeseries-partitioning-in-compactor/index.html
diff --git a/docs/roadmap/index.html b/docs/roadmap/index.html