You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

For information about the functionality provided by the Acumos adapter and about the adapter's architecture, see this overview.

Dependencies

The Acumos adapter relies on the following external components:

  • An Acumos instance that provides access to models through the Acumos E5 interface. (See this design documentation for a discussion of the E5 interface.)
  • A running instance of ONAP DCAE, with at least the minimal set of other ONAP components needed by DCAE. (See the DCAE Installation Guide for more details.)
  • A running instance of ONAP DCAE MOD, connected to the ONAP DCAE instance. (See the DCAE MOD User Guide for more information.)
  • A Docker registry where the adapter can store the Docker images that it creates.

Installation Prerequisites

Set up access to an Acumos instance

Before installing the Acumos adapter, identify an Acumos instance that exposes the E5 interface and arrange with the administrator to set up access.  Since E5 authenticates clients using a TLS certificate, you will need to obtain a certificate and register the subject information with the Acumos instance. 

After setting up access, you should have:

  • The URL for accessing the E5 endpoint
  • A TLS certificate private key
  • A TLS client certificate signed by a certificate authority acceptable to the Acumos instance
  • Any intermediate CA certs required to validate the client certificate

Set up access to a Docker registry

The Acumos adapter will create Docker images that it needs to push to a registry.  Typically registries allow pushing only to users who have authenticated with a user name and password.  Some registries also require authentication from clients attempting to pull images.  Before installing the Acumos adapter, you will need to identify (or deploy) a Docker registry and set up the necessary user name(s) and password(s). 

After setting up access, you should have:

  • The URL for the registry.
  • The user name and password for Docker image push operations.
  • The user name and password for Docker image pull operations, if the registry requires authentication for pull operations.

Set up access to an ONAP instance with DCAE and DCAE MOD

These instructions will deploy an instance of the Acumos adapter into the same Kubernetes cluster and namespace as the ONAP instance where DCAE and DCAE MOD are running.  Therefore you will need to be able to direct Kubernetes and Helm commands to the ONAP instance.   The simplest way to get this information is to get a "kubeconfig" file that contains the Kubernetes API address and credentials for the ONAP instance. 

After setting up access, you should have:

  • A "kubeconfig" file that you can use to access the ONAP instance where the adapter will be installed.

These instructions assume that you are familiar with Helm and Kubernetes commands and can install the kubectl and helm executables on whatever machine you will be using for driving the installation process.

Set up appropriate networking arrangements

The Acumos adapter, running inside the ONAP Kubernetes cluster, will need access to the Acumos instance and the Docker registry.   Depending on the exact network configurations, this may require setting up firewall rules at various points in the network(s) involved.   Similarly, the machine you are using to drive the installation will need access to the ONAP instance.

Installation Procedure

The Acumos adapter is installed using Helm, with a Helm chart that's stored in the ONAP dcagen2/platform repository, in the adapter/helm subdirectory. 

  1. Download the Acumos adapter Helm chart from (TBD).
  2. Populate the dependencies for the chart by entering the chart directory and executing
    helm dep up

  3. Create a YAML file containing information about the Docker registry and the Acumos instance that the adapter will use.  The table below shows the properties that must be in this file.

    Property NameDescription
    dockerUserUser name to be used by the adapter to push images to the Docker registry
    dockerPassPassword to be used by the adapter to push images to the Docker registry
    dockerTargetRegistryAddress of the Docker registry where the adapter will push images, in the format host_name:port
    acumosCertThe certificate information needed for the adapter to authenticate itself to the Acumos instance, in PEM format.  The information contains the following elements, in this order:
    • The unencrypted private key associated with the certificate
    • The client certificate
    • If the certificate has been signed by one or more intermediate certificate authorities, the intermediate certificate authority certificates

    Note that this property is a multi-line string in YAML.

    Here is an example of the file, with some sensitive information truncated or omitted.

    dockerUser: example-user
    dockerPass: example-pass
    dockerTargetRegistry: nexus.example.com:18448
    acumosCert: |
      -----BEGIN PRIVATE KEY-----
      MII...
     (remainder of private key)
      -----END PRIVATE KEY-----
      -----BEGIN CERTIFICATE-----
      MII...
      (remainder of client certificate)
      -----END CERTIFICATE-----
      -----BEGIN CERTIFICATE-----
      MII...
     (remainder of intermediate CA certificate)
     -----END CERTIFICATE-----

  4. Deploy the Acumos adapter using helm:
    helm install -n helm_release_name --namespace namespace_of_running_onap_instance -f /path/to/yaml_file /path/to/acumos_adapter_chart_directory
    For example:
      Helm release name: testadapt
      Namespace of running ONAP instance: onap        YAML file with docker & cert info: ~/acumos-adapter-demo/overrides.yaml
        Executing in the directory holding the Acumos adapter Helm chart
    helm install -n testadapt --namespace onap -f ~/acumos-adapter-demo/overrides.yaml  .

Verification







  • No labels