Extend support for additional ondemand.d configuration parameters

[mikej888]

Environment:

• Ubuntu 22.04
• Python 3.11.5
• Ansible 8.0.0
• osc.open_ondemand 3.1.4

Extend templates/ondemand.yml.j2 to support all parameters defined in ondemand.d/*.yml files

For example, for the following (which I needed in a playbook I was writing):

dashboard_header_img_logo
disable_dashboard_logo
dashboard_logo
dashboard_logo_height
dashboard_title
nav_categories
navbar_type

I currently use a local template:

{% if dashboard_header_img_logo is defined %}
dashboard_header_img_logo: {{ dashboard_header_img_logo }}
{% endif %}
{% if disable_dashboard_logo is defined %}
disable_dashboard_logo: {{ disable_dashboard_logo | bool | lower}}
{% endif %}
{% if dashboard_logo is defined %}
dashboard_logo: {{ dashboard_logo }}
{% endif %}
{% if dashboard_logo_height is defined %}
dashboard_logo_height: {{ dashboard_logo_height }}
{% endif %}
{% if dashboard_title is defined %}
dashboard_title: {{ dashboard_title }}
{% endif %}
{% if nav_categories is defined %}
nav_categories: {{ nav_categories }}
{% endif %}
{% if navbar_type is defined %}
navbar_type: {{ navbar_type }}
{% endif %}

Similarly, add example defaults to defaults/main/ondemand.yml, for example:

dashboard_header_img_logo: null
disable_dashboard_logo: false
dashboard_logo: null
dashboard_logo_height: null
dashboard_title: "Open OnDemand"
navbar_type: default
nav_categories: ['Apps', 'Files', 'Jobs', 'Clusters', 'Interactive Apps']

Other, currently unsupported, parameters from ondemand.d/*.yml files include

brand_bg_color: null
brand_link_active_bg_color: null
profile_links: []
custom_css_files: []
custom_javascript_files: []
show_all_apps_link: false
nav_bar: []
help_bar: []
interactive_apps_menu: {}
custom_pages: {}
navbar_type: dark
public_url: "/public"
announcement_path:
  - "/etc/ood/config/announcement.md"
  - "/etc/ood/config/announcement.yml"
  - "/etc/ood/config/announcements.d"

[johrstrom]

Yea honestly, this role should just parrot what the puppet module does which is basically just copy YAML. That way, we don't have to keep up with upstream config options - folks can just supply the YAML they want to write and we write it.

[johrstrom]

I'm contemplating other breaking changes in the upcoming release like #238 so maybe in the next release we'll change this too. I kinda hate to do it because it'll be super painful for users, but in the long run it'll be a better for users of this role.

[mikej888]

@johrstrom, thanks. I'd agree that allowing users to specify whatever YAML they want would be easier for you to maintain. It's also consistent with what users have to do when providing dex configuration anyway so I wouldn't think it would challenge from that perspective.

As for breaking changes in the next release, perhaps support both approaches (without adding any more parameters to your current template) with a heads-up to users that the individual parameters are deprecated and you'll drop support for those in the next again release?

PS I'm finding your Ansible role very useful. It's also written in such a way that any limitations I've found (as reported in other issues today!) are straightforward to workaround at the playbook level! Thanks for developing it!

[johrstrom]

As for breaking changes in the next release, perhaps support both approaches

Thanks, that's a great idea and one I'll likely do. I can likely even patch that for this release so folks can start using the new approach now.

[mikej888]

I just noticed that my issue essentially duplicates 'templates/ondemand.yml.j2 not updated with OOD v3.0 options?' #224 (I think the terms I'd used to search the issue tracker before raising this issue weren't fine tuned enough)

[johrstrom]

🤦‍♂️ yep