wunderio/radi-project-wundertoolswrapper

Radi init template for using radi on a wundertools project.

radi wrapper for Wundertools D8 Projects

This is a radi init template that can be used to make an existing wundertools Drupal8 project work with radi.

Using the template, you can add the needed files to any wundertools project, and run a few commands to get radi to provide commands to manage a local development environment.

More details can be found in the wiki

How to add this to an existing project

Before you try to use this, you will need to install the radi-cli (https://github.com/wunderkraut/radi-cli)

Automatically

You can use our script installer directly to perform that above steps.

This script can be found in this repo .radi/tools/wundertools/radify.sh

( https://raw.githubusercontent.com/wunderkraut/radi-project-wundertoolswrapper/master/.radi/tools/wundertools/radify.sh )

You can download that script to your project root, or just run it directly:

sh -c "$(curl -fsSL https://raw.githubusercontent.com/wunderkraut/radi-project-wundertoolswrapper/master/.radi/tools/wundertools/radify.sh)"

This script is not necessary, it just tries to make things a bit easier. If you don't like running random internet scripts, take a look at out manual steps desribed below.

Manually

If you don't like the looks of that automatic method, you can manually perform the automated steps.

You can simple follow these 2 steps:

1. In any wundertools D8 project root, use the init.yml from this repository

run:

$/> radi local.project.create --project.create.source https://raw.githubusercontent.com/wunderkraut/radi-project-wundertoolswrapper/master/.radi/init.yml

This should add the needed files.

2. Change some settings

The only setting that needs assignment can be done by string replacing %PROJECT% and %PORTBASE% across all of the added files with a string name for the project.

This will likey be automated next, but there are only a few instances, so it is usable already.

How to use it after integration

Once the project has been intialized, you should be able to use the radi cli tool to manage and orchestrate your project as needed.

Most commonly, you will want to run:

$/> radi up

But there are many more commands for shell acces, for drush, for build.sh and more. To get more help try:

$/> radi

• Note that some commands will only be visible with the initializer environment:

$/> radi --environment=initializer

---

More details can be found in the wiki

radi-project-wundertoolswrapper's Issues

How can I populate the db

There should be some documentation on how to properly populate the database.

I should be able to select a base port when radifying my project to allow concurrent projects to run

Currently devs can only have one project running at a time if they use localhost ports (OSX mandatory)

This is manageable, but limiting.

Build.sh produces error "[Errno 21] Is a directory:" for patsh in site.yml:links:

If a wundertools project has a site.yml with a links section that includes some folders that we then map using docker volumes, then the build.sh finalizer will fail with an error such as:

** BUILD ERROR: [Errno 21] Is a directory: '/app/project/drupal/current/web/sites/default/files'

Finalise the documentation

Add minimum requirements to the documentation.

Repeated initialization fails with "No help topic for 'local.project.create'"

When running the radify script in a project that has already been radified, the following error occurs:

INIT> https://raw.githubusercontent.com/wunderkraut/radi-project-wundertoolswrapper/master/.radi/init.yml [temporarily in : /tmp/tmp.Fj0Oelggv1
  --> replacing Project template variable
  --> replacing base-port template variable
  --> Running template init:
No help topic for 'local.project.create'

This is the upstream report for wunderio/radi-cli#35

Db connection fails with "connection refused"

Sometimes when bringing up the application, the fpm encounters an error trying to connect to the db:

PDOException: SQLSTATE[HY000] [2003] Can't connect to MySQL server on 'db.app' (111 "Connection refused") in /app/web/core/lib/Drupal/Component/DependencyInjection/PhpArrayContainer.php on line 79 #0 /app/web/core/lib/Drupal/Core/Database/Driver/mysql/Connection.php(142): PDO->__construct('mysql:host=db.a...', 'app', 'app', Array)

[Request] automate the %PROJECT% replacement

Currently you need to do a manual string replacement after running the project creation step from the init.yml.

It would be bnetter if this was an automate Q&A set of questions that did the string replacement itself.

error when runningradify script : No help topic for 'local.project.create

When running the radify script in a WT project, I get the following error:

##### Processing init templates

In this stage we will use one or more radi initialization templates to add files 
to your project.
We will download each template to a temporary file on your host, process it, and
then run it.

The current templates being 
considered are: 
https://raw.githubusercontent.com/wunderkraut/radi-project-wundertoolswrapper/master/.radi/init.yml


INIT> https://raw.githubusercontent.com/wunderkraut/radi-project-wundertoolswrapper/master/.radi/init.yml [temporarily in : /tmp/tmp.tar2gJxJQh
  --> replacing Project template variable
  --> replacing base-port template variable
  --> Running template init:
ERRO[0000] Error loading config for user                 error="Unknown config key requested"
No help topic for 'local.project.create'
 

Intialization complete

##### Finalization

Now that the project initialization is complete, you should be able to run radi'
as a command line tool anywhere inside your project.

The first steps that you should perform, in order to be able to start using the
the tool, are to perform the source code image build.
You can do this at anytime using the build command (see .radi/commands.yml)

$/> radi build

The build creates a docker image with source code in it, that can be used in
production, but can also be used locally with local source code bound in place.


Would you like me to run the initial image build (probably 5 minutes build time)? (y/N)
y
 
Running build --->
 
ERRO[0000] Error loading config for user                 error="Unknown config key requested"
ERRO[0000] Could not parse config for project project : yaml: line 86: found character that cannot start any token 
FATA[0000] Could not make the docker-compose project.    error="yaml: line 86: found character that cannot start any token"

drush produces strange contstrained output

When using the radi drush command, output of the command is distorted:

$ radi drush st --strict=0
 Drupal      :  8 
 version        . 
                2 
                . 
                3 
 Site URI    :  h 
                t 
                t 
                p 
                : 
                / 
                / 
                d 
                e 
                f 
                a 
                u 
                l 
                t 
 Database    :  m 
 driver         y 
                s 
                q 
                l 
 Database    :  d 
 hostname       b 
                . 
                a 
                p 
                p 
 Database    :    
 port             
 Database    :  a 
 username       p 
                p 
 Database    :  a 
 name           p 
                p 

Can we get a WunderTools D7 wrapper?

Can we get a version of the wrapper that works with D7 projects

after radifying, it is unclear how to use the project

The current documentation needs clarification on how to use radi, once the project has been radified.

Documentation: getting up and running

Readme should have clear steps how to get up and running after build.
e.g. How to bring the instances up (radi up)
How to access your site (go to localhost: [xx]81, where xx is the value you gave as prefix)

Cannot install Drupal: files folder not writeable

With the current wrapper, you cannot install Drupal as the sites/default/files folder is not writeable by the fpm server.