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

doc: helm charts documentation #1553

Open
wants to merge 17 commits into
base: main
Choose a base branch
from

Conversation

Grraahaam
Copy link
Contributor

@Grraahaam Grraahaam commented Mar 11, 2024

Description πŸ“£

Note

I know there's a lot of addition, but it's mostly auto-generated. Schemas and documentation ✌🏽

Documentation was missing for the new infisical-standalone chart, and previous helm charts documentations were a bit outdated. This PR aims to resolve this.

What have been done:

  • βœ… implement helm-docs instead of the previous automated documentation generator

    • used gotemplates for DRY and automation purposes
    • generated the charts' documentation
  • βœ… implement helm-schema to automatically generate YAML validation schema for Helm

  • βœ… set the infisical service port to 80 instead of 8080 (standard port for http)

    • to avoid thinking about the port when trying to use the service's URL in-cluster (e.g. self-hosted + operator)
  • βœ… add license to each of the charts, aiming to be used one day by either cloudsmith/artifact.io... (common in other helm charts)

  • βœ… add alternative for the developers to define their infisical configuration directly through helm with infisical.config.<CONFIG_KEY>

  • βœ… deprecate the infisical (mongodb) chart

  • βœ… update all the Chart.yaml to be a bit more complete

    • those additional keys help the registries to scan your chart correctly and provide accurate information to the developers
  • βœ… remove and rename some redis keys not found in the remote chart

  • βœ… merge postgres persistence common settings to current values.yaml

    • if the developer wants to increase the PVC size for example

BTW we might need to update the old deprecated images on https://hub.docker.com?


Some resources about schema validation:

Type ✨

  • New feature
  • Documentation

Tests πŸ› οΈ

You can follow the doc provided in this PR, everything is explained. Let me know if you need further explanations


@Grraahaam Grraahaam changed the title d doc: helm charts documentation Mar 11, 2024
@akhilmhdh akhilmhdh requested a review from maidul98 March 12, 2024 13:38
@Grraahaam
Copy link
Contributor Author

Description updated for readability and to provide more resources explaining some choices

@Grraahaam
Copy link
Contributor Author

Hey @maidul98, any chance you get some time to review this PR? Want me to fix the conflicts already?

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

Successfully merging this pull request may close these issues.

None yet

1 participant