Skip to content

Instantly share code, notes, and snippets.

@PK85

PK85/config-docs-proposal.MD

Last active April 9, 2019 08:53
Show Gist options
  • Save PK85/18170fe0ca8720acb2ab6a70b9c07117 to your computer and use it in GitHub Desktop.
Save PK85/18170fe0ca8720acb2ab6a70b9c07117 to your computer and use it in GitHub Desktop.
Download ZIP
How to configure Kyma - documentation proposal
Raw
config-docs-proposal.MD

Kyma overview:

  • add a document about general Kyma configuration options
    • describe cluster vs local overrides
      • cluster, we as kyma do not provide hardcoded overrides values. Only placeholders exists. Our goal is to remove those placeholders in the future too and have documentation about them. That means no overrides in the cluster configuration file (that makes Kyma upgrade process easy, cause during upgrade we do not use cluster-overrides from new Kyma version(cause it should be same as in previous version)). Charts contain all production ready configurations. That means only enduser can override existing kyma configurations.
      • local config overrides some of the values from charts to make Kyma less memory and CPU consuming as our notebooks has limits.
    • describe global vs per chart override
    • mention that all configuration options are available per component in a given "Configuration" section

Kyma components:

  • every and each component expose configuration options
    • two type of the component configuration, by
      • helm charts values (during installation)
      • by providing some k8s resources like configmaps (for example helm-broker)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment