Magic Software Americas
ERP Integration

How to Install Magic xpi 4.14 Yourself: A Step-by-Step IMM Deployment Guide

Swanagan Ray

Swanagan Ray

Moving to Magic xpi 4.14 means more than running a new installer. Version 4.14 replaces GigaSpaces with Magic's own In-Memory Middleware (IMM), which runs on Kubernetes. For many xpi administrators, that is the first Kubernetes cluster they have had to stand up.

The good news: you can install and deploy Magic xpi 4.14 yourself. This post shows how the pieces fit together and what the installation involves. When you're ready to start, the Magic xpi 4.14 Deployment Guide, free with a quick registration, has every command, file path, and setting.

Windows side

xpi server + agent

setup.exe on every application server.

Linux side

IMM on Kubernetes

MicroK8s, deployed with deploy-imm.bat.

Step-by-step

Full guide + PDF

Free with registration.

How a Magic xpi 4.14 deployment fits together

A Magic xpi 4.14 environment has two halves. Windows application servers run the xpi server and an IMM-Agent that starts, stops, and checks on it. A Linux host running Kubernetes runs the IMM itself, including the controller, its data stores, and the xpi Monitor, which now lives inside the IMM instead of being a separate install.

Magic xpi 4.14 architecture

Magic xpi 4.14 deployment architectureOne or more Windows application servers run the Magic xpi 4.14 server and the IMM-Agent, and read and write a shared projects folder. The IMM-Agent connects over ports 80 and 443 to the IMM-Controller on a Linux host running Kubernetes. Inside the cluster, the IMM-Tunnel receives external HTTP and TCP requests, the xpi Monitor is reached over HTTPS, and the controller stores data in IMM-DB on port 6739 and logs in LOGDB on port 27017.HTTP · TCP REQUESTSBROWSER · HTTPSWINDOWS APP SERVERS (ONE OR MORE)LINUX HOST · KUBERNETES (IMM):80 / :443READ / WRITEMagic xpi 4.14 serverprojects · engines · licenseIMM-Agentimm-agent.exe · start/stop · healthShared projects folder\\server\projects · ApplicationsList.xmlIMM-Tunnel/immtunnelxpi Monitor/magicmonitorIMM-Controlleraccepts engine start and stop requestsSTOREIMM-DBruntime data · :6739STORELOGDBactivity logs · :27017
Each Windows server runs an IMM-Agent that talks to the IMM-Controller on the Kubernetes host. Projects live on a shared folder every server can reach.

How to install Magic xpi 4.14: the six steps

The installation breaks into six steps. The Windows work and the Linux host preparation don't depend on each other, so two people can work on them at the same time.

Installation roadmap

Six steps to install Magic xpi 4.14Six steps in sequence: check prerequisites, run setup.exe on each Windows server, configure the service user and license, prepare a Linux host with Kubernetes, deploy the IMM with deploy-imm.bat, and start the IMM-Agent and deploy projects. Steps one to three and step four can run in parallel. The chain ends with verification: all pods running, the Monitor loading, and projects starting.STEPS 01–03 AND 04 CAN RUN IN PARALLELTHEN VERIFY01 · WINDOWSCheckprerequisitesrights · clock sync02 · WINDOWSRun setup.exeon each serverevery app server03 · WINDOWSService user& licenseMagic.ini · ifs.ini04 · LINUXLinux host +KubernetesMicroK8s · metallb05 · ADMIN HOSTDeploythe IMMdeploy-imm.bat06 · WINDOWSStart agent,deploy projectsimm-agent.exeOUTCOMEA working Magic xpi 4.14 environmentall pods Running · Monitor loads over HTTPS · projects start from the Monitor
Six steps from bare servers to a running environment. The IMM has to be deployed before the agent can connect and projects can start.

Connecting to the IMM cluster

For many xpi administrators, the unfamiliar part is Kubernetes. Before the IMM can be deployed, your Windows admin host needs access to the cluster. After that, a single script that ships with xpi does the deployment.

Connecting to the IMM cluster

Connecting a Windows admin host to the IMM Kubernetes clusterFrom the Windows admin host with kubectl and Helm installed, open an SSH session to the Linux host and run microk8s config to export the cluster config. Copy that file to the .kube folder in your Windows user profile. Then run kubectl cluster-info to test the connection, run deploy-imm.bat so Helm installs the IMM on the cluster, and run kubectl get pods in the magic-xpi-imm-ns namespace to confirm every pod is running.1 · SSH: MICROK8S CONFIG > CONFIG2 · COPY TO %USERPROFILE%\.KUBEHELM CHART → CLUSTERRUNS THE IMM INSTALLERWindows admin hostkubectl · helm · PuTTY (via choco)KUBERNETES CLUSTERLinux hostMicroK8s · dns · metallb3 · TESTkubectl cluster-infoconfirms the connection4 · DEPLOYdeploy-imm.bathelm installs the IMM5 · VERIFYkubectl get pods-n magic-xpi-imm-ns
kubectl on Windows reads the cluster config you copy from the Linux host. Once kubectl cluster-info succeeds, deploy-imm.bat uses Helm to install the IMM.

Magic xpi 4.14 installation FAQ

Can I install Magic xpi 4.14 myself?

Yes. Magic xpi 4.14 ships with a setup wizard for the Windows servers and batch scripts that install the In-Memory Middleware (IMM) on Kubernetes. If your team is comfortable with Windows services, a Linux host, and basic kubectl commands, you can follow the Magic xpi 4.14 Deployment Guide end to end.

Does Magic xpi 4.14 require Kubernetes?

Yes. The IMM runs as a Kubernetes cluster on a Linux host. That host can be an on-premises Linux server, a cloud VM, or, for development, Ubuntu running under WSL on Windows with MicroK8s.

Can I run the IMM on Windows?

For development, yes: install Ubuntu 22.04 under WSL and run MicroK8s inside it. For production, use a dedicated Linux machine on premises or in the cloud.

Which firewall ports does Magic xpi 4.14 need?

Open 27017 for LOGDB, 6739 for IMM-DB, 80 and 443 for the IMM-Controller, and 6443 for web services. The list is not exhaustive, so allow any other ports your environment needs.

What is the default Magic xpi Monitor login?

Installation creates an Operator user with the username administrator and the initial password changeit. Change it after first login, or configure Azure SSO for the Monitor.

Why is my Magic xpi project stuck in WAITING_FOR_AGENT?

The most common causes are using localhost as the host name in the project's start.xml, which is not supported, or the IMM-Agent not running on the host. Use the real host name and start imm-agent.exe before running projects.

How do I change the IMM domain name after installation?

The domain name is stored in about ten files across the installation, plus the hosts file. Run the imm-updator utility in InMemoryMiddleware\imm-updator to update them automatically.

Get the full Magic xpi 4.14 Deployment Guide

The Magic xpi 4.14 Deployment Guide walks through every step: prerequisites, license setup, the Linux host, deploying the IMM, firewall ports, project deployment, Monitor users and Azure SSO, and licensing. It's free with a quick registration and includes the downloadable PDF.

Still on 4.13 or earlier? Read why to upgrade before your GigaSpaces license expires.

Stuck on a step? We can help.

Whether you want a second pair of eyes on one step or would rather hand off the whole deployment, a Magic Americas xpi specialist can help.

Ask an xpi specialist.

Swanagan Ray

About the Author

Swanagan Ray

Director of Marketing, Magic Software USA

Back to Blog