Skip to main contentIBM Cloud Pak Playbook

Aspera

Introduction

This page contains guidance on how to configure the Aspera release for both on-prem and IBM Cloud.

    Prepare Installation

    1. Change project to aspera

      oc project aspera
    2. Use Node Labels:

      In order to ensure high availability, the Aspera Swarm services will attempt to create a configurable number of pods on each node in the Kubernetes cluster. The nodes on which the receiver pods are running can be restricted via the nodeLabels values.

      For example, the following would restrict pods to nodes with the node-role.kubernetes.io/ascp=true label or node-role.kubernetes.io/noded=true label.

      ascpSwarm:
      config:
      nodeLabels:
      node-role.kubernetes.io/ascp: "true"
      nodedSwarm:
      config:
      nodeLabels:
      node-role.kubernetes.io/noded: "true"

      Label Nodes using the command

      oc label node <node-name> node-role.kubernetes.io/<role>=true
    3. Additional RBAC Requirements:

      The following RBAC resources are also required before you deploy the chart. Use the command oc create -f <filename.yaml>

    4. Create the secrets

      Make sure you have copied your aspera license key to the location where you will be creating the secrets. The following command assumes it is named aspera-license.

      oc create secret generic aspera-server --from -file=ASPERA_LICENSE="./aspera-license" --from-literal=TOKEN_ENCRYPTION_KEY="my_encryption_key"
      kubectl create secret generic asperanode-nodeadmin --from-literal=NODE_USER="myuser" --from-literal=NODE_PASS="mypassword"
      kubectl create secret generic asperanode-accesskey --from-literal=ACCESS_KEY_ID="my_access_key" --from-literal=ACCESS_KEY_SECRET="my_access_key_secret"

      Begin Installation

      1. Go to CP4I Platform Home. Click Create instance inside the Aspera tile.
      2. A window will pop up with a description of the requirements for installing. Click Continue to the helm chart deployment configuration.
      3. Click Overview to view the chart information and pre-reqs that were covered in Prepare Installation.
      4. Click Configure
      5. Enter the Helm release name. In our example, Aspera-1
      6. Enter Target Namespace - Aspera
      7. Select a Cluster - local-cluster.
      8. Tick the license agreement checkbox.
      9. Under Parameters -> Quick start
        1. Ingress - icp-proxy address defined during icp / common-services installation - icp-proxy.\<openshift-router-domain>
        2. Aspera Node - Server Secret - the secret created using the license - aspera-server
        3. Aspera Event Journal - Kafka Host - use hostname of bootstrap server of existing eventstreams installation. Get this value from the Eventstreams web ui.
        4. Aspera Rproxy - address of cluster proxy. This can be configured later if need be.
      10. Click All Parameters
      11. Uncheck production usage
      12. Image Pull Secret - the secret used to pull images for install from the docker registry. Set to ibm-entitlement-key if using entitled registry or if offline use the deployer-dockercfg-XX secret in your namespace.
      13. Scroll down to the Redis section.
      14. Check Persistence Enabled.
      15. Check Use dynamic provisioning.
      16. Storage Class Name - enter storage class for file storage
      17. Image Pull Secret - same as step 11.
      18. Scroll down to Persistence
      19. Enter the same Storage Class Name as step 15
      20. Proceed to the section Aspera Node
      21. Node Admin Secret - enter the nodeadmin secret created in the preious section - asperanode-nodeadmin
      22. Access Key Secret - enter the access key secret created in the previous section - asperanode-accesskey
      23. Proceed to the section - Aspera Event Journal
      24. Kafka Port - change to Kafka port found in Eventstreams bootstrapi server.
      25. Proceed to section Ascp Swarm
      26. Node Labels - enter the node labels created in the previous section for identifying ascp swarm nodes -
        {-node-role.kubernetes.io/ascp: true}
      27. Proceed to section - Noded Swarm
      28. Node Labels - set to the node label created for noded from the previous section
        {-node-role.kubernetes.io/noded: "true"}
      29. Scroll to section - Sch
      30. Image Pull Secret - the secret used to pull images for install from the docker registry. Set to ibm-entitlement-key if using entitled registry or if offline use the deployer-dockercfg-XX secret in your namespace.

        Validate installation

        1. View all pods running
          NAME READY STATUS RESTARTS AGE
          aspera-1-aspera-hsts-aej-d8c5b5569-24vh8 1/1 Running 0 3m
          aspera-1-aspera-hsts-aej-d8c5b5569-68nvj 1/1 Running 0 3m
          aspera-1-aspera-hsts-aej-d8c5b5569-v5xgb 1/1 Running 0 3m
          aspera-1-aspera-hsts-ascp-loadbalancer-75849464b-lq8lz 1/1 Running 0 3m
          aspera-1-aspera-hsts-ascp-swarm-54c98cb6bb-hznw5 2/2 Running 0 3m
          aspera-1-aspera-hsts-create-access-key-v1-24hdg 0/1 Completed 0 3m
          aspera-1-aspera-hsts-http-proxy-8b86df4f-8hd6d 1/1 Running 0 3m
          aspera-1-aspera-hsts-node-api-796f5c8ccc-r9xs2 2/2 Running 0 3m