Add a --config parameter to import config after install. #1875

simesy · 2015-12-18T00:13:50Z

Passing a --config parameter (eg. drush site-install --config=path/to/config) triggers the equivalent of a drush config-import --source=path/to/config after the installation is complete.

This is all-or-nothing, any UUIDs generated during the site installation will be overwritten, any config created during the installation that is not represented in the --config directory will be deleted.

A use case for feature is CI/testing where the source directory contains a known set of configuration to be tested.

For history of this feature see #1635

…er installation.

cweagans · 2015-12-18T00:32:20Z

commands/core/site_install.drush.inc

+  if ($config = drush_get_option('config')) {
+    // Set the destination site UUID to match the source UUID, to bypass a core fail-safe.
+    $source_storage = new FileStorage($config);
+    drush_op('drush_config_set', 'system.site', 'uuid', $source_storage->read('system.site')['uuid']);


Doesn't this modify the UUID from the source config (i.e. what's on disk)? That is not a desirable behavior if the config is in version control - that config on disk should never change IMO. Since this option is only available when installing a fresh site, I think it's safe enough to change what's in the site instead of in the config directory.

No, it modifies the UUID in the active config of the newly installed site. I've been using @markdorison's variation on this and it has never modified the source yml file on disk.

cweagans · 2015-12-18T00:34:13Z

I think this should also change the default profile choice to Minimal if --config is passed. Minimal doesn't create any config entities by default, whereas Standard does (shortcut links is what bit us in the past). Minimal provides the most likely path to success when installing from config, so it makes sense to me to switch that default.

simesy · 2015-12-18T00:50:47Z

That seems like a sound idea. It also makes the whole process faster.

simesy · 2015-12-18T01:48:16Z

Commit added to default to 'minimal' per @cweagans suggestion.

simesy · 2015-12-18T01:51:00Z

Hmm. Regardless of what you default the installation to, the imported configuration (assuming it includes core.extensions) has to match the name of the install profile or you get:

Unable to uninstall the <em class="placeholder">Minimal</em> profile since it is the install profile.

cweagans · 2015-12-18T02:21:37Z

@simesy I think it's okay to default to Minimal. If they're using some other profile, they can change it by adding the profile argument.

weitzman · 2015-12-20T19:15:01Z

commands/core/site_install.drush.inc

@@ -55,7 +56,8 @@ function site_install_drush_command() {
        'example-value' => 'directory_name',
      ),
      'writable' => 'Make CMI and other dirs writable by both web and CLI users. Suitable for non Prod environments.',
-      'keep-config' => 'Keep CMI directories untouched. This preserves existing configuration.'
+      'keep-config' => 'Keep CMI directories untouched. This preserves existing configuration.',


options that are version specific should get altered in so they aren't valid or shown for other versions. see user_drush_help_alter() for example.

Commit just pushed removes --config for versions less than 8.

weitzman · 2015-12-20T19:19:03Z

Left some minor comments. Would be good to hear that this actually works for folks.

simesy · 2015-12-21T22:39:15Z

To recap: All comments addressed. The call needs to be made about removing the 'minimal' profile part, I would suggest removing it unless we can replicate the problem it's mitigating.

weitzman · 2015-12-23T19:22:55Z

commands/core/site_install.drush.inc

@@ -55,7 +56,8 @@ function site_install_drush_command() {
        'example-value' => 'directory_name',
      ),
      'writable' => 'Make CMI and other dirs writable by both web and CLI users. Suitable for non Prod environments.',
-      'keep-config' => 'Keep CMI directories untouched. This preserves existing configuration.'
+      'keep-config' => 'Keep CMI directories untouched. This preserves existing configuration.',
+      'config' => 'After installation, override all configuration and UUIDs that were generated during installation with config from this file path.'


"Update site UUID and then import configuration from this path."

simesy · 2015-12-23T23:15:08Z

Resolved comments in last commit.

weitzman · 2015-12-23T23:41:19Z

Squashed and merged. Thanks much.

greg-1-anderson · 2015-12-25T05:16:22Z

This looks like it will be a good and useful feature, but we are not done yet; the new site-install option --config conflicts with the existing Drush global --config option, so folks like me who set --config cannot run site-install.

This local option needs to be renamed to something else.

Suggested fix for #1875: rename --config to --config-dir

simesy · 2015-12-25T07:05:28Z

Thanks greg!

alexpott · 2016-01-09T10:35:04Z

There are quite a few gotcha with this approach. If the install profiles on the source config and the drush install don't match then there are issues. Also the install language is interesting - I think it should match the site default language from system.site. To be honest I really wish we all got behind https://www.drupal.org/project/config_installer since this is doing exactly what people want, does it without installing incorrect config first, and has tests.

greg-1-anderson · 2016-01-09T17:23:07Z

I believe that the config installer works with drush site-install.

It sounds like the implementation of config_installer is currently more robust than what we have here, but some folks prefer the DX of the --config. Maybe some work could be done here to ensure consistency between installation variables and their corresponding configuration values. I don't know that it's a problem to install minimal profile first.

I think that the ideal solution, for the future would be to take the operation of the config_installer and make it part of the core installation code rather than having it be a separate installation profile. Until then, what we have is just a choice between different workarounds.

simesy · 2016-01-13T04:39:21Z

@alexpott To be honest I really wish we all got behind config_installer
I've passed over this solution because the projects I'm working on already use custom install profiles.

dgtlmoon · 2016-04-25T11:37:42Z

Some help for those just catching up here.

So I've got a site profile which installs fine with ../vendor/bin/drush site-install my_profile and I've already exported the configs with ../vendor/bin/drush config-export.

however when I run ../vendor/bin/drush site-install my_profile --config-dir=../config

Installation complete.  User name: admin  User password: YdkMThXM9B                                                                                                                             [ok]
No config value specified.                                                                                                                                                                   [error]
Invalid argument supplied for foreach() DrupalBoot.php:240                                                                                                                                 [warning]
 Collection  Config                                    Operation 
             views.view.taxonomy_term                  delete    
             views.view.frontpage                      delete    
...
             core.date_format.html_datetime            delete    
             core.date_format.html_date                delete    
             core.date_format.fallback                 delete    
 sync        core.date_format.fallback                 create    
 sync        core.date_format.html_date                create    
 sync        core.date_format.html_datetime            create    
 sync        core.date_format.html_month               create    
...
Import the listed configuration changes? (y/n): y
Drupal\Core\Config\ConfigImporterException: There were errors validating the config synchronization. in Drupal\Core\Config\ConfigImporter->validate() (line 725 of                           [error]
/var/www/site/web/core/lib/Drupal/Core/Config/ConfigImporter.php).
The import failed due for the following reasons:                                                                                                                                             [error]
This import is empty and if applied would delete all of your configuration, so has been rejected.

This error does not really mean anything to me, where am I going wrong?

dgtlmoon · 2016-04-25T11:41:31Z

@simesy have you seen https://www.drupal.org/node/2642398 ?

fluxsauce · 2016-05-06T05:42:11Z

@dgtlmoon The practical solution is to use https://www.drupal.org/project/config_installer

For a drush.make.yml:

projects:
  config_installer:
    type: "profile"
    version: "1.3"

Installation:

drush site-install config_installer --config-dir=PATH/TO/config/base --yes

marcelovani · 2016-09-05T15:13:12Z

I need to enable my own profile and import config from the repo to build a fresh site from code.

i.e. drush site-install my_profile --config-dir=PATH/TO/config/base --yes

How can I use config_installer to import the config? It is not possible to have two profiles enabled at the same time.

marcelovani · 2016-09-06T16:42:25Z

I think I figured out why it wasn't working and how config_installer knows that I want my_profile enabled.

Basically core.extension.yml is what defines which profile will be enabled.

I had an entry for standard: 0 which I changed to my_profile: 0

Now it works.

I can only make it work using the UI. When using drush, I get an error saying that the folder config/base is empty.

…nstall.

…h existing Drush global --config option. Rename the new site-install option to --config-dir.

Add a --config parameter to import configuration from a directory aft…

632d8b6

…er installation.

simesy mentioned this pull request Dec 18, 2015

Munge the uuids in sync dir before config-import #1635

Closed

cweagans reviewed Dec 18, 2015
View changes

Default the install profile to minimal for a full config import.

d118fcf

weitzman reviewed Dec 20, 2015
View changes

Alter out the --config option for versions less than 8.

207c237

weitzman reviewed Dec 23, 2015
View changes

Improved --config help and make var names consistent.

464c73c

weitzman closed this in b0fd9a3 Dec 23, 2015

greg-1-anderson reopened this Dec 25, 2015

greg-1-anderson closed this in 581555a Dec 25, 2015

greg-1-anderson added a commit that referenced this pull request Dec 25, 2015

Merge pull request #1885 from drush-ops/si-config

a2a7c41

Suggested fix for #1875: rename --config to --config-dir

geerlingguy mentioned this pull request Jan 20, 2016

Use drush's site-install --config-dir option instead of overriding UUID geerlingguy/raspberry-pi-dramble#59

Closed

bradjones1 mentioned this pull request Mar 3, 2016

Use --config param on site install instead of having to force UUID BradJonesLLC/docker-drupal#8

Closed

mikeker pushed a commit to mikeker/drush that referenced this pull request Aug 10, 2017

Fix drush-ops#1875. Add a --config parameter to import config after i…

69bde51

…nstall.

mikeker pushed a commit to mikeker/drush that referenced this pull request Aug 10, 2017

Fixes drush-ops#1875: site-install local option --config conflict wit…

552c480

…h existing Drush global --config option. Rename the new site-install option to --config-dir.

Add a --config parameter to import config after install. #1875

Add a --config parameter to import config after install. #1875

simesy commented Dec 18, 2015

cweagans Dec 18, 2015

simesy Dec 18, 2015

cweagans commented Dec 18, 2015

simesy commented Dec 18, 2015

simesy commented Dec 18, 2015

simesy commented Dec 18, 2015

cweagans commented Dec 18, 2015

weitzman Dec 20, 2015

simesy Dec 20, 2015

weitzman commented Dec 20, 2015

simesy commented Dec 21, 2015

weitzman Dec 23, 2015

simesy commented Dec 23, 2015

weitzman commented Dec 23, 2015

greg-1-anderson commented Dec 25, 2015

simesy commented Dec 25, 2015

alexpott commented Jan 9, 2016

greg-1-anderson commented Jan 9, 2016

simesy commented Jan 13, 2016

dgtlmoon commented Apr 25, 2016

dgtlmoon commented Apr 25, 2016

fluxsauce commented May 6, 2016

marcelovani commented Sep 5, 2016 •

edited

marcelovani commented Sep 6, 2016

Add a --config parameter to import config after install. #1875

Add a --config parameter to import config after install. #1875

Conversation

simesy commented Dec 18, 2015

cweagans Dec 18, 2015

Choose a reason for hiding this comment

simesy Dec 18, 2015

Choose a reason for hiding this comment

cweagans commented Dec 18, 2015

simesy commented Dec 18, 2015

simesy commented Dec 18, 2015

simesy commented Dec 18, 2015

cweagans commented Dec 18, 2015

weitzman Dec 20, 2015

Choose a reason for hiding this comment

simesy Dec 20, 2015

Choose a reason for hiding this comment

weitzman commented Dec 20, 2015

simesy commented Dec 21, 2015

weitzman Dec 23, 2015

Choose a reason for hiding this comment

simesy commented Dec 23, 2015

weitzman commented Dec 23, 2015

greg-1-anderson commented Dec 25, 2015

simesy commented Dec 25, 2015

alexpott commented Jan 9, 2016

greg-1-anderson commented Jan 9, 2016

simesy commented Jan 13, 2016

dgtlmoon commented Apr 25, 2016

dgtlmoon commented Apr 25, 2016

fluxsauce commented May 6, 2016

marcelovani commented Sep 5, 2016 • edited

marcelovani commented Sep 6, 2016

marcelovani commented Sep 5, 2016 •

edited