X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;ds=inline;f=installers%2Fcharm%2Finterfaces%2Fosm-ro%2FREADME.md;fp=installers%2Fcharm%2Finterfaces%2Fosm-ro%2FREADME.md;h=0000000000000000000000000000000000000000;hb=e93311d0d1e614b2ee73cc88d8a04fdec217cff8;hp=eb6413a361397c6c449ed91d0ab7dbe48164b072;hpb=b26337f4b399b8d2307002aa7ca98c23e2d3a1ed;p=osm%2Fdevops.git diff --git a/installers/charm/interfaces/osm-ro/README.md b/installers/charm/interfaces/osm-ro/README.md deleted file mode 100644 index eb6413a3..00000000 --- a/installers/charm/interfaces/osm-ro/README.md +++ /dev/null @@ -1,63 +0,0 @@ - - -# Overview - -This interface layer handles communication between OSM's RO and its clients. - -## Usage - -### Provides - -To implement this relation to offer an ro: - -In your charm's metadata.yaml: - -```yaml -provides: - ro: - interface: osm-ro -``` - -reactive/myro.py: - -```python -@when('ro.joined') -def send_config(ro): - ro.send_connection( - unit_get('private-address'), - get_ro_port() - ) -``` - -### Requires - -If you would like to use a rodb from your charm: - -metadata.yaml: - -```yaml -requires: - ro: - interface: osm-ro -``` - -reactive/mycharm.py: - -```python -@when('ro.ready') -def ro_ready(): - ro = endpoint_from_flag('ro.ready') - if ro: - for unit in ro.ros(): - add_ro(unit['host'], unit['port']) -```