Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce names of different types of values for the documentation and further use #45

Open
dmgtn opened this issue Aug 21, 2019 · 1 comment

Comments

@dmgtn
Copy link
Member

dmgtn commented Aug 21, 2019

@diafour, what do you think if we introduce the following names and change the documentation appropriately:

  • global static values (/modules/values.yaml)
  • module static values (modules/123-some-module/values.yaml)
  • global config values
  • module config values
  • global dynamic values and global dynamic values patches
  • module dynamic values and module dynamic values patches
  • resulting global values
  • resulting module values
  • resulting values, or just values – resulting global and module values merged
    ?

And of course we shall briefly (but precisely and accessibly) describe each of this type of values, right in the beginning of the VALUES.md, and then use these names everywhere.

@dmgtn
Copy link
Member Author

dmgtn commented Aug 21, 2019

After some discussion, we end up with the following:

  • static values – all values stored in YAML files and read during startup from two sources:
    • common static values (/modules/values.yaml) may contain:
      • global common static values,
      • module common static values.
    • module static values (modules/123-some-module/values.yaml) may contain only module values;
  • config values (ConfigMap) which consitsts of:
    • global config values
    • module config values
  • secret values (Secret) which consitsts of:
    • global secret values
    • module secret values
  • effective values patches or just values patches – JSON patches, received from hooks. We store separately:
    • global values patches
    • module values patches
  • effective values, or just values – is a result of a merge of 7 sources:
    • effective global values or just global values – a merge of three sources:
      • global common static values
      • global config values
      • global values patches
    • effective module values or just module values – a merge of four sources:
      • module common static values
      • module static values
      • module config values
      • module values patches.
  • We also have
    • config values patches, which can be either module config values patches or global config values patches, but we don't store them in memory, because they are instantly applied to the ConfigMap.
    • and secret values patches, which can be either module secret values patches or global secret values patches, but we don't store them in memory, because they are instantly applied to the Secret.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant