Install API Gateway using Command Central CLI & Azure Devops Remote Power Shell Option (on Azure VMs)

Knowledge base
, , , , , ,
1

Installation Steps

  1. Create two virtual machines in Azure – one for build Server and one is your target server where you wish the UM Server to be installed.
    1
    Build Server
    • Install Command Central and Platform Manager installed. Enable the Platform Manager & Command Central Ports in both Windows Firewall and Azure Network Security Group.
    • System Requirements for Command Central can be found in the Installing Software AG Products documentation.
    • Command Central & Platform Manager installer can be downloaded from Empower.
    • It can be installed on the build server using the below command
    <cceinstaller.exe> –-accept-license -d <installation folder> -c 8190 -C 8191 -s 8192 -S 8193 -p <password>
    2
    • Recommendation is to have one build server for Production environment and one for non-production environments.
    Target Server
    • Install Platform Manager on the Target Server.
    • Platform Manager can be installed via Command Central (Java8 is prerequisite) or can be directly installed on the VM using the software, which can be downloaded from empower.
    • Enable the Platform Manager & SSH Ports in both Windows Firewall and Azure Network Security Group.
    • Platform Manager installer can be downloaded from Empower.
    • It can be installed on the build server using the below command
    <cceinstaller.exe> –-accept-license -d <installation folder> -D SPM -s 8192 -S 8193 -p <password>

  2. Login to command central installed in the build server using the below URL
    https://<ccehostname>:<cceport>/cce/web.

  3. Navigate to Installations and select “+” to add the target node in Command Central.

  4. Provide the hostname of the target node and select” Platform Manager is already installed” if SPM is already installed or select “Install Platform Manager remotely” to install SPM.
    image 3

  5. Provide the Port number, username and password, alias, description and Installation type details.
    image 4

  6. Once the node is connected in Command Central, upload the desired API Gateway Server YAML template in templates section and also add the API Gateway Server license key under Licensing->Keys tab
    image
    image

  7. Upload or download the Product Image repository to Repositories->Products and fixes (if any) to Repositories->Fixes.
    6

  8. Once all the setup is complete in Command Central, proceed to configuring “Windows Remote Management (WinRm)” on the build server.

  9. Navigate to Azure Portal “portal.azure.com” and make sure the DNS name is set on the build server. If not set the DNS name.

  10. Then select PowerShell option in the Azure Portal.

  11. Enter the below command in PowerShell to enable Remote Connection to VM.
    Enable-AzVMPSRemoting -Name ‘<dns name of the vm>' -ResourceGroupName ‘resource group name’ -Protocol https -OsType Windows
    image
    Azure PowerShell configures the following
    • Based on the Operating System, it ensures WinRM (Windows) or SSH (Linux) is setup.
    • It ensures Network Security Group rules are in place to allow communication to the target, again based on communications type.
    • For Linux VMs, it installs PowerShell core on the target system.

  12. Since the protocol used is HTTPs, certificate can be created using the below command.
    New-SelfSignedCertificate -DnsName ‘<dns name of the vm>' -CertStoreLocation Cert:\LocalMachine\My
    image

  13. Next Register the WinRM listener using the below command.
    winrm create winrm/config/Listener?Address=*+Transport=HTTPS @{Hostname”<dns name of the vm>”;CertificateThumbprint="<Thumbprint from previous step"}
    image

  14. If the create listener step throws error with message, listener already exists, then listener can be deleted with the below command and then execute create step again.
    winrm delete winrm/config/Listener?Address=*+Transport=HTTPS

  15. Navigate to dev.azure.com home page and create your project.
    7

  16. Create a new pipeline, select the desired repository (Azure repo, git, bitbucket, svn etc.) and add an empty/agent job and select “Default” agent pool in the Agent Selection.
    image

  17. On the Agent job, select add and Add a “Remote Power shell on Target Machines” step. In the Remote Power shell script, select inline and provide the CCE script to install API Gateway. Script can even be saved in the repo and referred in this task.
    image
    Script Used here is given below
    <sagcc.bat absolute path> exec templates composite apply <API Gateway Server YAML Template Alias from CCE> nodes=<node alias> agw.memory.max=<max api gw memory> repo.product=<Product Image alias>

  18. Then execute the pipeline which will schedule the Command Central Job for API Gateway Installation and starts the API Gateway server and Internal Data Store. We can verify the installation in Command Central as shown below.
    image
    image

Notes:
This article provides on basic installation of API Gateway. Additional configuration as needed can be applied in the YAML template.

  • Also, additional fixes can be included in the above URL.
  • Sync Job can be added while installation to wait for the template execution and validate the installation.
  • Similar steps can be followed for other product installations as well. Sample YAML templates for different product installations can be found in the below git project.

Official library of Command Central default templates and Docker support

Remote Power Shell Script Invocation is one of the approaches for invoking Command central jobs from Azure pipelines. Additionally, the below approaches can be used for Azure pipeline Integration with Command Central.

1 Like