charts icon indicating copy to clipboard operation
charts copied to clipboard

[xray] Adding structured system yaml to allow for individual key/value overrides

Open nxf5025 opened this issue 1 year ago • 12 comments

PR Checklist

[Place an '[x]' (no spaces) in all applicable fields. Please remove unrelated fields.]

  • [x] Chart Version bumped
  • [x] CHANGELOG.md updated
  • [x] Variables and other changes are documented in the README.md
  • [x] Title of the PR starts with chart name (e.g. [artifactory])

What this PR does / why we need it:

Allows users to add/overwrite parts of the textual representation of the system.yaml after template evaluation. This allows users to provide individual overrides for the default system.yaml without needing to copy and paste the whole config.

For example:

To add the configuration talked about in this article it's as easy adding it to the structuredSystemYaml:

xray:
  structuredSystemYaml:
    indexer:
      compress:
        RationLimit: 500

This would result in something like the following when fully rendered:

  system.yaml: |
    configVersion: 1
    contextualAnalysis:
      image: jfrog/xray-jas-contextual-analysis
      registry: releases-docker.jfrog.io
    exposures:
      container:
        image: jfrog/xray-jas-exposures
        registry: releases-docker.jfrog.io
    indexer:
      compress:
        RationLimit: 2000
    router:
      serviceRegistry:
        insecure: false
    shared:
      database:
        driver: org.postgresql.Driver
        type: postgresql
      jfrogUrl: http://artifactory.artifactory.svc.cluster.local:8082
      logging:
        consoleLog:
          enabled: true

Special notes for your reviewer: Inspiration is from the Mimir Helm chart - https://github.com/grafana/mimir/pull/2100

If this gets accepted I will also be opening a similar PR for the Artifactory chart

nxf5025 avatar Nov 20 '23 20:11 nxf5025

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

github-actions[bot] avatar Nov 20 '23 20:11 github-actions[bot]

I have read the CLA Document and I hereby sign the CLA

nxf5025 avatar Nov 20 '23 20:11 nxf5025

@nxf5025 Thanks for the PR ! we would like to review this internally and come back next week . I hope this is much needed feature every one wants to try :)

cc @eldada @rahulsadanandan

chukka avatar Nov 21 '23 05:11 chukka

Update : we are planning to take this feature in coming weeks, if there are any changes required to this PR , we will let you know.

chukka avatar Dec 08 '23 09:12 chukka

@chukka Awesome sounds good. As promised I have also opened the Artifactory PR with the same changes - https://github.com/jfrog/charts/pull/1848

nxf5025 avatar Dec 08 '23 21:12 nxf5025

Update : we are internally evaluating refactoring systemYaml in values.yaml and would like to take this PR as part of it in next quarter , Thanks for your patience !

chukka avatar Dec 18 '23 03:12 chukka

@chukka any news on the ETA ?

gregoryboue avatar Jan 11 '24 07:01 gregoryboue

@gregoryboue We are planning to take this feature in this quarter. And we will update you on the release date soon.

Logeshwarsn avatar Jan 12 '24 11:01 Logeshwarsn

@Logeshwarsn the end of the quarter is coming, any news on this feature ?

gregoryboue avatar Feb 15 '24 18:02 gregoryboue

@chukka @Logeshwarsn do you have any release date of this feature ?

gregoryboue avatar Mar 11 '24 12:03 gregoryboue

@gregoryboue Due to other priorities, there has been a delay. We are now including this feature in the 3.95.x release, scheduled for May.

megha1906 avatar Mar 20 '24 09:03 megha1906

@gregoryboue Due to other priorities, there has been a delay. We are now including this feature in the 3.95.x release, scheduled for May.

Hi, we are in may and the 3.96 has been released but this feature is not available, is it possible to have an ETA ?

gregoryboue avatar May 28 '24 12:05 gregoryboue