cozystack icon indicating copy to clipboard operation
cozystack copied to clipboard

Fix service.yaml template error: handle nil values for service.ports

Open artemrootman opened this issue 1 year ago • 2 comments

Previously, an error occurred when trying to access .Values.service.ports in the template, leading to a nil pointer dereference. This commit corrects the issue by ensuring that service.ports is checked for existence before attempting to access it, preventing the error from occurring.

Changes:

  • Updated service.yaml to use {{- with .Values.service }}...{{- end }} for conditional rendering of ports.

artemrootman avatar Aug 21 '24 16:08 artemrootman

{{- if .Values.service.ports }} already tests for existence of .service.ports The only thing is you can test for existence of .Values.service via {{- if (.Values.service).ports }}

ginn13 avatar Aug 21 '24 17:08 ginn13

@ginn13 is that what you mean?

ports:
    - name: ssh
      port: 22
      targetPort: 22
    {{- if (.Values.service).ports }}
    {{- range .Values.service.ports }}
    - name: {{ .name }}
      port: {{ .port }}
      targetPort: {{ .targetPort }}
    {{- end }}
    {{- end }}

artemrootman avatar Aug 21 '24 17:08 artemrootman

Walkthrough

The updates to the virtual machine application include a version increment from 0.3.0 to 0.4.0, enhancements to the README documentation, and the introduction of new configuration parameters such as externalPorts and cloudInit. Additionally, new YAML templates for Kubernetes Secrets and modifications to the service and VM templates were made to improve flexibility and security in managing virtual machines. The JSON schema and values files were also updated to reflect these changes.

Changes

Files Change Summary
packages/apps/virtual-machine/Chart.yaml Version updated from 0.3.0 to 0.4.0.
packages/apps/virtual-machine/README.md Added "Accessing virtual machine" section; introduced externalPorts, updated sshKeys, increased disk size, added cloudInit, and modified examples.
packages/apps/virtual-machine/templates/secret.yaml New template for creating Kubernetes Secrets for SSH keys and cloud-init data.
packages/apps/virtual-machine/templates/service.yaml Changed service port configuration to use externalPorts for flexibility.
packages/apps/virtual-machine/templates/vm.yaml Added conditional logic for SSH keys and cloud-init, introduced accessCredentials, and updated volumes and networks sections.
packages/apps/virtual-machine/values.schema.json Added externalPorts and cloudInit; removed several SSH-related properties; updated sshKeys default.
packages/apps/virtual-machine/values.yaml Introduced externalPorts and cloudInit; modified sshKeys to be an empty array; removed legacy SSH parameters.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant VM_Config
    participant Kubernetes

    User->>VM_Config: Specify externalPorts and cloudInit
    VM_Config->>Kubernetes: Generate VM with new configurations
    Kubernetes->>Kubernetes: Create Secrets for SSH keys and cloud-init
    Kubernetes->>User: Provision virtual machine with access methods

🐰 "In fields of code, I hop and play,
New ports and clouds brighten my day!
With secrets safe and access clear,
My virtual friends are finally here!
Let's leap through changes, one and all,
In this techy world, we stand tall!" 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Aug 30 '24 09:08 coderabbitai[bot]