As I mentioned in the first installation blog post, API Connect 2018.1 is revolutionary for a wide variety of reasons.   But when push comes to shove, it is still software, and it needs to be quickly and painlessly installed in your environment.  The API Connect team wants you to spend as little time as possible installing, and as much time as possible using API Connect 2018.1.


The VMware OVA deployment method is one that our current users are most familiar with — this was how API Connect v5 was primarily installed.  For API Connect 2018.1, we understand that not everyone is ready to dive into the ins and outs of containers, Docker, and Kubernetes.  The VMware installation process is a great option in this case, because we provide the new, exciting capabilities of API Connect 2018.1 with a familiar installation process.




But first, here’s a little bit of background.  Our movement from a monolithic architecture to a microservice architecture changes things.  Under the covers of each VMware OVA file are many different microservices that are working hard to ensure that API Connect is working properly.  Each one of those microservices uses certificates to securely communicate with each other.  Each microservice has certificates and configurations for deployment that can become quite difficult to manage as you scale.  Deployment depends on the user’s environment, so we cannot create a “one size fits all” solution to install the components of API Connect 2018.1 for VMware.


InstallAssist and Other Requirements

Luckily, the API Connect team provides the “pack mule” that is InstallAssist.  As a user, you load up InstallAssist with necessary information based on your environment, and sit back as the “pack mule” does all the heavy lifting for you.  InstallAssist is a binary that automatically manages certificate creation and configuration for deployment, so very little work has to be done on your end in managing certificate creation and system configuration.  InstallAssist is available as a free Mac, Windows, and Linux download.  Both InstallAssist and the VMware OVA files are provided by IBM.  You, the user, just needs to provide the VMware environment and have the following information readily available before starting installation:

  1. IP address of the server
  2. Host names
  3. Domain of the server
  4. IP addresses of the domain name servers
  5. IP address of the gateway server
  6. Subnet Mask
  7. Name of ethernet interface



How to Install the API Manager Component

So what do you need to do to deploy an API Manager component of APIC 2018.1 for VMware?  The high-level process is straightforward:

  1. Download VMware OVA images and InstallAssist
  2. Input characteristics of your environment into the InstallAssist yaml file (1-7 above)
  3. Run InstallAssist (and take a look at everything you don’t have to do!)
  4. Upload the ISO file generated by InstallAssist into your Virtual Machine environment
  5. Start using API Connect

The process for deploying Analytics and Developer Portal VMware OVAs follows a very similar process.  For more information on installing DataPower in your environment, please visit our DataPower Knowledge Center here.

The API Connect team has created a video to help walk you through the VMware installation process.  Please visit our API Connect Knowledge Center for a detailed walk through of individual steps for VMware installation.  Please also visit the Software Product Compatibility Report page for detailed System Requirements of API Connect 2018.1.

16 comments on"Installing API Connect 2018.1 for VMware"

  1. I am installing APIC on windows 8.1, where I completed all the steps as given in knowledge center. When I am running “apicup subsys install apic –out apicplan-out” I am getting “Error: error converting YAML to JSON: yaml: invalid leading UTF-8 octet”.

  2. Hi John, thanks for sharing.
    Why there are different options for OS? (linux, mac, windows)
    Doesn’t the provided OVA has an OS already defined? I am getting some error generating the ISO and I guess it could be related to my understanding of the OS.

  3. Thanks John.

    This is what I was looking for. I have noticed that 2018.2.2 is available. Can I install that version without 2018.1? I am assuming that the installing process remains unchanged.

    • Thanks for your comment Colin. Yes, you can install that version the same way that you install 2018.1. If we have any major changes to the install process we will call that out in the future.

      • syed zaheer shaffi July 27, 2018

        hy dear i am installation the API connect for windows but i am unable to create the ovf file its giving me an error can you please share the .yaml configuration file sample so we will compare our configuration file with it.

  4. The OS options are for the installAssit tool that generates the configuration required for the install and does not relate to OVA OS.

  5. Thanks for posting the video. I followed the install instruction provided in knowledge center also refered the video. But I could not make much progress as I’m facing the following issue.

    $apicup subsys install mgmt –out mgmtplan-out
    Loaded user provided certificates
    Loaded previously generated certificates
    Error: error converting YAML to JSON: yaml: line 12: could not find expected ‘:’

    P.S I never edited the YAML file manualy, Also validated the YAML

  6. Thanks John. I’ve a few questions for you.

    1.) Is it mandatory to use InstallAssist to install & configure the new OVA files? or can we still leverage the old commands to set it up ?
    2.) Since Knowledge center link only mentions about using ESX 6.x hypervisor and vSphere client to import the ISO file, so will it not work with other VMware products such as Vmware workstation ?
    3.) Is there any documentation for existing customers to migrate to the new version of API Connect ? Or do they first need to install the new Vmware OVA files, migrate all existing APIs, products configuration files on new version and shut down the old VM’s post validating the api’s on new VM’s ?

  7. learninglord April 27, 2018

    while creating iso file I get the below error

    at executing this command apicup subsys install port –out portplan-out

    Error: error converting YAML to JSON: yaml: line 12: could not find expected ‘:’

  8. Good afternoon. Please help me. Can I deploy the APIC 2018.1 on my ESXi 6.7 hypervizor. Does the APIC 2018.1 compatible and supports the ESXi 6.7? Thank you.

  9. RajSolanki May 22, 2018

    Can I upgrade from 5.x to 2018.X ?

    • Hi Raj. Yes, you can migrate from APIC v5 to API Connect 2018.x. Please be on the lookout for more information on our migration story in the coming weeks.

  10. […] v2018.1 Knowledge Center – Installing your IBM API Connect Cloud DeveloperWorks – Installing API Connect 2018.1 for VMware and Installing API Connect 2018.1 for […]

  11. RICHARD JACOBS July 26, 2018

    Encountering the following when issuing the /apicup subsys install mgmt –out mgmtplan-out
    panic: reflect: Method on nil interface value [recovered]
    panic: reflect: Method on nil interface value

    goroutine 1 [running]:
    /usr/local/go/src/text/template/exec.go:146 +0x62

Join The Discussion

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