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

Feature/8 add helm chart #9

Merged
merged 4 commits into from
Aug 16, 2023
Merged

Feature/8 add helm chart #9

merged 4 commits into from
Aug 16, 2023

Conversation

lchen-2101
Copy link
Collaborator

closes #8

Copy link
Contributor

@gduncklee gduncklee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Member

@hkeeler hkeeler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No showstoppers, just general questions about Helm best practices.

k8s/Chart.yaml Outdated
Comment on lines 15 to 24
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.1.0

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
# follow Semantic Versioning. They should reflect the version the application is using.
# It is recommended to use it with quotes.
appVersion: "0.1.0"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do these values get updated? Via CI process that increments them?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gduncklee what are your insights on this one?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can probably drop appVersion, which is optional and is typically duplicated by .Values.image.tag.

We could update the Chart's version value within CI, we would want to ensure it is handling semver. This is something that should be addressed in the future, in my opinion.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dropped appVersion for now

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this file all boilerplate, or have you added anything specific to our project?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is boilerplate auto generated during the helm create process

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same question. Is this file all boilerplate, or have you added anything specific to our project?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one is also auto generated; it does define some variables that are used in the yaml files.

k8s/values.yaml Outdated Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it general practice to leave much of this file's setting with blank/empty values? To me, it seems more useful to populate this file with just the settings that are actually used, or will work as defaults, but will be overridden in higher environments.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The blank values here are placeholders referenced as default values in other yaml files; if the blank values aren't here, and an overriding values file isn't provided, the chart would fail to "compile".

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The idea with leaving many values blank is to ensure a helm chart may deploy in nearly all use cases (k3s, minikube, etc).

Cloning this repository and running helm template . from the k8s dir renders the chart templates as defined in the values.yaml; however, this does none of the server-side testing.

I personally prefer leaving as many values in the values.yaml as blank unless the default set would apply to all possible environments we are deploying into.

@lchen-2101 lchen-2101 merged commit 8324cbb into main Aug 16, 2023
@lchen-2101 lchen-2101 deleted the feature/8_add_helm_chart branch August 16, 2023 18:18
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.

Add Helm chart to user-fi-management for automated Kubernetes deployment
3 participants