Add wsgi handling to ironic-api in devstack

Adds handling of running ironic API under Apache as WSGI app to
devstack plugin.

New variable IRONIC_USE_MOD_WSGI (False by default) is added.
Another new variable IRONIC_WSGI_DIR (default is distro specific) is
also added, which specifies location for WSGI scripts.

Change-Id: I9c5ad56e1acd292ff0f9cc9b460125fc420abda5
Closes-Bug: #1513005

devstack/files/apache-ironic-api.template

@@ -0,0 +1,40 @@
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+# This is an example Apache2 configuration file for using the
+# Ironic API through mod_wsgi.  This version assumes you are
+# running devstack to configure the software.
+
+Listen %IRONIC_SERVICE_PORT%
+
+<VirtualHost *:%IRONIC_SERVICE_PORT%>
+    WSGIDaemonProcess ironic-api user=%USER% processes=%APIWORKERS% threads=%APIWORKERS% display-name=%{GROUP}
+    WSGIScriptAlias / %IRONIC_WSGI_DIR%/app.wsgi
+    WSGIApplicationGroup %{GLOBAL}
+    WSGIProcessGroup ironic-api
+    WSGIPassAuthorization On
+    ErrorLogFormat "%M"
+    ErrorLog /var/log/%APACHE_NAME%/ironic-api.log
+    CustomLog /var/log/%APACHE_NAME%/ironic-api-access.log combined
+
+    <Directory %IRONIC_WSGI_DIR%>
+        WSGIProcessGroup ironic-api
+        WSGIApplicationGroup %{GLOBAL}
+        <IfVersion >= 2.4>
+            Require all granted
+        </IfVersion>
+        <IfVersion < 2.4>
+            Order allow,deny
+            Allow from all
+        </IfVersion>
+    </Directory>
+</VirtualHost>

devstack/lib/ironic

@@ -60,6 +60,12 @@ IRONIC_CONF_DIR=${IRONIC_CONF_DIR:-/etc/ironic}
 IRONIC_CONF_FILE=$IRONIC_CONF_DIR/ironic.conf
 IRONIC_ROOTWRAP_CONF=$IRONIC_CONF_DIR/rootwrap.conf
 IRONIC_POLICY_JSON=$IRONIC_CONF_DIR/policy.json
+if is_suse; then
+    IRONIC_WSGI_DIR=${IRONIC_WSGI_DIR:-/srv/www/htdocs/ironic}
+else
+    IRONIC_WSGI_DIR=${IRONIC_WSGI_DIR:-/var/www/ironic}
+fi
+IRONIC_USE_MOD_WSGI=$(trueorfalse False IRONIC_USE_MOD_WSGI)
 
 # Deploy callback timeout can be changed from its default (1800), if required.
 IRONIC_CALLBACK_TIMEOUT=${IRONIC_CALLBACK_TIMEOUT:-}
@@ -667,7 +673,7 @@ function install_ironic {
 
     setup_develop $IRONIC_DIR
 
-    if [[ "$IRONIC_IPXE_ENABLED" == "True" ]] ; then
+    if [[ "$IRONIC_USE_MOD_WSGI" == "True" || "$IRONIC_IPXE_ENABLED" == "True" ]]; then
         install_apache_wsgi
     fi
 
@@ -724,21 +730,43 @@ function install_ironicclient {
 # _cleanup_ironic_apache_wsgi() - Remove wsgi files, disable and remove apache vhost file
 function _cleanup_ironic_apache_wsgi {
     sudo rm -rf $IRONIC_HTTP_DIR
-    disable_apache_site ironic
+    sudo rm -rf $IRONIC_WSGI_DIR
-    sudo rm -f $(apache_site_config_for ironic)
+    disable_apache_site ironic-api
+    disable_apache_site ipxe-ironic
+    sudo rm -f $(apache_site_config_for ironic-api)
+    sudo rm -f $(apache_site_config_for ipxe-ironic)
     restart_apache_server
 }
 
 # _config_ironic_apache_wsgi() - Set WSGI config files of Ironic
 function _config_ironic_apache_wsgi {
     local ironic_apache_conf
-    ironic_apache_conf=$(apache_site_config_for ironic)
+    local ipxe_apache_conf
-    sudo cp $IRONIC_DEVSTACK_FILES_DIR/apache-ironic.template $ironic_apache_conf
+    if [[ "$IRONIC_USE_MOD_WSGI" == "True" ]]; then
-    sudo sed -e "
+        sudo mkdir -p $IRONIC_WSGI_DIR
-        s|%PUBLICPORT%|$IRONIC_HTTP_PORT|g;
+        sudo cp $IRONIC_DIR/ironic/api/app.wsgi $IRONIC_WSGI_DIR/app.wsgi
-        s|%HTTPROOT%|$IRONIC_HTTP_DIR|g;
+        ironic_apache_conf=$(apache_site_config_for ironic-api)
-    " -i $ironic_apache_conf
+        sudo cp $IRONIC_DEVSTACK_FILES_DIR/apache-ironic-api.template $ironic_apache_conf
-    enable_apache_site ironic
+        sudo sed -e "
+            s|%IRONIC_SERVICE_PORT%|$IRONIC_SERVICE_PORT|g;
+            s|%IRONIC_WSGI_DIR%|$IRONIC_WSGI_DIR|g;
+            s|%USER%|$STACK_USER|g;
+            s|%APIWORKERS%|$API_WORKERS|g;
+            s|%APACHE_NAME%|$APACHE_NAME|g;
+        " -i $ironic_apache_conf
+        enable_apache_site ironic-api
+        tail_log ir-access /var/log/$APACHE_NAME/ironic-api-access.log
+        tail_log ir-api /var/log/$APACHE_NAME/ironic-api.log
+    fi
+    if [[ "$IRONIC_IPXE_ENABLED" == "True" ]]; then
+        ipxe_apache_conf=$(apache_site_config_for ipxe-ironic)
+        sudo cp $IRONIC_DEVSTACK_FILES_DIR/apache-ipxe-ironic.template $ipxe_apache_conf
+        sudo sed -e "
+            s|%PUBLICPORT%|$IRONIC_HTTP_PORT|g;
+            s|%HTTPROOT%|$IRONIC_HTTP_DIR|g;
+        " -i $ipxe_apache_conf
+        enable_apache_site ipxe-ironic
+    fi
 }
 
 # cleanup_ironic_config_files() - Remove residual cache/config/log files,
@@ -753,9 +781,7 @@ function cleanup_ironic {
     cleanup_ironic_config_files
 
     # Cleanup the WSGI files
-    if [[ "$IRONIC_IPXE_ENABLED" == "True" ]] ; then
+    _cleanup_ironic_apache_wsgi
-        _cleanup_ironic_apache_wsgi
-    fi
 
     # Remove the hook to disable log rotate
     sudo rm -rf $IRONIC_LIBVIRT_HOOKS_PATH/qemu
@@ -768,7 +794,7 @@ function configure_ironic_dirs {
         $IRONIC_STATE_PATH $IRONIC_TFTPBOOT_DIR $IRONIC_TFTPBOOT_DIR/pxelinux.cfg
     sudo chown -R $STACK_USER:$LIBVIRT_GROUP $IRONIC_TFTPBOOT_DIR
 
-    if [[ "$IRONIC_IPXE_ENABLED" == "True" ]] ; then
+    if [[ "$IRONIC_IPXE_ENABLED" == "True" ]]; then
         sudo install -d -o $STACK_USER -g $LIBVIRT_GROUP $IRONIC_HTTP_DIR
     fi
 
@@ -913,7 +939,8 @@ function configure_ironic {
         setup_colorized_logging $IRONIC_CONF_FILE DEFAULT tenant user
     fi
 
-    if [[ "$IRONIC_IPXE_ENABLED" == "True" ]]; then
+    # Adds WSGI for Ironic API
+    if [[ "$IRONIC_USE_MOD_WSGI" == "True" || "$IRONIC_IPXE_ENABLED" == "True" ]]; then
         _config_ironic_apache_wsgi
     fi
 
@@ -1180,7 +1207,11 @@ function start_ironic {
 # start_ironic_api() - Used by start_ironic().
 # Starts Ironic API server.
 function start_ironic_api {
-    run_process ir-api "$IRONIC_BIN_DIR/ironic-api --config-file=$IRONIC_CONF_FILE"
+    if [[ "$IRONIC_USE_MOD_WSGI" == "True" ]]; then
+        restart_apache_server
+    else
+        run_process ir-api "$IRONIC_BIN_DIR/ironic-api --config-file=$IRONIC_CONF_FILE"
+    fi
     echo "Waiting for ir-api ($IRONIC_HOSTPORT) to start..."
     if ! timeout $SERVICE_TIMEOUT sh -c "while ! wget --no-proxy -q -O- $IRONIC_SERVICE_PROTOCOL://$IRONIC_HOSTPORT; do sleep 1; done"; then
         die $LINENO "ir-api did not start"
@@ -1202,7 +1233,11 @@ function start_virtualpdu {
 
 # stop_ironic() - Stop running processes
 function stop_ironic {
-    stop_process ir-api
+    if [[ "$IRONIC_USE_MOD_WSGI" == "True" ]]; then
+        disable_apache_site ironic-api
+    else
+        stop_process ir-api
+    fi
     stop_process ir-cond
 }
 

devstack/upgrade/upgrade.sh

@@ -81,10 +81,15 @@ stop_nova_compute || true
 wait_for_keystone
 start_nova_compute
 
-
 # Don't succeed unless the services come up
+logs_exist="ir-cond"
+
+if [[ "$IRONIC_USE_MOD_WSGI" != "True" ]]; then
+    logs_exist+=" ir-api"
+fi
+
 ensure_services_started ironic-api ironic-conductor
-ensure_logs_exist ir-cond ir-api
+ensure_logs_exist $logs_exist
 
 # We need these steps only in case of flat-network
 # NOTE(vsaienko) starting from Ocata when Neutron is restarted there is no guarantee that