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

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

Merged

Conversation

nxf5025
Copy link
Contributor

@nxf5025 nxf5025 commented Nov 20, 2023

PR Checklist

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

  • Chart Version bumped
  • CHANGELOG.md updated
  • Variables and other changes are documented in the README.md
  • 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 - grafana/mimir#2100

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

Copy link

github-actions bot commented Nov 20, 2023

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

@nxf5025
Copy link
Contributor Author

nxf5025 commented Nov 20, 2023

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

@nxf5025 nxf5025 force-pushed the xray-structured-yaml branch from 1fafc70 to 7642567 Compare November 20, 2023 20:50
@nxf5025 nxf5025 force-pushed the xray-structured-yaml branch from 7642567 to 5dcd687 Compare November 20, 2023 20:51
@chukka
Copy link
Collaborator

chukka commented Nov 21, 2023

@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 chukka added enhancement New feature or request good first issue Good for newcomers labels Nov 21, 2023
@chukka
Copy link
Collaborator

chukka commented Dec 8, 2023

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.

@nxf5025
Copy link
Contributor Author

nxf5025 commented Dec 8, 2023

@chukka Awesome sounds good. As promised I have also opened the Artifactory PR with the same changes - #1848

@chukka
Copy link
Collaborator

chukka commented Dec 18, 2023

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 !

@gregoryboue
Copy link

@chukka any news on the ETA ?

@Logeshwarsn
Copy link
Contributor

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

@gregoryboue
Copy link

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

@gregoryboue
Copy link

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

@megha1906
Copy link
Collaborator

megha1906 commented Mar 20, 2024

@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.

@gregoryboue
Copy link

@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 ?

@rahulsadanandan rahulsadanandan changed the base branch from master to xray-release-3.97.3 July 5, 2024 09:40
@rahulsadanandan rahulsadanandan merged commit 1eb99c8 into jfrog:xray-release-3.97.3 Jul 5, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants