Verifying deployment of the Developer Portal subsystem

Verify that deployment of the Developer Portal OVA file succeeded.

Before you begin

You must have completed Deploying the Developer Portal subsystem OVA file.

About this task

After you configure an ISO and deploy it with the Developer Portal subsystem OVA, as described in Deploying the Developer Portal subsystem OVA file, verify that the subsystem installed correctly and is functional.

Procedure

  1. Log in to the virtual machine by using an SSH tool to check the status of the installation:
    1. Enter the following command to connect to port using SSH:
      ssh ip_address -l apicadm
      You are logging in with the default ID of apicadm, which is the API Connect ID that has administrator privileges.
    2. Select Yes to continue connecting.
      Your host names are automatically added to your list of hosts.
    3. Run the apic status command to verify that the installation completed and the system is running correctly.
      The command output for a correctly running Developer Portal system is similar to the following lines:
      $ sudo apic status
      INFO[0000] Log level: info
      
      Cluster members:
      - testsrv1251.subnet1.example.com (1.2.3.4)
        Type: BOOTSTRAP_MASTER
        Install stage: DONE
        Upgrade stage: NONE
        Docker status:
          Systemd unit: running
        Kubernetes status:
          Systemd unit: running
          Kubelet version: testsrv1251 (4.4.0-137-generic) [Kubelet v1.10.6, Proxy v1.10.6]
        Etcd status: pod etcd-testsrv1251 in namespace kube-system has status Running
        Addons: calico, dns, helm, kube-proxy, metrics-server, nginx-ingress,
      Etcd cluster state:
      - etcd member name: testsrv1251.subnet1.example.com, member id: 10293853252850049269, cluster id: 17044377177359475136, leader id: 10293853252850049269, revision: 1485879, version: 3.1.17
      
      Pods Summary:
      NODE               NAMESPACE          NAME                                                          READY        STATUS         REASON
      testsrv1251        default            re702738954-apic-portal-db-f89vn                              2/2          Running
                         default            re702738954-apic-portal-nginx-6ffb8676d9-gtfc6                0/0          Pending
                         default            re702738954-apic-portal-nginx-6ffb8676d9-nqdzf                0/0          Pending
      testsrv1251        default            re702738954-apic-portal-nginx-6ffb8676d9-q85mt                1/1          Running
      testsrv1251        default            re702738954-apic-portal-www-p9bvx                             2/2          Running
      testsrv1251        kube-system        calico-node-xkpbk                                             2/2          Running
      testsrv1251        kube-system        coredns-87cb95869-p4qhf                                       1/1          Running
      testsrv1251        kube-system        coredns-87cb95869-z2n5z                                       1/1          Running
      testsrv1251        kube-system        etcd-testsrv1251                                              1/1          Running
      testsrv1251        kube-system        ingress-nginx-ingress-controller-dsnxw                        1/1          Running
      testsrv1251        kube-system        ingress-nginx-ingress-default-backend-6f58fb5f56-ldx7t        1/1          Running
      testsrv1251        kube-system        kube-apiserver-testsrv1251                                    1/1          Running
      testsrv1251        kube-system        kube-apiserver-proxy-testsrv1251                              1/1          Running
      testsrv1251        kube-system        kube-controller-manager-testsrv1251                           1/1          Running
      testsrv1251        kube-system        kube-proxy-4pp8v                                              1/1          Running
      testsrv1251        kube-system        kube-scheduler-testsrv1251                                    1/1          Running
      testsrv1251        kube-system        metrics-server-6fbfb84cdd-hkztz                               1/1          Running
      testsrv1251        kube-system        tiller-deploy-84f4c8bb78-v6k95                                1/1          Running
      
  2. Optional: Define multiple Developer Portal endpoints. See Defining multiple portal endpoints for a VMware environment.
  3. If you have now installed all subsystems, continue to Post-deployment steps.
    Note:
    When you create or register a Developer Portal service, the Portal subsystem checks that the Portal web endpoint is accessible. However sometimes, for example due to the complexity of public and private networks, the endpoint cannot be reached. The following example shows the errors that you might see in the portal-www pod, admin container logs, if the endpoint cannot be reached:
    An error occurred contacting the provided portal web endpoint: example.com
    The provided Portal web endpoint example.com returned HTTP status code 504
    In this instance, you can disable the Portal web endpoint check so that the Developer Portal service can be created successfully.
    To disable the endpoint check, complete the following update:
    On VMware
    In your apicup project, create a file called ptl-extra-values.yaml (or edit the file if one already exists), and add the following section:
    spec:
      template:
      - containers:
        - env:
          - name: PORTAL_SKIP_WEB_ENDPOINT_VALIDATION
            value: "true"
          name: admin
        name: www
    Run the following commands:
    apicup subsys set <ptl_subsys> extra-values-file <path-to-ptl-extra-values-yaml-file>
    apicup subsys install <ptl_subsys>