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
Grraahaam
wants to merge
17
commits into
Infisical:main
Choose a base branch
from
Grraahaam:docs/helm-charts
base: main
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Description updated for readability and to provide more resources explaining some choices |
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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β implement
helm-schema
to automatically generate YAML validation schema for Helmhelm-docs
: [Enhancement] Also usevalues.schema.json
Β norwoodj/helm-docs#90β set the infisical service port to
80
instead of8080
(standard port forhttp
)β 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>
infisical-secrets
to provide the same variablesinfisical.config
>infisical.secrets
>default
(e.g. for postgres and redis)env:
andenvFrom:
: https://flagzeta.org/articles/difference-between-env-and-envfrom-kubernetes-deployments/β deprecate the
infisical
(mongodb) chartβ update all the
Chart.yaml
to be a bit more completeβ remove and rename some redis keys not found in the remote chart
usePassword
doesnt seems to be available and have been replaced byauth.enabled
cluster.enabled
doesnt exist and have been removed (as its a complete different chart in Bitnami's repo)β merge postgres persistence common settings to current
values.yaml
BTW we might need to update the old deprecated images on https://hub.docker.com?
Some resources about schema validation:
Type β¨
Tests π οΈ
You can follow the doc provided in this PR, everything is explained. Let me know if you need further explanations