Portworx Documentation has moved to https://docs.portworx.com

For Portworx Backup version 2.5 and later, refer to the documentation at https://docs.portworx.com/portworx-backup-on-prem/.

---

If the standard PX-Backup UI endpoint configuration doesn’t meet your requirements, you can configure access using HTTPS, access it through the load balancer, or even navigate to one of your node IPs directly.

Configure access to the PX-Backup UI on Kubernetes

This section shows you how you can configure access to the PX-Backup UI on Kubernetes.

Expose the PX-Backup UI on ingress and configure access using HTTPS

You can configure access to PX-Backup through HTTPS by creating an ingress rule.

1. Modify and paste the following spec into your one of your PX-Backup nodes, entering your own values for the following:

   • spec.rules.host: specify the name of the host on which you’ve installed PX-Backup
   • spec.tls.hosts specify the name of the host on which you’ve installed PX-Backup

   • spec.tls.hosts.secretName: specify the name of the secret that holds your Kubernetes TLS certificates

     cat <<< '
     apiVersion: networking.k8s.io/v1
     kind: Ingress
     metadata:
       annotations:
         ingress.bluemix.net/redirect-to-https: "True"
         kubernetes.io/ingress.class: nginx
         nginx.ingress.kubernetes.io/x-forwarded-port: "443"
       name: px-backup-ui-ingress
       namespace: px-backup
     spec:
       rules:
       - host: <px-backup-host>
         http:
           paths:
           - backend:
               service:
                 name: px-backup-ui
                 port:
                   number: 80
             path: /
             pathType: Prefix
           - backend:
               service:
                 name: pxcentral-keycloak-http
                 port:
                   number: 80
             path: /auth
             pathType: Prefix
       tls:
       - hosts:
         - <px-backup-host>
         secretName: <TLS-backup-secret>
     ' > /tmp/px-backup-ui-ingress.yaml

   NOTE: The secretName field is only required when you want to terminate TLS on the host/domain. Refer to your cloud provider for specific examples:

   • AKS
   • EKS
     

2. Apply the spec:

   assignment

   copy to clipboard

   kubectl apply -f /tmp/px-backup-ui-ingress.yaml

3. Retrieve the INGRESS_ENDPOINT using the kubectl get ingress command:

   assignment

   copy to clipboard

   kubectl get ingress px-backup-ui-ingress --namespace px-backup -o jsonpath="{.status.loadBalancer.ingress[0].hostname}"

Once you’ve retrieved the INGRESS_ENDPOINT, you can use it to access the PX-Backup UI with the HTTPS scheme. Use the default credentials (admin/admin) to log in:

https://INGRESS_ENDPOINT

Additionally, you can access the Keycloak UI at the /auth path:

https://INGRESS_ENDPOINT/auth

Access the PX-Backup UI using a node IP

You can access PX-Backup by directly navigating to one of your node’s IP addresses.

1. Find the public/external IP (NODE_IP) of any node in your current Kubernetes cluster.

2. Find the node port (NODE_PORT) of the px-backup-ui service.

Once you’ve found the node IP and port, you can combine them to access the PX-Backup UI:

http://NODE_IP:NODE_PORT

Additionally, you can access the Keycloak UI at the /auth path:

http://NODE_IP:NODE_PORT/auth

Access the PX-Backup UI using the load balancer endpoint

You can also the access PX-Backup UI by navigating to the load balancer using either its host name or IP address.

1. Get the loadbalancer endpoint (LB_ENDPOINT) using one of the following commands:

   • Host:

     assignment

     copy to clipboard

     kubectl get ingress --namespace {{ .Release.Namespace }} px-backup-ui -o jsonpath="{.status.loadBalancer.ingress[0].hostname}"`

   • IP:

     assignment

     copy to clipboard

     kubectl get ingress --namespace {{ .Release.Namespace }} px-backup-ui -o jsonpath="{.status.loadBalancer.ingress[0].ip}"`

Once you’ve retrieved the load balancer endpoint, you can use it to access the PX-Backup UI:

http://LB_ENDPOINT

You can access the Keycloak UI at the /auth path:

http://LB_ENDPOINT/auth

Configure access to the PX-Backup UI on OpenShift

This section shows how you can configure access to the PX-Backup UI on OpenShift.

Access the PX-Backup UI using a route

1. Open the web console, go to Networking > Routes, and then select the Create Route button.

2. On the Create Route page, configure your route by populating the following fields:

   • Name: enter a descriptive name
   • Hostname: specify a public hostname. If you leave this field empty, OpenShift will generate a hostname.
   • Path: leave this field unchanged.
   • Service: choose px-backup-ui from the drop-down list.
   • Target Port: choose 80 -> 8080

3. When you’ve finished configuring your route, select the Create button.

4. OpenShift now displays a link to the PX-Backup UI on the Routes page. To access PX-Backup, select that link.

---