Skip to content

feat: Add support to user-specific overrides for catalog users and components - #47

Merged
rm3l merged 32 commits into
redhat-developer:mainfrom
Fortune-Ndlovu:RHIDP-4263-users-yaml-override
Jun 24, 2025
Merged

rm3l merged 32 commits into
redhat-developer:mainfrom
Fortune-Ndlovu:RHIDP-4263-users-yaml-override

Conversation

@Fortune-Ndlovu

@Fortune-Ndlovu Fortune-Ndlovu commented May 21, 2025 •

Copy link
Copy Markdown
Member

Description

The wait-for-plugins-and-start.sh script now simplifies startup by:

  • Copying the default app-config.yaml to generated/app-config.patched.yaml
  • Replacing target: paths for users.yaml and components.yaml if corresponding override files exist
  • Launching the backend using the patched config along with any optional local overrides

Which issue(s) does this PR fix or relate to

PR acceptance criteria

  • Tests
  • Documentation

How to test changes / Special notes to the reviewer

@Fortune-Ndlovu

Copy link
Copy Markdown
Member Author

cc/ @rm3l for review, please

@rm3l

rm3l commented Jun 3, 2025

Copy link
Copy Markdown
Member

/cc

@openshift-ci
openshift-ci Bot requested a review from rm3l June 3, 2025 11:08
Comment thread configs/catalog-entities/components.yaml
Comment thread configs/catalog-entities/components.yaml
Comment thread wait-for-plugins.sh Outdated
Comment thread wait-for-plugins.sh Outdated
Comment thread configs/app-config/app-config.local.example.yaml Outdated
@rm3l rm3l changed the title chore(feat): Add support to user-specific overrides for catalog users and components feat: Add support to user-specific overrides for catalog users and components Jun 10, 2025
@Fortune-Ndlovu
Fortune-Ndlovu force-pushed the RHIDP-4263-users-yaml-override branch from 6973631 to f80fa06 Compare June 16, 2025 14:19
@Fortune-Ndlovu
Fortune-Ndlovu requested a review from rm3l June 16, 2025 15:35
@rm3l

rm3l commented Jun 17, 2025

Copy link
Copy Markdown
Member

@Fortune-Ndlovu Could you please rebase your branch and fix the conflicts?

@Fortune-Ndlovu
Fortune-Ndlovu force-pushed the RHIDP-4263-users-yaml-override branch 2 times, most recently from d08d145 to 03fa772 Compare June 17, 2025 11:22
@Fortune-Ndlovu
Fortune-Ndlovu force-pushed the RHIDP-4263-users-yaml-override branch from 03fa772 to e6d4f25 Compare June 17, 2025 11:25
Signed-off-by: Fortune-Ndlovu <fndlovu@redhat.com>
Signed-off-by: Fortune-Ndlovu <fndlovu@redhat.com>
Signed-off-by: Fortune-Ndlovu <fndlovu@redhat.com>
Signed-off-by: Fortune-Ndlovu <fndlovu@redhat.com>
Signed-off-by: Fortune-Ndlovu <fndlovu@redhat.com>
@Fortune-Ndlovu

Copy link
Copy Markdown
Member Author

@rm3l I have rebased and fixed conflicts

Comment thread configs/catalog-entities/components.override.yaml Outdated
Comment thread configs/catalog-entities/users.override.yaml
Signed-off-by: Fortune-Ndlovu <fndlovu@redhat.com>
Signed-off-by: Fortune-Ndlovu <fndlovu@redhat.com>
@Fortune-Ndlovu

Copy link
Copy Markdown
Member Author

Thanks @rm3l, I've made the following changes to align with the convention you recommended:

  • Renamed users.override.yaml to users.override.example.yaml
  • Renamed components.override.yaml to components.override.example.yaml
  • Updated .gitignore to exclude the actual users.override.yaml and components.override.yaml files, ensuring only the example templates are tracked.
  • Updated the README.md to instruct users to copy the example files before customizing:
cp configs/catalog-entities/users.override.example.yaml configs/catalog-entities/users.override.yaml
cp configs/catalog-entities/components.override.example.yaml configs/catalog-entities/components.override.yaml
  • Updated prepare-and-install-dynamic-plugins.sh to use the new .example.yaml file paths when checking for overrides:
USERS_OVERRIDE="/opt/app-root/src/configs/catalog-entities/users.override.example.yaml"
COMPONENTS_OVERRIDE="/opt/app-root/src/configs/catalog-entities/components.override.example.yaml"

This setup ensures that example override files are tracked in Git, while actual user configs remain local and Git-ignored. It also aligns with how dynamic plugin overrides are handled

Comment thread prepare-and-install-dynamic-plugins.sh Outdated
Comment thread prepare-and-install-dynamic-plugins.sh Outdated
Comment thread prepare-and-install-dynamic-plugins.sh Outdated
Signed-off-by: Fortune-Ndlovu <fndlovu@redhat.com>
Signed-off-by: Fortune-Ndlovu <fndlovu@redhat.com>
Signed-off-by: Fortune-Ndlovu <fndlovu@redhat.com>
Signed-off-by: Fortune-Ndlovu <fndlovu@redhat.com>
@Fortune-Ndlovu

Copy link
Copy Markdown
Member Author

Thanks @rm3l for the thorough review!

@Fortune-Ndlovu
Fortune-Ndlovu requested a review from rm3l June 19, 2025 09:55
Comment thread wait-for-plugins-and-start.sh Outdated
Signed-off-by: Fortune-Ndlovu <fndlovu@redhat.com>
@Fortune-Ndlovu
Fortune-Ndlovu requested a review from rm3l June 19, 2025 14:29
Comment thread wait-for-plugins-and-start.sh Outdated
Signed-off-by: Fortune-Ndlovu <fndlovu@redhat.com>
…rride, then append your custom ones

Signed-off-by: Fortune-Ndlovu <fndlovu@redhat.com>
… any targeting users.yaml or components.yaml, and append override entries for those two only.

Signed-off-by: Fortune-Ndlovu <fndlovu@redhat.com>
Comment thread wait-for-plugins-and-start.sh Outdated
Signed-off-by: Fortune-Ndlovu <fndlovu@redhat.com>
Signed-off-by: Fortune-Ndlovu <fndlovu@redhat.com>
@Fortune-Ndlovu
Fortune-Ndlovu requested a review from rm3l June 23, 2025 13:32
Comment thread wait-for-plugins-and-start.sh Outdated
Comment thread wait-for-plugins-and-start.sh Outdated
Comment thread wait-for-plugins-and-start.sh Outdated
Signed-off-by: Fortune-Ndlovu <fndlovu@redhat.com>
@Fortune-Ndlovu
Fortune-Ndlovu requested a review from rm3l June 23, 2025 16:07
Comment thread wait-for-plugins-and-start.sh Outdated
Comment thread wait-for-plugins-and-start.sh Outdated
Signed-off-by: Fortune-Ndlovu <fndlovu@redhat.com>
@Fortune-Ndlovu

Copy link
Copy Markdown
Member Author

@rm3l lgtm

@Fortune-Ndlovu
Fortune-Ndlovu requested a review from rm3l June 24, 2025 10:25
Comment thread wait-for-plugins-and-start.sh Outdated
Comment thread wait-for-plugins-and-start.sh Outdated
Signed-off-by: Fortune-Ndlovu <fndlovu@redhat.com>
@Fortune-Ndlovu
Fortune-Ndlovu requested a review from rm3l June 24, 2025 11:28

@rm3l rm3l left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM - thanks!

/lgtm

@openshift-ci openshift-ci Bot added the lgtm label Jun 24, 2025
@rm3l
rm3l merged commit 2abcc3c into redhat-developer:main Jun 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants