Deploy to GitHub pages

cortexproject · Dec 18, 2024 · 74ac4a0 · 74ac4a0
1 parent 56fcbbd
commit 74ac4a0
Show file tree

Hide file tree

Showing 90 changed files with 174 additions and 355 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
@@ -507,97 +507,7 @@ no special care is required to take when scaling up ingesters.&lt;/p>
 &lt;li>Before proceeding to the next ingester, wait 2x the maximum between &lt;code>-blocks-storage.bucket-store.sync-interval&lt;/code> and &lt;code>-compactor.cleanup-interval&lt;/code>&lt;/li>
 &lt;/ol>
 &lt;/li>
-&lt;/ul></description></item><item><title>Docs: OpenTelemetry Collector</title><link>/docs/guides/opentelemetry-collector/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/docs/guides/opentelemetry-collector/</guid><description>
-&lt;p>This guide explains how to configure open-telemetry collector and OTLP(OpenTelemetry Protocol) configurations in the
-Cortex.&lt;/p>
-&lt;h2 id="context">Context&lt;/h2>
-&lt;p>The &lt;a href="https://opentelemetry.io/docs/collector/">open-telemetry collector&lt;/a> can write collected metrics to the Cortex with
-the Prometheus and OTLP formats.&lt;/p>
-&lt;h2 id="push-with-prometheus-format">Push with Prometheus format&lt;/h2>
-&lt;p>To push metrics via the &lt;code>Prometheus&lt;/code> format, we can
-use &lt;a href="https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/prometheusremotewriteexporter">prometheusremotewrite&lt;/a>
-exporter in the open-telemetry collector.
-In the &lt;code>exporters&lt;/code> and &lt;code>service&lt;/code> sections in the open-telemetry collector yaml file, we can add as follows:&lt;/p>
-&lt;pre tabindex="0">&lt;code>exporters:
-prometheusremotewrite:
-endpoint: http://&amp;lt;cortex-endpoint&amp;gt;/api/v1/push
-headers:
-X-Scope-OrgId: &amp;lt;orgId&amp;gt;
-...
-service:
-pipelines:
-metrics:
-receivers: [...]
-processors: [...]
-exporters: [prometheusremotewrite]
-&lt;/code>&lt;/pre>&lt;p>Please refer to &lt;a href="/docs/guides/auth/">Authentication and Authorisation&lt;/a> section for the
-&lt;code>X-Scope-OrgId&lt;/code> explanation.&lt;/p>
-&lt;h2 id="push-with-otlp-format">Push with OTLP format&lt;/h2>
-&lt;p>To push metrics via the &lt;code>OTLP&lt;/code> format, we can
-use &lt;a href="https://github.com/open-telemetry/opentelemetry-collector/tree/main/exporter/otlphttpexporter">otlphttp&lt;/a> exporter
-in the open-telemetry collector.
-In the &lt;code>exporters&lt;/code> and &lt;code>service&lt;/code> sections in the open-telemetry collector yaml file, we can add as follows:&lt;/p>
-&lt;pre tabindex="0">&lt;code>exporters:
-otlphttp:
-endpoint: http://&amp;lt;cortex-endpoint&amp;gt;/api/v1/otlp
-headers:
-X-Scope-OrgId: &amp;lt;orgId&amp;gt;
-...
-service:
-pipelines:
-metrics:
-receivers: [...]
-processors: [...]
-exporters: [otlphttp]
-&lt;/code>&lt;/pre>&lt;h2 id="configure-otlp">Configure OTLP&lt;/h2>
-&lt;h3 id="target_info-metric">target_info metric&lt;/h3>
-&lt;p>By default,
-the &lt;a href="https://github.com/prometheus/OpenMetrics/blob/main/specification/OpenMetrics.md#supporting-target-metadata-in-both-push-based-and-pull-based-systems">target_info&lt;/a>
-is enabled to write and can be disabled via &lt;code>-distributor.otlp.disable-target-info=true&lt;/code>.&lt;/p>
-&lt;h3 id="resource-attributes-conversion">Resource attributes conversion&lt;/h3>
-&lt;p>The conversion of
-all &lt;a href="https://opentelemetry.io/docs/specs/semconv/resource/">resource attributes&lt;/a> to labels is
-disabled by default and can be enabled via
-&lt;code>-distributor.otlp.convert-all-attributes=true&lt;/code>.&lt;/p>
-&lt;p>You can specify the attributes converted to labels via &lt;code>-distributor.promote-resource-attributes&lt;/code> flag. It is supported
-only if &lt;code>-distributor.otlp.convert-all-attributes=false&lt;/code>.&lt;/p>
-&lt;p>These flags can be configured via yaml:&lt;/p>
-&lt;pre tabindex="0">&lt;code>limits:
-promote_resource_attributes: &amp;lt;list of string&amp;gt;
-...
-distributor:
-otlp:
-convert_all_attributes: &amp;lt;boolean&amp;gt;
-disable_target_info: &amp;lt;boolean&amp;gt;
-&lt;/code>&lt;/pre>&lt;p>These are the yaml examples:&lt;/p>
-&lt;ul>
-&lt;li>Example 1: All of the resource attributes are converted, and the &lt;code>target_info&lt;/code> metric is disabled to push.&lt;/li>
-&lt;/ul>
-&lt;pre tabindex="0">&lt;code>distributor:
-otlp:
-convert_all_attributes: true
-disable_target_info: true
-&lt;/code>&lt;/pre>&lt;ul>
-&lt;li>Example 2: Only &lt;code>service.name&lt;/code> and &lt;code>service.instance.id&lt;/code> resource attributes are converted to labels and the
-&lt;code>target_info&lt;/code> metric is enabled to push.&lt;/li>
-&lt;/ul>
-&lt;pre tabindex="0">&lt;code>limits:
-promote_resource_attributes: [&amp;#34;service.name&amp;#34;, &amp;#34;service.instance.id&amp;#34;]
-distributor:
-otlp:
-convert_all_attributes: false
-disable_target_info: false
-&lt;/code>&lt;/pre>&lt;h3 id="configure-promote-resource-attributes-per-tenants">Configure promote resource attributes per tenants&lt;/h3>
-&lt;p>The &lt;code>promote_resource_attributes&lt;/code> is a &lt;a href="/docs/guides/overrides-exporter/">runtime config&lt;/a> so you can configure it per tenant.&lt;/p>
-&lt;p>For example, this yaml file specifies &lt;code>attr1&lt;/code> being converted to label in both &lt;code>user-1&lt;/code> and &lt;code>user-2&lt;/code>. But, the &lt;code>attr2&lt;/code>
-is converted only for &lt;code>user-2&lt;/code>.&lt;/p>
-&lt;pre tabindex="0">&lt;code>overrides:
-user-1:
-promote_resource_attributes: [&amp;#34;attr1&amp;#34;]
-user-2:
-promote_resource_attributes: [&amp;#34;attr1&amp;#34;, &amp;#34;attr2&amp;#34;]
-`
-&lt;/code>&lt;/pre></description></item><item><title>Docs: Overrides Exporter</title><link>/docs/guides/overrides-exporter/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/docs/guides/overrides-exporter/</guid><description>
+&lt;/ul></description></item><item><title>Docs: Overrides Exporter</title><link>/docs/guides/overrides-exporter/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/docs/guides/overrides-exporter/</guid><description>
 &lt;p>Since Cortex is a multi-tenant system, it supports applying limits to each tenant to prevent
 any single one from using too many resources. In order to help operators understand how close
 to their limits tenants are, the &lt;code>overrides-exporter&lt;/code> module can expose limits as Prometheus metrics.&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/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