1 # Acumos Model DCAE Component
3 This package is a service that converts Acumos models into ONAP DCAE components.
5 This operates in 2 modes:
7 - In command line mode, the catalogs and Acumos instance providing the models
8 to be converted are identified in the configuration file, and the service
9 exits once they have been processed.
10 - In web UI mode, a TCP/IP port to listen on is identified in the
11 configuration file, this port provides access to a web UI for identifying
12 the models to be converted, and the service continues to handle requests
13 after processing models.
18 open htmlcov/index.html
20 # Runtime Pre-Requisites
22 - An ACUMOS instance from which to pull models.
23 - A PEM format file containing the unencrypted private key, certificate, and
24 any necessary intermediate certificate(s) used to identify this tool to
25 the above ACUMOS instance.
26 - Any required DNS/Firewall setup such that this tool will be able to connect
27 to the Federation Gateway of the ACUMOS instance.
28 - The tool must be able to access the Docker daemon
29 - The Docker daemon must have connectivity to the Docker registry used by ONAP.
30 - The credentials the Docker daemon will use to write the Docker registry must
32 - The tool must be able to access the DCAE onboarding service API
33 - The credentials the tool will use to invoke the DCAE onboarding service must
35 - The tool must be able to access web sites containing the DCAE data format and
36 component JSON schemas.
37 - "pip install nodeenv", "nodeenv -p", "npm install --global protobuf-jsonschema",
38 and "pip install aoconversion", or equivalent must be run.
39 - The DCAE user who will "own" the loaded data formats and components must be
41 - If the certificate chain of the ACUMOS instance's server certificate does not
42 lead to a well known certificate authority, then a PEM format file containing
43 the appropriate CA certificate must be available.
44 - A configuration file, in YAML format, containing the following keys must be
47 dcaeuser - The DCAE user who will "own" the loaded data.
48 onboardingurl - The URL for accessing the onboarding service.
49 onboardinguser - The user ID for accessing the onboarding service.
50 onboardingpass - The password for accessing the onboarding service.
51 port - (required in web UI mode, not allowed in command-line mode) The TCP/IP
52 port to listen on in web UI mode.
53 acumosurl - (required in command-line mode) The URL for the Federation
54 Gateway of the ACUMOS instance.
55 certfile - The file path for the PEM file containing the private key, etc.
56 dockerhost - (optional) The URL for the docker host. By default,
58 dockerregistry - The host:port for the ONAP docker registry.
59 dockeruser - The user ID for uploading images to the docker registry.
60 dockerpass - The password for uploading images to the docker registry.
61 certverify - (optional) The PEM file containing the CA certificate. By
62 default, a standard set of certificate authorities are recognized.
63 tmpdir - (optional) A directory in which to work. By default,
64 temporary files are put in /var/tmp/aoadapter.
65 interval - (optional) The number of seconds between scans of the ACUMOS
66 instance. By default, 900 seconds (15 minutes).
67 catalogs - (optional) a list of catalog IDs or catalog names to load. By
68 default, all catalogs are loaded.
70 Note: The values of onboardingpass and dockerpass can either be the literal
71 passwords to be used or, if they begin with "@" they can specify the paths
72 to files containing the passwords.
76 Assuming the name of the above configuration file is "config.yaml,"
78 acumos-adapter config.yaml