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

Document Jsonnet best practices #46

Open
2 of 11 tasks
simu opened this issue Jun 8, 2020 · 1 comment
Open
2 of 11 tasks

Document Jsonnet best practices #46

simu opened this issue Jun 8, 2020 · 1 comment

Comments

@simu
Copy link
Member

simu commented Jun 8, 2020

As more people start writing Commodore components, questions regarding Jsonnet best practices are popping up more frequently.

While we already have #36 to document component architecture and interface principles and #40 to establish a Jsonnet style convention and guide, other best practice areas also need documentation, e.g.:

  • best practices when using kube-libsonnet.

  • Best practices for internal component structure, such as what belongs in a component library, when does it make sense to have multiple jsonnet files in component/, etc.

  • Merging External Config Data

  • Loops and Filters

  • Component Library Functions

  • Conditional Keys and Files

  • Using kube-libsonnet

  • Using Library functions

  • CRD Group Versions

  • Container Image & Helm Chart Versions

  • Multiline Strings

  • Component Structure

  • Randomize (cron) schedules -> see Showcase how to randomize cron schedules #96

@srueg
Copy link
Contributor

srueg commented Sep 4, 2020

Draft PR with discussion notes: #86

@corvus-ch corvus-ch added this to To do in Project Syn Focus Weeks Oct 2020 via automation Oct 16, 2020
@corvus-ch corvus-ch moved this from To do to In progress in Project Syn Focus Weeks Oct 2020 Oct 19, 2020
@corvus-ch corvus-ch self-assigned this Oct 19, 2020
@corvus-ch corvus-ch moved this from In progress to To do in Project Syn Focus Weeks Oct 2020 Oct 19, 2020
@corvus-ch corvus-ch removed their assignment Oct 19, 2020
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

3 participants