Uploaded image for project: 'Fuse/AMQ Documentation'
  1. Fuse/AMQ Documentation
  2. FUSEDOC-1136

Document support for system specific init scripts

XMLWordPrintable

    • Icon: Enhancement Enhancement
    • Resolution: Done
    • Icon: Major Major
    • 6.3
    • None
    • Karaf
    • Sprint 2016-W, Sprint 2017-01

      Fuse 6.3 will deprecate tanuki based wrapper and will ship a number of templates to start fuse instances via os specific init scripts. The templates will be available in bin/contrib.

      UNIX

      On unix there will be an utility, karaf-service.sh, to help customizing the templates:

          USAGE: ./karaf-service.sh
              -k KARAF_SERVICE_PATH       # Karaf installation path
              -d KARAF_SERVICE_DATA       # Karaf data path (default to ${KARAF_SERVICE_PATH}/data)
              -c KARAF_SERVICE_CONF       # Karaf configuration file (default to ${KARAF_SERVICE_PATH/etc/${KARAF_SERVICE_NAME}.conf
              -t KARAF_SERVICE_ETC        # Karaf etc path (default to ${KARAF_SERVICE_PATH/etc}
              -p KARAF_SERVICE_PIDFILE    # Karaf pid path (default to ${KARAF_SERVICE_DATA}/${KARAF_SERVICE_NAME}.pid)
              -n KARAF_SERVICE_NAME       # Karaf service name (default karaf)
              -e KARAF_ENV                # Karaf environment variable (can be repeated)
              -u KARAF_SERVICE_USER       # Karaf user
              -g KARAF_SERVICE_GROUP      # Karaf group (default ${KARAF_SERVICE_USER)
              -l KARAF_SERVICE_LOG        # Karaf console log (default to ${KARAF_SERVICE_DATA}/log/${KARAF_SERVICE_NAME}-console.log)
              -f KARAF_SERVICE_TEMPLATE   # Template file to use
              -x KARAF_SERVICE_EXECUTABLE # Karaf executable name (defaul karaf, should support daemon and stop commands)
              -h                          # this usage message
      
      

      The utility will automatically detect the operating system and will generates some almost ready to use init scripts. A user may still need to customize the scripts to adapt them to its environment i.e. setting JAVA_HOME or some other environment variables.

      The generated scripts are composed by two files :

      • the init script
      • the init configuration file

      There are two exceptions:

      • systemd where you have an additional init script which is used as systemd template to start karaf instances
      • solaris where the sfm file do not have a configuration file but needs to be amended to work

      System scripts the need to be placed in the right directory and activated using the related system tool (systemctl, chkconf, etc) or imported using svccfg on solaris

      Windows

      On windows the service is started using winsw and the xml file provided as template as well as the executable name should be amended to match customer requirements.

        There are no Sub-Tasks for this issue.

            anmahaja Anshu Mahajan (Inactive)
            lburgazz@redhat.com Luca Burgazzoli
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved:

                Estimated:
                Original Estimate - 3 days
                3d
                Remaining:
                Remaining Estimate - 3 days
                3d
                Logged:
                Time Spent - Not Specified
                Not Specified