[CORD-2585]
Lint check documentation with markdownlint

Change-Id: Ifec3a636be862d53206477187c2868b1cb357c5b
1 file changed
tree: 1d026828b3ae3413790929c331b99a6de8692d25
  1. .gitignore
  2. README.md
  3. docs/
  4. podconfig/
  5. rcord.yml
  6. templates/
  7. xos/
README.md

R-CORD Profile

The R-CORD (Residential CORD) profile is Official.

Service Manifest

R-CORD includes the following service manifest:

ServiceSource Code
vOLThttps://github.com/opencord/olt
vSGhttps://github.com/opencord/vsg
vRouterhttps://github.com/opencord/vrouter
vTRhttps://github.com/opencord/vtr
ExampleServicehttps://github.com/opencord/exampleservice
VTNhttps://github.com/opencord/vtn
Fabrichttps://github.com/opencord/fabric
OpenStackhttps://github.com/opencord/openstack
ONOShttps://github.com/opencord/onos-service

Model Extensions

R-CORD extends CORD's core models with the following model specification (rcord.xproto), which represents the subscriber that anchors a chain of ServiceInstances:

message CordSubscriberRoot (ServiceInstance) {
     option kind = "CordSubscriberRoot";

     required bool firewall_enable = 1 [default = False, null = False, db_index = False, blank = True];
     optional string firewall_rules = 2 [default = "accept all anywhere anywhere", null = True, db_index = False, blank = True];
     required bool url_filter_enable = 3 [default = False, null = False, db_index = False, blank = True];
     optional string url_filter_rules = 4 [default = "allow all", null = True, db_index = False, blank = True];
     required string url_filter_level = 5 [default = "PG", max_length = 30, content_type = "stripped", blank = False, null = False, db_index = False];
     required bool cdn_enable = 6 [default = False, null = False, db_index = False, blank = True];
     required bool is_demo_user = 7 [default = False, null = False, db_index = False, blank = True];
     required int32 uplink_speed = 8 [default = 1000000000, null = False, db_index = False, blank = False];
     required int32 downlink_speed = 9 [default = 1000000000, null = False, db_index = False, blank = False];
     required bool enable_uverse = 10 [default = True, null = False, db_index = False, blank = True];
     required string status = 11 [default = "enabled", choices = "(('enabled', 'Enabled'), ('suspended', 'Suspended'), ('delinquent', 'Delinquent'), ('copyrightviolation', 'Copyright Violation'))", max_length = 30, content_type = "stripped", blank = False, null = False, db_index = False];
	 }

GUI Extensions

R-CORD includes the following GUI extensions: