Skip to content

Commit

Permalink
Added configs section
Browse files Browse the repository at this point in the history
  • Loading branch information
Fonoster Team committed Feb 3, 2019
1 parent af32ff4 commit 9c98826
Show file tree
Hide file tree
Showing 15 changed files with 297 additions and 300 deletions.
280 changes: 0 additions & 280 deletions docs/api/resources.md

This file was deleted.

28 changes: 27 additions & 1 deletion docs/configuration/agents.md
Original file line number Diff line number Diff line change
@@ -1 +1,27 @@
Coming soon!
## Agent Resource

> This file can be found at 'config/agents.yml' in the root of this project.
| Property | Description | Required |
| --- | --- | --- |
| apiVersion | Indicates the version of the resource (Not yet implemented)| Yes |
| kind | Defines the type of resource | Yes |
| metadata.name | Friendly name for the SIP device | Yes |
| spec.credentials.username | Agent's credential username | Yes |
| spec.credentials.secret | Agent's credential secret | Yes |
| spec.domains[*] | Context/s in which this Agent is allowed to communicate. FQDN is recommended | Yes |

**Example**

```yaml
# Peers and Agents can register in Routr location service
- apiVersion: v1beta1
kind: Agent
metadata:
name: John Doe
spec:
credentials:
username: john
secret: '1234'
domains: [sip.local]
```
34 changes: 33 additions & 1 deletion docs/configuration/dids.md
Original file line number Diff line number Diff line change
@@ -1 +1,33 @@
Coming soon!
## DID Resource

> This file can be found at 'config/dids.yml' in the root of this project.
| Property | Description | Required |
| --- | --- | --- |
| apiVersion | Indicates the version of the resource (Not yet implemented) | Yes |
| kind | Defines the type of resource | Yes |
| metadata.ref| Reference to this resource | Yes |
| metadata.gwRef| Reference to parent Gateway | Yes |
| metadata.geoInfo.city | City of the DID | No |
| metadata.geoInfo.country | Country of the DID | No |
| metadata.geoInfo.countryISOCode| Country ISO code for the DID (ie.: US) | No |
| spec.location.telUrl | DID URI available in the location server | Yes |
| spec.location.aorLink | Address of record of SIP device for call routing | Yes |

**Example**

```yaml
- apiVersion: v1beta1
kind: DID
metadata:
ref: DID0001
gwRef: GW0001
geoInfo:
city: Columbus, GA
country: USA
countryISOCode: US
spec:
location:
telUrl: 'tel:17066041487'
aorLink: 'sip:[email protected]'
```
40 changes: 39 additions & 1 deletion docs/configuration/domains.md
Original file line number Diff line number Diff line change
@@ -1 +1,39 @@
Coming soon!
## Domain Resource

> This file can be found at 'config/domains.yml' in the root of this project.
| Property | Description | Required |
| --- | --- | --- |
| apiVersion | Indicates the version of the resource (Not yet implemented)| Yes |
| kind | Defines the type of resource | Yes |
| metadata.name | Friendly name for the SIP domain | Yes |
| spec.context.domainUri | Domain URI. FQDN is recommended | Yes |
| spec.context.egressPolicy.rule | Regular expression indicating when a call will be routed via $spec.context.egressPolicy.didRef | No |
| spec.context.egressPolicy.didRef | Reference to the DID that will route the call | No |
| spec.context.accessControlList.allow[*] | Traffic allow for Network in list | No |
| spec.context.accessControlList.deny[*] | Traffic disabled for Network in list| No |

> Access Control List
> Rules may be in CIDR, IP/Mask, or single IP format. Example
> of rules are:
> - 0.0.0.0/1 # all
> - 192.168.1.0/255.255.255.0
> - 192.168.0.1/31
**Example**

```yaml
- apiVersion: v1beta1
kind: Domain
metadata:
name: Local Server
spec:
context:
domainUri: sip.local
egressPolicy:
rule: .*
didRef: DID0001
accessControlList:
deny: [0.0.0.0/1] # Deny all
allow: [192.168.0.1/31]
```
Loading

0 comments on commit 9c98826

Please sign in to comment.