Skip to content

Commit

Permalink
🧹 Cleanup removed & legacy chunk config (#488)
Browse files Browse the repository at this point in the history
* clean-up legacy chunk purger config

Signed-off-by: Niclas Schad <[email protected]>

* remove any reference of config.storage.engine since the only valid option is blocks

Signed-off-by: Niclas Schad <[email protected]>

* regen docs

Signed-off-by: Niclas Schad <[email protected]>

* changelog

Signed-off-by: Niclas Schad <[email protected]>

---------

Signed-off-by: Niclas Schad <[email protected]>
  • Loading branch information
nschad authored Dec 18, 2023
1 parent 775aef4 commit b0822d0
Show file tree
Hide file tree
Showing 17 changed files with 6 additions and 40 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## master / unreleased

* [CHANGE] Removed `config.storage.engine` and any reference of it #488
* [ENHANCEMENT] Add `appProtocol` field to templates/svc-memberlist-headless.yaml to fix issues wirth Istio #485
* [ENHANCEMENT] Add option to autoscale on multiple metrics and custom metrics metrics #467
* [ENHANCEMENT] Add control on store-gateway statefulset when autoscale (HPA) enabled or disabled #472
Expand All @@ -10,6 +11,7 @@
* [DEPENDENCY] Update quay.io/cortexproject/cortex Docker tag to v1.15.2 #459
* [DEPENDENCY] Update quay.io/cortexproject/cortex Docker tag to v1.15.3 #471
* [BUGFIX] Correctly interpret .Capabilities.KubeVersion when it looks like a prerelease #457
* [BUGFIX] Removed non-existent `purger.enable` flags in some components #488
* [BUGFIX] Fix podTargetLabels in all Prometheus ServiceMonitor CRDs #487

## 2.1.0 / 2023-03-17
Expand Down
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,6 @@ Kubernetes: `^1.19.0-0`
| config.&ZeroWidthSpace;server.&ZeroWidthSpace;grpc_server_max_recv_msg_size | int | `10485760` | |
| config.&ZeroWidthSpace;server.&ZeroWidthSpace;grpc_server_max_send_msg_size | int | `10485760` | |
| config.&ZeroWidthSpace;server.&ZeroWidthSpace;http_listen_port | int | `8080` | |
| config.&ZeroWidthSpace;storage | object | `{"engine":"blocks"}` | See https://github.com/cortexproject/cortex/blob/master/docs/configuration/config-file-reference.md#storage_config |
| config.&ZeroWidthSpace;store_gateway | object | `{"sharding_enabled":false}` | https://cortexmetrics.io/docs/configuration/configuration-file/#store_gateway_config |
| distributor.&ZeroWidthSpace;affinity.&ZeroWidthSpace;podAntiAffinity.&ZeroWidthSpace;preferredDuringSchedulingIgnoredDuringExecution[0].&ZeroWidthSpace;podAffinityTerm.&ZeroWidthSpace;labelSelector.&ZeroWidthSpace;matchExpressions[0].&ZeroWidthSpace;key | string | `"app.kubernetes.io/component"` | |
| distributor.&ZeroWidthSpace;affinity.&ZeroWidthSpace;podAntiAffinity.&ZeroWidthSpace;preferredDuringSchedulingIgnoredDuringExecution[0].&ZeroWidthSpace;podAffinityTerm.&ZeroWidthSpace;labelSelector.&ZeroWidthSpace;matchExpressions[0].&ZeroWidthSpace;operator | string | `"In"` | |
Expand Down
3 changes: 0 additions & 3 deletions ci/test-configmap-values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,6 @@ config:
kvstore:
store: "memberlist"

# See https://github.com/cortexproject/cortex/blob/master/docs/configuration/config-file-reference.md#storage_config
storage:
engine: blocks
blocks_storage:
backend: "filesystem"
tsdb:
Expand Down
3 changes: 0 additions & 3 deletions ci/test-deployment-values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ config:
kvstore:
store: "memberlist"

# See https://github.com/cortexproject/cortex/blob/master/docs/configuration/config-file-reference.md#storage_config
storage:
engine: blocks
blocks_storage:
backend: "filesystem"
tsdb:
Expand Down
3 changes: 0 additions & 3 deletions ci/test-sts-values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ config:
kvstore:
store: "memberlist"

# See https://github.com/cortexproject/cortex/blob/master/docs/configuration/config-file-reference.md#storage_config
storage:
engine: blocks
blocks_storage:
backend: "filesystem"
tsdb:
Expand Down
2 changes: 0 additions & 2 deletions docs/guides/getting_started_with_block_storage.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@ config:
bucket_name: # your bucket name
region: us-east-1
endpoint: s3.us-east-1.amazonaws.com
storage:
engine: blocks
blocks_storage:
backend: s3
s3:
Expand Down
6 changes: 0 additions & 6 deletions templates/NOTES.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
{{- if eq .Values.config.storage.engine "chunks" }}
Cortex chunks storage has been deprecated, and it's now in maintenance mode: all Cortex users are encouraged to migrate to the blocks storage.
No new features will be added to the chunks storage.
Unlike the official cortex default configuration this helm-chart does not run the chunk engine by default.
{{- end }}

Verify the application is working by running these commands:
kubectl --namespace {{ .Release.Namespace }} port-forward service/{{ include "cortex.querierFullname" . }} {{ .Values.config.server.http_listen_port }}
curl http://127.0.0.1:{{ .Values.config.server.http_listen_port }}/services
2 changes: 0 additions & 2 deletions templates/compactor/compactor-statefulset.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
{{- if eq .Values.config.storage.engine "blocks" -}}
{{- if .Values.compactor.enabled -}}
apiVersion: apps/v1
kind: StatefulSet
Expand Down Expand Up @@ -142,4 +141,3 @@ spec:
{{- toYaml .Values.compactor.env | nindent 12 }}
{{- end }}
{{- end -}}
{{- end -}}
2 changes: 0 additions & 2 deletions templates/compactor/compactor-svc.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
{{- if eq .Values.config.storage.engine "blocks" -}}
{{- if .Values.compactor.enabled -}}
apiVersion: v1
kind: Service
Expand All @@ -22,4 +21,3 @@ spec:
selector:
{{- include "cortex.compactorSelectorLabels" . | nindent 4 }}
{{- end -}}
{{- end -}}
2 changes: 0 additions & 2 deletions templates/purger/purger-svc.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
{{- if eq .Values.config.storage.engine "blocks" -}}
{{- if .Values.purger.enabled -}}
apiVersion: v1
kind: Service
Expand All @@ -22,4 +21,3 @@ spec:
selector:
{{- include "cortex.purgerSelectorLabels" . | nindent 4 }}
{{- end -}}
{{- end -}}
3 changes: 0 additions & 3 deletions templates/querier/querier-dep.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,6 @@ spec:
{{- if and .Values.query_frontend.enabled (not .Values.query_scheduler.enabled) }}
- "-querier.frontend-address={{ template "cortex.queryFrontendFullname" . }}-headless.{{ .Release.Namespace }}.svc.{{ .Values.clusterDomain }}:{{ .Values.config.server.grpc_listen_port }}"
{{- end }}
{{- if .Values.purger.enabled }}
- "-purger.enable"
{{- end }}
{{- include "cortex.memcached" . | nindent 12}}
{{- range $key, $value := .Values.querier.extraArgs }}
- "-{{ $key }}={{ $value }}"
Expand Down
3 changes: 0 additions & 3 deletions templates/query-frontend/query-frontend-dep.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,6 @@ spec:
{{- if .Values.query_scheduler.enabled }}
- "-frontend.scheduler-address={{ template "cortex.querySchedulerFullname" . }}-headless.{{ .Release.Namespace }}.svc.{{ .Values.clusterDomain }}:{{ .Values.config.server.grpc_listen_port }}"
{{- end }}
{{- if .Values.purger.enabled }}
- "-purger.enable"
{{- end }}
{{- range $key, $value := .Values.query_frontend.extraArgs }}
- "-{{ $key }}={{ $value }}"
{{- end }}
Expand Down
3 changes: 0 additions & 3 deletions templates/ruler/ruler-dep.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -112,9 +112,6 @@ spec:
- "-ruler.alertmanager-url=http://{{ template "cortex.alertmanagerFullname" . }}.{{ .Release.Namespace }}.svc.{{ .Values.clusterDomain }}:{{ .Values.config.server.http_listen_port }}/api/prom/alertmanager/"
{{- end }}
{{- end }}
{{- if .Values.purger.enabled }}
- "-purger.enable"
{{- end }}
{{- include "cortex.memcached" . | nindent 12}}
{{- range $key, $value := .Values.ruler.extraArgs }}
- "-{{ $key }}={{ $value }}"
Expand Down
2 changes: 1 addition & 1 deletion templates/store-gateway/store-gateway-statefulset.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{{- if and (eq .Values.config.storage.engine "blocks") (.Values.store_gateway.enabled) -}}
{{- if .Values.store_gateway.enabled -}}
apiVersion: apps/v1
kind: StatefulSet
metadata:
Expand Down
2 changes: 1 addition & 1 deletion templates/store-gateway/store-gateway-svc-headless.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{{- if and (eq .Values.config.storage.engine "blocks") .Values.store_gateway.enabled -}}
{{- if .Values.store_gateway.enabled -}}
apiVersion: v1
kind: Service
metadata:
Expand Down
2 changes: 1 addition & 1 deletion templates/store-gateway/store-gateway-svc.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{{- if and (eq .Values.config.storage.engine "blocks") (.Values.store_gateway.enabled) -}}
{{- if .Values.store_gateway.enabled -}}
apiVersion: v1
kind: Service
metadata:
Expand Down
5 changes: 1 addition & 4 deletions values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,6 @@ config:
grpc_client_config:
max_recv_msg_size: 10485760
max_send_msg_size: 10485760
# -- See https://github.com/cortexproject/cortex/blob/master/docs/configuration/config-file-reference.md#storage_config
storage:
engine: blocks
blocks_storage:
tsdb:
dir: /data/tsdb
Expand Down Expand Up @@ -109,7 +106,7 @@ config:
# form a ring and addresses are picked from the ring).
# @default -- automatic
store_gateway_addresses: |-
{{ if and (eq .Values.config.storage.engine "blocks") (not .Values.config.store_gateway.sharding_enabled) -}}
{{ if not .Values.config.store_gateway.sharding_enabled -}}
dns+{{ include "cortex.storeGatewayFullname" $ }}-headless:9095
{{- end }}
query_range:
Expand Down

0 comments on commit b0822d0

Please sign in to comment.