commit	200bb99e7e705789f4828902ac074e018bd80f37	[log] [tgz]
author	vv770d <vv770d@att.com>	Mon Sep 14 03:18:23 2020 +0000
committer	vv770d <vv770d@att.com>	Mon Sep 14 03:20:32 2020 +0000
tree	acb48287b7697152f9c2ba2f0897f4fe3ffa4d2d
parent	1dcf42f91aeb17d7168f820c7c250e7fa6bc8f32 [diff]

tree: acb48287b7697152f9c2ba2f0897f4fe3ffa4d2d

README.md

config_binding_service

============LICENSE_START======================================================= Copyright (c) 2017-2019 AT&T Intellectual Property. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ============LICENSE_END=========================================================

ECOMP is a trademark and service mark of AT&T Intellectual Property.

Changelog

All changes are logged in Changelog.md

Overview

DCAE has a "templating language" built into components' configurations, as explained further below. The orchestrator populates one/two keys (depending on the blueprint) into Consul that are used to bind component configurations config, a "rels key" and a "dmaap key". If component A wants to connect to a component of type B, then A's rels key holds what specific service component name of B that A should connect to over direct HTTP. Service component name here means the full name that the component of type B is registered under in Consul (there can be multiple components of type B registered in Consul). The CBS (config binding service) then pulls down that rels key, fetches the connection information about that B (IP:Port), and replaces it into A's config. There is also a "dmaap key", which is the same concept, except what gets injected is a JSON of DMaaP connection information instead of an IP:Port.

In addition, this service provides the capability to retrieve either the DTI events (not history) or the policies for a given service_component.

Usage

See the OpenAPI spec in config_binding_service/openapi.yaml. You can also see a "pretty" version of this by running the container and going to /ui.

Assumptions

CONSUL_HOST is set as an environmental variable where this binding service is run. If it is not, it defaults to the Rework Consul which is probably not what you want.
service_component_name is in consul as a key and holds the config
service_component_name:rel is in consul as a key if you are expecting a direct HTTP resolution, and holds the service component names of connections.
service_component_name:dmaap is in consul if you are expecting a DMaaP resolution, and holds the components DMaaP information.

Templating Language

The CBS tries to resolve a component's configuration with a templating language. We have two templating languages embedded in our component's configuration ({{...}} and <<...>>). There are two because the CBS has to be able to distinguish between a rels-key-resolve and a dmaap-key-resolve. That is, if component X is trying to bind their component, and they want to talk to Y, someone has to tell the CBS whether they are trying to talk via IP:port or a feed.

Specifically, if the CBS sees:

X's configuration:
{
    ...
    config_key : << F >> // will try to resolve via X:dmaap and look for F
    config_key : {{ F }} // will try to resolve via X:rels and look for F
}

Development

Version changes

Development changes require a version bump in several places. They are:

Changelod.md
version.properties
pom.xml
setup.py Additionally, if the development leads to an API change,
config_binding_service/openapi.yaml

Unit esting

You need tox; then just run:

tox

Deployment

HTTPS

The default non HTTPS port is 10000. The default HTTPS port is 10443.

To deploy with HTTPS, you must then set three ENVs:

USE_HTTPS=1 (any other value, HTTPS is not used)
HTTPS_KEY_PATH: path to the .key file (including the filename)
HTTPS_CERT_PATH: path to the .crt file (including the filename)

If USE_HTTPS is set, but the other two are not supplied or do not exist, the CBS will crash immediately.

For testing, I created a self signed cert with

openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout /tmp/k.key -out /tmp/c.crt -subj "/C=US/ST=NJ/L=foo/O=ONAP/OU=ONAP/CN=configbinding"

Docker

Without HTTPS

sudo docker run -dt -p 10000:10000 -e CONSUL_HOST=<YOUR_HOST>cbs:X.Y.Z

###With HTTPS Mount the key and crt into /opt/; in theory other paths should work if the ENV is set correctly, but this one has been tested and /opt is gauranteed to exist in the container because that's where the logs go.

docker run -dt -p 10443:10443 -e CONSUL_HOST=<YOUR_HOST> -e USE_HTTPS=1 -e HTTPS_KEY_PATH=/opt/k.key -e HTTPS_CERT_PATH=/opt/c.crt -v /tmp/k.key:/opt/k.key -v /tmp/c.crt:/opt/c.crt cbs:X.Y.

Locally for development (no docker)

###Without HTTPS It is recommended that you do this step in a virtualenv. (set -x is Fish notaion, change for Bash etc. accordingly)

pip install --ignore-installed .; set -x CONSUL_HOST <YOUR_HOST>; run.py

###With HTTPS

pip install --ignore-installed .; set -x CONSUL_HOST <YOUR_HOST>; set -x USE_HTTPS 1; set -x USE_HTTPS 1; set -x HTTPS_KEY_PATH /tmp/k.key; set -x HTTPS_CERT_PATH /tmp/c.crt; run.py