Starter site integration #226

adam-vessey · 2022-09-09T18:09:39Z

GitHub Issue:

Replace islandora_defaults with an exported site islandora-starter-site islandora-starter-site#2
Deprecate islandora_defaults (Note: do not action till islandora-starter-site is ready) future ticket Islandora/islandora_defaults#74
Other Relevant Links (Google Groups discussion, related pull requests,
Release pull requests, etc.)
- Code Chill: Islandora Defaults
- Islandora Foundation contracting with DGI for "Modularizing Islandora" work

What does this Pull Request do?

Gets the new "starter site" project installable via ansible.

What's new?

Added the starter and starter_dev profiles, with minor reworks to allow some tasks to be suppressed.

Does this change require documentation to be updated? Unknown.
Does this change add any new dependencies? No/only if using the new "starter" profile(s).
Does this change require any other modifications to be made to the repository
(i.e. Regeneration activity, etc.)? No.
Could this change impact execution of existing code? Potentially, with how some of the ansible state had to be manipulated... it seems some things were referring to the wrong state (such as the Matomo things defining the set_search_api_config value, and "Solr" stuff still referring to it). Also, if there's other

How should this be tested?

Smoketest and compare the behaviours of the standard and demo "profiles" from before and after the changes made here, they should behave the same as they did previously.

Test out the new starter and starter_dev "profiles". Should come up and look much the same, with the only difference presently being that _dev performs a clone of the project (which is only really evident when looking at how it the project exists as it was deployed on the filesystem).

Additional Notes:

Nothing to mind...

Interested parties

Tag (@ mention) interested parties or, if unsure, @Islandora-Devops/committers

…on to be skipped.

... I think there's just one other section where there's a check for things being explicitly "standard" that we should move over to a shared variable?

adam-vessey · 2022-09-09T18:13:59Z

roles/internal/webserver-app/tasks/drupal.yml

+  when: webserver_app_do_original_trusted_host_and_more
+
+- name: Trusted Host Settings
+  blockinfile:
+    state: present
+    block: |
+      $settings['trusted_host_patterns'] = array(
+      {% for host in drupal_trusted_hosts %}
+        '{{ host }}',
+      {% endfor %}
+      );
+    path: "{{ drupal_trusted_hosts_file }}"
+    marker: // {mark} ANSIBLE MANAGED BLOCK - trusted hosts
+  when: webserver_app_do_trusted_host
+
+- name: Flysystem "fedora" scheme configuration
+  blockinfile:
+    state: present
+    block: |
+      $settings['flysystem'] = [
+        'fedora' => [
+          'driver' => 'fedora',
+          'config' => [
+            'root' => '{{ fedora_base_url }}',
+          ],
+        ],
+      ];
+    path: "{{ drupal_site_default_settings }}"
+    marker: // {mark} ANSIBLE MANAGED BLOCK - fedora flysystem scheme
+  when: webserver_app_do_fedora_scheme_config
+
+- name: Content Sync Directory configuration
+  blockinfile:
+    state: present
+    block: |
+      global $content_directories;
+      $content_directories['sync'] = $app_root.'/../content/sync';
+    path: "{{ drupal_site_default_settings }}"
+    marker: // {mark} ANSIBLE MANAGED BLOCK - content sync dir
+  when: webserver_app_do_content_sync_config


Not sure what the best approach was here, to allow for more granular control over what was being done in what was originally called the "Trusted Host Settings" bit, which was doing more than just setting the "trusted hosts" settings... elected to keep the original, but additionally have all the bits it contained be available in separate chunks, as we don't really want the content/sync thing being done in the starter "profile".

roles/internal/webserver-app/tasks/drupal.yml

adam-vessey · 2022-09-09T18:18:27Z

vars/starter.yml

+# Presently pointing at the main branch.
+drupal_composer_project_package: 'islandora/islandora-starter-site:dev-main'


This should eventually be pointed at whatever reference structure we move to use for releases... or maybe left without a version reference to pull whatever "latest" version?

vars/starter_dev.yml

vars/starter.yml

adam-vessey · 2022-09-09T18:54:14Z

roles/internal/webserver-app/tasks/solr.yml

-  changed_when: "'Do you want to update' in set_search_api_config.stdout"
+  changed_when: "'Do you want to update' in set_search_api_config_host.stdout"

 - name: Set default solr server to point to first core
  command: "{{ drush_path }} --root {{ drupal_core_path }} -y config-set search_api.server.default_solr_server backend_config.connector_config.core {{ solr_cores[0] }}"
  register: set_search_api_config_core
-  changed_when: "'Do you want to update' in set_search_api_config.stdout"
+  changed_when: "'Do you want to update' in set_search_api_config_core.stdout"


Looking back at https://github.com/Islandora-Devops/islandora-playbook/pull/126/files#diff-5bddb401e18178b7584b51cd9831eaa348385079b2224a85e3db8fa2412fc547L5-R15 ... I believe this is the intent, as otherwise, it seems that the set_search_api_config bit would've been being registered by the "Matomo" setup, in the webserver-app/tasks/drupal.yml bit?

Yeah that seems like a typo in the Matomo stuff.

rosiel · 2022-09-13T14:26:50Z

vars/starter.yml

+drupal_site_install_extra_args:
+  - '--existing-config'
+
+openseadragon_composer_require: false


Some of these - setting up Matomo and FITS - seem like they're false only because theyre out of scope at the moment but we probably eventually want them. Can you denote/comment/group them in some way to distinguish from the others which we do/don't need due to the architecture of the Starter Site?

Took a shot in 52f962a ... thoughts?

I feel like I should mention: Anything that does need to do any configuration probably maybe shouldn't do it by config:set'ing anything, but instead to use other mechanisms such as config_override to avoid potentially dirtying configs... to avoid specific environmental concerns creeping into things; for example: If the matomo.settings:url_http value was made to dynamically point at the hostname instead of just specifying localhost:8000, then yeah, it wouldn't really belong in the config that gets used between environments where that remote would(/could) vary.

... This... does kind of get into a weird area with how the JWT stuff is presently configured, in that because things were based on the "standard" playbook install, that it just so happens to match the paths; however, if other paths are ever specified for webserver_app_jwt_key_path, then it could end up diverging...

roles/internal/webserver-app/tasks/drupal.yml

Seems like Composer 2.4.2 (https://github.com/composer/composer/releases/tag/2.4.2) became more strict, preventing the command from returning completely.

…n't.

vars/starter_dev.yml

Also, allow the attempted chown'ing of islandora_defaults to be skipped... 'cause the starter stuff doesn't/shouldn't have it.

adam-vessey added 9 commits September 8, 2022 16:56

Allow the installation separate installation of isladnora/openseadrag…

10fb73a

…on to be skipped.

Theoretically most of it?

d59f15e

... I think there's just one other section where there's a check for things being explicitly "standard" that we should move over to a shared variable?

More granular control over some drupal tasks.

a97bb9a

Add the base starter_dev thing.

c420c2b

Allow matomo and fits to not be installed.

7b8ce49

Fix new "when" specs, and deconflate Matomo and Solr configs.

d16d818

Adjust/expand documentation of the "profiles".

500e8d1

Fix use of drupal_enable_modules variable in starter profiles.

8f978c2

Comment out the things being kept around for parallel structures.

2137655

adam-vessey commented Sep 9, 2022

View reviewed changes

Point at the merged starter site.

a18bde0

adam-vessey marked this pull request as ready for review September 12, 2022 17:26

rosiel reviewed Sep 13, 2022

View reviewed changes

adam-vessey added 2 commits September 13, 2022 11:42

Group variables based to some degree on function.

52f962a

Update the target string accordingly.

dd55067

adam-vessey mentioned this pull request Sep 13, 2022

Starter site integration Islandora-Devops/isle-dc#287

Merged

bibliophileaxe reviewed Sep 14, 2022

View reviewed changes

roles/internal/webserver-app/tasks/drupal.yml Show resolved Hide resolved

adam-vessey marked this pull request as draft September 14, 2022 16:06

Fix composer invocation to _not_ run as root.

d27c07c

Seems like Composer 2.4.2 (https://github.com/composer/composer/releases/tag/2.4.2) became more strict, preventing the command from returning completely.

adam-vessey mentioned this pull request Sep 15, 2022

Fix composer invocation to _not_ run as root. #227

Merged

adam-vessey added 3 commits September 15, 2022 13:33

Merge remote-tracking branch 'origin/dev' into feature/starter-site

785491b

Back to doing the Matomo and FITS things.

11cdd49

Since we now do Matomo and FITS, can drop the notes indicating we did…

80e4be7

…n't.

adam-vessey commented Sep 15, 2022

View reviewed changes

vars/starter_dev.yml Outdated Show resolved Hide resolved

adam-vessey added 5 commits September 15, 2022 16:44

Fix another instance of composer running as root.

61bb5ac

Merge remote-tracking branch 'origin/dev' into feature/starter-site

3eba24e

Add in the other migration.

632f2af

Also, allow the attempted chown'ing of islandora_defaults to be skipped... 'cause the starter stuff doesn't/shouldn't have it.

Drop standard "profile"

54ee90d

Point back upstream for the referenced repo.

b3f1bca

adam-vessey marked this pull request as ready for review September 20, 2022 16:42

willtp87 approved these changes Sep 20, 2022

View reviewed changes

Include the dev things in the dev thing.

2b26252

rosiel mentioned this pull request Sep 21, 2022

[TECH MGMT] Develop release process(es) for Starter Site, Playbook, and ISLE. Islandora/documentation#2175

Open

rosiel assigned alxp Sep 21, 2022

This was referenced Sep 21, 2022

Replace "standard" equivalent in Islandora-playbook with islandora-starter-site #230

Closed

Update to use islandora-starter-site Islandora-Devops/isle-dc#292

Closed

rosiel approved these changes Sep 22, 2022

View reviewed changes

rosiel merged commit efb025e into Islandora-Devops:dev Sep 22, 2022

adam-vessey deleted the feature/starter-site branch February 9, 2023 22:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Starter site integration #226

Starter site integration #226

adam-vessey commented Sep 9, 2022 •

edited

Loading

adam-vessey Sep 9, 2022 •

edited

Loading

adam-vessey Sep 9, 2022

adam-vessey Sep 9, 2022 •

edited

Loading

rosiel Sep 13, 2022

rosiel Sep 13, 2022

adam-vessey Sep 13, 2022

adam-vessey Sep 13, 2022 •

edited

Loading

		# Presently pointing at the main branch.
		drupal_composer_project_package: 'islandora/islandora-starter-site:dev-main'

Starter site integration #226

Starter site integration #226

Conversation

adam-vessey commented Sep 9, 2022 • edited Loading

What does this Pull Request do?

What's new?

How should this be tested?

Additional Notes:

Interested parties

adam-vessey Sep 9, 2022 • edited Loading

Choose a reason for hiding this comment

adam-vessey Sep 9, 2022

Choose a reason for hiding this comment

adam-vessey Sep 9, 2022 • edited Loading

Choose a reason for hiding this comment

rosiel Sep 13, 2022

Choose a reason for hiding this comment

rosiel Sep 13, 2022

Choose a reason for hiding this comment

adam-vessey Sep 13, 2022

Choose a reason for hiding this comment

adam-vessey Sep 13, 2022 • edited Loading

Choose a reason for hiding this comment

adam-vessey commented Sep 9, 2022 •

edited

Loading

adam-vessey Sep 9, 2022 •

edited

Loading

adam-vessey Sep 9, 2022 •

edited

Loading

adam-vessey Sep 13, 2022 •

edited

Loading