Useful Tips

Here are some useful tips to prevent some common user configuration issues.

  1. All the Host machines in the collective and the machines where you publish application using the APIC Toolkit must have the same architecture, OS, node version and npm versions.

      Examples of not to have

    • APIC Toolkit installed on a windows machine while your collectives are on Linux .
    • Controller installed on zLinux and APIC Toolkit on windows
    • Collective does not support windows. See:
      compatibility matrix
  2. Make sure the controllers, members can communicate to each other.
    When perform the setup , always use Fully qualified host name. In some environment
    with dynamic IP, IP will change, therefore IP is not reliable to use.
  3. In production, the goal is to avoid single point of failure.

    The collective members should be on a separate machine as your controller.
    You should have more than one members and each one should be on separate machine.
    If you want High Availability, (HA), you should have at least 3 controllers, each installed on a different machine. That is a liberty ND solution. Currently, we do not support HA.

  4. If you update the password of any memberHost machines, you need to
    perform updateHost so that the controller is aware of the changes.
  5. Utilize the Help commands
    • apic apps:publish –h
    • wlpn-controller help
    • wlpn-controller help setup
    • wlpn-collective help
    • wlpn-collective help registerHost
    • wlpn-collective help updateHost
  6. Logging

    Enable the tracing in server.xml in ~/.liberty/wlp/usr/servers/controller/

    <logging traceSpecification="*
    ***=all" />

  7. Ports information:
    • Default controller adminCenter https port: 9443
    • To locate the application port information,
      get the join.json in wlpn folder from the member Host machine
      [root@host ~]#wlpn-server list
      The following servers are defined relative to the user directory /root/wlpn

      [root@host ~]# cat wlpn/acme-bank-5844d8e1e4b056adb47d967d-1480907129282-1/join.json
      "hostName": "",
      "userDir": "/root/wlpn",
      "serverName": "acme-bank-5844d8e1e4b056adb47d967d-1480907129282-1",
      "keystorePassword": "{xor}a2sINTIQGTAGGBlvKBsobSZuJzU9PmYFEmcaYg==",
      "controllerList": [
      "clusterName": "apic.acme-bank-5844d8e1e4b056adb47d967d-1480907129282",
      "appPort": "9081",
      "adminPort": "9444"

    • Refrain from manually modify the ports
  8. When your collective is totally messed up and you want to start over
      To scrap controller from controller machine

    1. killall -9 java
    2. killall -9 node
    3. rm -R ~/.liberty
    4. npm uninstall -g apiconnect-collective-controller
      To scrap the members from machine

    1. killall -9 node
    2. rm -R ~/wlpn
    3. npm uninstall -g apiconnect-collective-member

Prior to contact support

Before contacting support, validate your configuration by using the wlpn-diagnostic tools

Install the diagnostic tools on the controller machine.
npm install –g wlpn-diagnostics
wlpn-diagnostics checkAll

Information to provide when contact support

  • Versions of the Products and and environment
    apic --ext-version
    wlpn –ext-version
    wlpn-controller version
    node –v
    npm –v
  • Where did you install the Toolkit and collective member code from? or From fix-central
  • Topology on your environment

    • OS/architecture of the controller, member , APIC toolkit machines
    • How many Remote members or local members?
    • How many controllers?
  • Reproducible Steps. How often is the failure? Has it ever worked before? When does the failure start to to occur?
  • Logs:

    • Controller machine server logs location:
    • apic log location:
    • controller server dump:

      .liberty/wlp/bin/server dump controller
      Dumping server controller.
      Server controller dump complete in /root/.liberty/wlp/usr/servers/controller/
    • configuration settings of your controller and server machines

      ulimit -a
    • wlpn-diagnostics information

Useful References:

removing application from collective
logging microgateways and apic

Join The Discussion

Your email address will not be published. Required fields are marked *