X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=installers%2Fcharm%2Finterfaces%2Fosm-nbi%2FREADME.md;fp=installers%2Fcharm%2Finterfaces%2Fosm-nbi%2FREADME.md;h=0000000000000000000000000000000000000000;hb=668b1469296df65fee65d62abbbbd087c69c2c04;hp=8fb9523f62699d88b8cd889dabc86cf0768eaea6;hpb=56db64f403eaea09530d1073640eee9b36ff2caf;p=osm%2Fdevops.git diff --git a/installers/charm/interfaces/osm-nbi/README.md b/installers/charm/interfaces/osm-nbi/README.md deleted file mode 100644 index 8fb9523f..00000000 --- a/installers/charm/interfaces/osm-nbi/README.md +++ /dev/null @@ -1,63 +0,0 @@ - - -# Overview - -This interface layer handles communication between Mongodb and its clients. - -## Usage - -### Provides - -To implement this relation to offer an nbi: - -In your charm's metadata.yaml: - -```yaml -provides: - nbi: - interface: osm-nbi -``` - -reactive/mynbi.py: - -```python -@when('nbi.joined') -def send_config(nbi): - nbi.send_connection( - unit_get('private-address'), - get_nbi_port() - ) -``` - -### Requires - -If you would like to use an nbi from your charm: - -metadata.yaml: - -```yaml -requires: - nbi: - interface: osm-nbi -``` - -reactive/mycharm.py: - -```python -@when('nbi.ready') -def nbi_ready(): - nbi = endpoint_from_flag('nbi.ready') - if nbi: - for unit in nbi.nbis(): - add_nbi(unit['host'], unit['port']) -```