YDA-6125: update SRAM logo parameter

Update the SRAM logo parameter to use a BASE64 encoded image rather than a URL. This is needed because of a breaking change in the SRAM API: SURFscz/SBS#1604 See https://sram.surf.nl/apidocs/#/Organisation/post_api_collaborations_v1 for information on the current version of the API.
UtrechtUniversity · Jan 10, 2025 · fd2aa21 · fd2aa21
1 parent 0359969
commit fd2aa21
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 3 deletions.
diff --git a/docs/administration/configuring-yoda.md b/docs/administration/configuring-yoda.md
@@ -396,7 +396,7 @@ sram_auto_group_sync         | Automatic SRAM group sync
 sram_verbose_logging         | SRAM verbose logging
 sram_tls_verify              | Enable TLS verification for SRAM API calls. Enabled by default, but disabled on development environments because these use a mock service with a self-signed certificate.
 sram_co_default_label        | Default label for created COs
-sram_co_logo_url             | URL to image used as default SRAM CO logo
+sram_co_logo                 | Base64 encoded image used as default SRAM CO logo (by default it has an image of the Surf logo; see the default value for the exact format)
 
 ### EPIC PID Configuration
 

diff --git a/docs/release-notes/release-1.9.md b/docs/release-notes/release-1.9.md
@@ -146,3 +146,7 @@ irule -r irods_rule_engine_plugin-irods_rule_language-instance -F /etc/irods/yod
 ```bash
 irule -r irods_rule_engine_plugin-irods_rule_language-instance -F /etc/irods/yoda-ruleset/tools/update-publications.r
 ```
+
+19. When upgrading an SRAM-enabled environment to Yoda 1.9.5 or later, please note that the `sram_co_logo_url` parameter (which took a URL)
+    has been changed to `sram_co_logo` (which takes a BASE64-encoded image). If you have defined a custom logo, you will need to change this
+    parameter in your configuration.
diff --git a/roles/yoda_rulesets/defaults/main.yml b/roles/yoda_rulesets/defaults/main.yml
@@ -179,7 +179,8 @@ sram_auto_group_sync: false                            # Automatic SRAM group sy
 sram_verbose_logging: false                            # SRAM verbose logging
 sram_tls_verify: true                                  # Enable TLS verification for SRAM API calls. Enabled by default.
 sram_co_default_label: yoda                            # Default label for created COs
-sram_co_logo_url: https://raw.githubusercontent.com/UtrechtUniversity/yoda/development/docs/graphic_mark/png/UU_Beeldmerk_Yoda_FC_DEF.png  # URL to image used as default SRAM CO logo
+# Base64 encoded logo for Surf COs (default value has the Surf logo)
+sram_co_logo: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAQAQMAAABNzu8aAAAABlBMVEUAAAD///+l2Z/dAAAANUlEQVQI12M4wMD+n6GBgRFKzF1fCCTWJv5naF0PJOa8dYTLMvxn+P//Rz2Q+McII/6jEc0Apj0ocj5hnEcAAAAASUVORK5CYII="
 
 yoda_portal_fqdn: PLACEHOLDER                          # Yoda portal FQDN
 

diff --git a/roles/yoda_rulesets/templates/rules_uu.cfg.j2 b/roles/yoda_rulesets/templates/rules_uu.cfg.j2
@@ -101,7 +101,7 @@ sram_flow                      = '{{ sram_flow }}'
 sram_verbose_logging           = '{{ ["false", "true"][sram_verbose_logging|int] }}'
 sram_tls_verify                = '{{ ["false", "true"][sram_tls_verify|int] }}'
 sram_co_default_label          = '{{ sram_co_default_label }}'
-sram_co_logo_url               = '{{ sram_co_logo_url }}'
+sram_co_logo                   = '{{ sram_co_logo }}'
 {% endif %}
 
 arb_enabled                    = '{{ ["false", "true"][irods_arb_enabled|int] }}'