forked from fonoster/routr
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Fonoster Team
committed
Feb 3, 2019
1 parent
af32ff4
commit 9c98826
Showing
15 changed files
with
297 additions
and
300 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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] | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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]' | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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] | ||
``` |
Oops, something went wrong.