better documentation for helms

[gecube]

No description provided.

[def]

This PR copies documentation from docs.coroot.com into the Helm chart READMEs. That means we'll need to maintain the same content in multiple places, which isn’t something we want to do

[gecube]

the helm documentation should be self-sufficient and clear from helm chart - what are the parameters and how they could be changed.

The take regarding "multiple copies" could be solved by autogenerating the documentation from one place. You even have the documentation embedded in CRD:

kubectl explain coroot.spec
GROUP:      coroot.com
KIND:       Coroot
VERSION:    v1

FIELD: spec <Object>


DESCRIPTION:
    <empty>
FIELDS:
  affinity	<Object>
    Affinity is a group of affinity scheduling rules.

  agentsOnly	<Object>
    Configures the operator to install only the node-agent and cluster-agent.

  apiKey	<string>
    The API key used by agents when sending telemetry to Coroot.

  apiKeySecret	<Object>
    Secret containing API key.

  authAnonymousRole	<string>
    Allows access to Coroot without authentication if set (one of Admin, Editor,
    or Viewer).

  authBootstrapAdminPassword	<string>
    Initial admin password for bootstrapping.

  cacheTTL	<string>
    Metric cache retention time (e.g. 4h, 3d, 2w, 1y; default 30d).

  clickhouse	<Object>
    Clickhouse configuration.

  clusterAgent	<Object>
    <no description>

  communityEdition	<Object>
    Configurations for Coroot Community Edition.

  enterpriseEdition	<Object>
    Configurations for Coroot Enterprise Edition.

  env	<[]Object>
    Environment variables for Coroot.

  externalClickhouse	<Object>
    Use an external ClickHouse instance instead of deploying one.

  externalPrometheus	<Object>
    Use an external Prometheus instance instead of deploying one.

  ingress	<Object>
    Ingress configuration for Coroot.

  logsTTL	<string>
    Logs retention time (e.g. 4h, 3d, 2w, 1y; default 7d).

  metricsRefreshInterval	<string>
    Specifies the metric resolution interval.

  nodeAgent	<Object>
    <no description>

  nodeSelector	<map[string]string>
    NodeSelector restricts scheduling to nodes matching the specified labels.

  podAnnotations	<map[string]string>
    Annotations for Coroot pods.

  postgres	<Object>
    Store configuration in a Postgres DB instead of SQLite (required if replicas
    > 1).

  profilesTTL	<string>
    Profiles retention time (e.g. 4h, 3d, 2w, 1y; default 7d).

  projects	<[]Object>
    Projects configuration (Coroot will create or update projects the specified
    projects).

  prometheus	<Object>
    Prometheus configuration.

  replicas	<integer>
    Number of Coroot StatefulSet pods.

  resources	<Object>
    ResourceRequirements describes the compute resource requirements.

  service	<Object>
    Service configuration for Coroot.

  storage	<Object>
    Storage configuration for Coroot.

  tolerations	<[]Object>
    <no description>

  tracesTTL	<string>
    Traces retention time (e.g. 4h, 3d, 2w, 1y; default 7d).

So I definitely could not support this claim. There should as much "instances" of documentation as necessary.