Verifying installation of the portal subsystem

Verify that the portal subsystem installation succeeded.

Before you begin

Complete Deploying the portal subsystem OVA.

Procedure

  1. Log in to the API Connect VM by using SSH, and check the status of the installation:

    If you are using a three replica deployment profile, then repeat this step for each VM in your portal subsystem deployment.

    1. Enter the following command to connect to your portal VM with SSH:
      ssh apicadm@<vm hostname>
      No password is required because you set your public key in step 10 on Preparing the portal subsystem for deployment. If necessary, include the path to your SSH identity files:
      ssh -i <path to identity file> apicadm@<vm hostname>
      For example:
      ssh -i ~/.ssh/id_rsa apicadm@<vm hostname>
    2. Select Yes to continue connecting.
      Your hostnames are automatically added to your list of hosts.
    3. Run the apic status command to verify that the installation completed and that the system is running correctly.
      The command output for a correctly running portal system is similar to the following:
      $ sudo apic status
      INFO[0000] Log level: info                              
      
      Cluster members:
      - apimsvc21.hursley.ibm.com (9.20.85.206)
        Version: 5.2.0
        Type: BOOTSTRAP_MASTER
        Install stage: DONE
        Upgrade stage: UPGRADE_DONE
        Spec Version: 10.0.8.0
        Reconciled Version: 10.0.8.0-258
        CR Status: Running
        CR Message: Serving 2 sites
        CR Condition Message: 4/4
        CR Condition Reason: DeploymentReady
        Subsystem type: portal
        Subsystem version: 10.0.8.0
        Subsystem detail: Waiting for installation before starting upgrade manager
        NTP Status: systemd-timesyncd.service[active] (NTP: Initial synchronization to time server 9.20.0.21:123 (ntp.hursley.ibm.com).)
        CPU/Memory: 716m/5163Mi  
        Reboot Required: false
        Containerd status:
          Systemd unit: running
        Kubernetes status: 
          Systemd unit: running
          Kubelet version: apimsvc21 (5.4.0-182-generic) [Kubelet v1.28.9, Proxy v1.28.9]
        Etcd status: pod etcd-apimsvc21 in namespace kube-system has status Running
        Addons: calico, cert-manager-v1, dns, kube-proxy, local-volume-provisioner, metrics-server, 
        Disk Space Available: 220G/245G | Used: 6%
        Inodes Available: 16M/16M | Used: 2%
        Containers: 22
          - Running: 22
          - Exited: 27
          - Unknown: 0
        Images: 31
      Etcd cluster state:
      - etcd member name: apimsvc21.hursley.ibm.com, member id: 7266119724263791117, cluster id: 7142398015885374281, leader id: 7266119724263791117, revision: 4603709, version: 3.5.9
      
      Pods Summary:
      NODE             NAMESPACE          NAME                                            READY        STATUS         REASON
      apimsvc21        certmanager        cert-manager-8694fb5f7d-77vtj                   1/1          Running        
      apimsvc21        certmanager        cert-manager-cainjector-5cdfc79679-hjqvk        1/1          Running        
      apimsvc21        certmanager        cert-manager-webhook-66f85f764f-ccczj           1/1          Running        
      apimsvc21        default            abc-portal-nginx-0                              1/1          Running        
      apimsvc21        default            abc-portal-site1-db-0                           2/2          Running        
      apimsvc21        default            abc-portal-site1-www-0                          2/2          Running        
      apimsvc21        default            ibm-apiconnect-c486c557d-rnwj2                  1/1          Running        
      apimsvc21        kube-system        calico-kube-controllers-7fbcfc6b49-vm58l        1/1          Running        
      apimsvc21        kube-system        calico-node-84pq7                               1/1          Running        
      apimsvc21        kube-system        coredns-b647d6884-4qwts                         1/1          Running        
      apimsvc21        kube-system        coredns-b647d6884-8rmj8                         1/1          Running        
      apimsvc21        kube-system        etcd-apimsvc21                                  1/1          Running        
      apimsvc21        kube-system        ingress-nginx-ingress-controller-dcxmq          1/1          Running        
      apimsvc21        kube-system        kube-apiserver-apimsvc21                        1/1          Running        
      apimsvc21        kube-system        kube-apiserver-proxy-apimsvc21                  1/1          Running        
      apimsvc21        kube-system        kube-controller-manager-apimsvc21               1/1          Running        
      apimsvc21        kube-system        kube-proxy-6sgtr                                1/1          Running        
      apimsvc21        kube-system        kube-scheduler-apimsvc21                        1/1          Running        
      apimsvc21        kube-system        local-volume-provisioner-h2dlv                  1/1          Running        
      apimsvc21        kube-system        metrics-server-967bc8b5c-zpnzf                  1/1          Running     
  2. Optional: Define multiple portal endpoints. See Defining multiple portal endpoints for a VMware environment.
  3. Configure backups for your portal subsystem: Backing up and restoring the portal subsystem.

What to do next

If all API Connect subsystems are now installed, continue to Post-deployment steps.