Skip to content

Conversation

@venkatalolla
Copy link
Contributor

@venkatalolla venkatalolla commented May 29, 2024

PR Description

This is a new feature request to create a Helm chart to support the Kubernetes based deployments in a package pattern. This Helm chart should enable the NeoDash deployment in either editor or reader mode for easy versioning, packaging and installing these dashboards at an enterprise level.

The solution includes a Helm chart with the following Kubernetes resources templates to support the editor or reader mode for ease of deployment,

  • Deployment
  • Service
  • Service Account
  • Ingress (Optional)
  • Values file (Default configurations)
  • Along with the Helm chart, add the appropriate documentation about the usage and default values.

As an alternative solution I also included the required Kubernetes YAML files to deploy the NeoDash with Kubectl commands.
#884

- Includes the Helm chart required for the NeoDash deployment for the
  Kubernetes clusters
- Includes the example YAML files for the Kubernetes manifests
- Appropriate document changes to include the new Kubernetes
  deployments.

Signed-off-by: Lolla, Venkata <[email protected]>
Signed-off-by: Lolla, Venkata <[email protected]>
metadata:
labels:
application: neodash-deploy
spec:

Check warning

Code scanning / SonarCloud

Service account tokens should not be mounted in pods

<!--SONAR_ISSUE_KEY:AY_Fz5jUsMRbrEHSsoq6-->Set automountServiceAccountToken to false for this specification of kind Deployment. <p>See more on <a href="https://sonarcloud.io/project/issues?id=neo4j-labs_neodash&issues=AY_Fz5jUsMRbrEHSsoq6&open=AY_Fz5jUsMRbrEHSsoq6&pullRequest=902">SonarCloud</a></p>
"helm.sh/hook": test
spec:
containers:
- name: wget

Check warning

Code scanning / SonarCloud

Memory limits should be enforced

<!--SONAR_ISSUE_KEY:AY_Fz5kFsMRbrEHSsoq7-->Specify a memory limit for this container. <p>See more on <a href="https://sonarcloud.io/project/issues?id=neo4j-labs_neodash&issues=AY_Fz5kFsMRbrEHSsoq7&open=AY_Fz5kFsMRbrEHSsoq7&pullRequest=902">SonarCloud</a></p>
{{- include "neodash.labels" . | nindent 4 }}
annotations:
"helm.sh/hook": test
spec:

Check warning

Code scanning / SonarCloud

Service account tokens should not be mounted in pods

<!--SONAR_ISSUE_KEY:AY_Fz5kFsMRbrEHSsoq8-->Set automountServiceAccountToken to false for this specification of kind Pod. <p>See more on <a href="https://sonarcloud.io/project/issues?id=neo4j-labs_neodash&issues=AY_Fz5kFsMRbrEHSsoq8&open=AY_Fz5kFsMRbrEHSsoq8&pullRequest=902">SonarCloud</a></p>
{{- with .Values.podLabels }}
{{- toYaml . | nindent 8 }}
{{- end }}
spec:

Check warning

Code scanning / SonarCloud

Service account tokens should not be mounted in pods

<!--SONAR_ISSUE_KEY:AY_Fz5kIsMRbrEHSsoq9-->Set automountServiceAccountToken to false for this specification of kind Deployment. <p>See more on <a href="https://sonarcloud.io/project/issues?id=neo4j-labs_neodash&issues=AY_Fz5kIsMRbrEHSsoq9&open=AY_Fz5kIsMRbrEHSsoq9&pullRequest=902">SonarCloud</a></p>
@venkatalolla venkatalolla changed the title [Feature/fix-issue-884] Helm chart for Kubernetes deployments [Feature #884] Helm chart for Kubernetes deployments May 29, 2024
Signed-off-by: Lolla, Venkata <[email protected]>
@sonarqubecloud
Copy link

sonarqubecloud bot commented Jun 5, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@alfredorubin96
Copy link
Collaborator

Hi @venkatalolla, thank you for your contribution! Could you please check the warning that are popping up in this page and check whether they are critical or not?

Thanks again for helping the project!

@venkatalolla
Copy link
Contributor Author

venkatalolla commented Jun 13, 2024

Hey @alfredorubin96, thanks a bunch for taking the time to review my pull request! 😄 If you're referring to the SonarCloud warnings, I've already taken care of them in my most recent commit, and they're all gone now. Just wanted to let you know, and also, they weren't critical anyway.

@alfredorubin96
Copy link
Collaborator

Looked at the code and sounds good to me, could you please provide me an easy way to test it? I'm not an expert in developing helm charts, but there is a way in which we can test the deployment inside our pipelines?

@venkatalolla
Copy link
Contributor Author

Hello @alfredorubin96, Thank you for the response. For testing the Helm chart deployment, I have put together a GitHub workflow in my own repository, https://github.com/venkatalolla/neodash-kind-helm-workflow, that deploys the Helm chart to a local KinD Kubernetes cluster and validates the 200 response for the NeoDash URL using CURL.

For your information, I have tested the above-shared workflow here using the same code from this PR as an example.

Let me know if you want me to provide more details on the GitHub workflow or the deployment.

@venkatalolla
Copy link
Contributor Author

@alfredorubin96, please let me know if you need more information on my last comment.

@msenechal
Copy link
Collaborator

msenechal commented Nov 13, 2024

Moved to PR #971 for small changes/typo
Thanks a lot @venkatalolla for the great work !

@nielsdejong
Copy link
Collaborator

nielsdejong commented Nov 14, 2024

Closing as this is moved to #971, thanks everyone.

@nielsdejong nielsdejong mentioned this pull request Nov 14, 2024
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.

4 participants