Document runtime-config on https://cortexmetrics.io/docs/configuration/configuration-file/

[alanprot]

The format of the runtime config is not documented anywhere on https://cortexmetrics.io/docs/configuration/configuration-file/

Even the per tenant limits (under overrides key) is not documented.

See:

cortex/pkg/cortex/runtime_config.go

Lines 24 to 32 in 74d33df

	type runtimeConfigValues struct {
	TenantLimits map[string]*validation.Limits `yaml:"overrides"`
	Multi kv.MultiRuntimeConfig `yaml:"multi_kv_config"`
	IngesterChunkStreaming *bool `yaml:"ingester_stream_chunks_when_using_blocks"`
	IngesterLimits *ingester.InstanceLimits `yaml:"ingester_limits"`
	}

Some of the fields mention that it can be overridden but it's not clear how. Ex:

# The default tenant's shard size when the shuffle-sharding strategy is used.
# Must be set both on ingesters and distributors. When this setting is specified
# in the per-tenant overrides, a value of 0 disables shuffle sharding for the
# tenant.
# CLI flag: -distributor.ingestion-tenant-shard-size
[ingestion_tenant_shard_size: <int> | default = 0]

Ans some other fields we dont even have that reference. Ex: we can override by tenant the sse config but is not mentioned anywhere.

[Nitesh639]

Hello @alanprot, I would like to work on this issue.

[alanprot]

Hi @Nitesh639! yeah.. please do.

Let me know if u need any guidance with it.

[Nitesh639]

@jeromeinsf Thank you for appointing me. I will try to resolve this issue asap. I have stuck to the college circular, so anyone who wants to work on this issue may go ahead.

[ankur12-1610]

Hey @Nitesh639 I can help you with that :)

[Nitesh639]

Yes @ankur12-1610

[ankur12-1610]

@alanprot I'm working on on then :)

[friedrichg]

Related #3078

[stale]

This issue has been automatically marked as stale because it has not had any activity in the past 60 days. It will be closed in 15 days if no further activity occurs. Thank you for your contributions.