API reference
API reference
This page is generated from the KubeVoIP CRDs in the platform repository. Update the CRDs there, then regenerate this page.
NetworkProfile
- API version:
kubevoip.com/v1alpha1 - Kind:
NetworkProfile - Plural:
networkprofiles - Scope:
Namespaced - Short names:
netprofile
| Field | Type | Required | Constraints |
|---|---|---|---|
spec.externalAddress | object | yes | value or source is required |
spec.externalAddress.source | enum: Service | no | - |
spec.externalAddress.value | string | no | min length: 1max length: 253 |
spec.localNetworks | array[string] | no | - |
Status is managed by the KubeVoIP operator through the Kubernetes status subresource. Status fields are intentionally omitted from this generated reference because they can change while the resources are still alpha.
SIPUser
- API version:
kubevoip.com/v1alpha1 - Kind:
SIPUser - Plural:
sipusers - Scope:
Namespaced - Short names:
sipuser
| Field | Type | Required | Constraints |
|---|---|---|---|
spec.authUsername | string | yes | pattern: ^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$max length: 40 |
spec.callerId | string | no | max length: 80 |
spec.dialPolicyRef | object | yes | - |
spec.dialPolicyRef.name | string | no | min length: 1 |
spec.extension | string | yes | pattern: ^[0-9]+$max length: 20 |
spec.gatewayRef | object | yes | - |
spec.gatewayRef.name | string | no | min length: 1 |
spec.passwordSecretRef | object | yes | - |
spec.passwordSecretRef.key | string | no | min length: 1 |
spec.passwordSecretRef.name | string | no | min length: 1 |
Status is managed by the KubeVoIP operator through the Kubernetes status subresource. Status fields are intentionally omitted from this generated reference because they can change while the resources are still alpha.
SIPTrunk
- API version:
kubevoip.com/v1alpha1 - Kind:
SIPTrunk - Plural:
siptrunks - Scope:
Namespaced - Short names:
siptrunk
| Field | Type | Required | Constraints |
|---|---|---|---|
spec.gatewayRef | object | yes | - |
spec.gatewayRef.name | string | no | min length: 1 |
spec.inbound | object | no | trusted inbound trunks require inbound.dialPolicyRef |
spec.inbound.allowedSourceCidrs | array[string] | no | - |
spec.inbound.dialPolicyRef | object | no | - |
spec.inbound.dialPolicyRef.name | string | no | min length: 1 |
spec.outbound | object | no | - |
spec.outbound.authentication | object | no | Digest authentication requires digest settings Digest authentication requires digest.realm digest settings require mode Digest |
spec.outbound.authentication.digest | object | no | - |
spec.outbound.authentication.digest.passwordSecretRef | object | no | - |
spec.outbound.authentication.digest.passwordSecretRef.key | string | no | min length: 1 |
spec.outbound.authentication.digest.passwordSecretRef.name | string | no | min length: 1 |
spec.outbound.authentication.digest.realm | string | no | min length: 1max length: 253 |
spec.outbound.authentication.digest.usernameSecretRef | object | no | - |
spec.outbound.authentication.digest.usernameSecretRef.key | string | no | min length: 1 |
spec.outbound.authentication.digest.usernameSecretRef.name | string | no | min length: 1 |
spec.outbound.authentication.mode | enum: None, Digest | no | default: None |
spec.outbound.callerIdSecretRef | object | no | - |
spec.outbound.callerIdSecretRef.key | string | no | min length: 1 |
spec.outbound.callerIdSecretRef.name | string | no | min length: 1 |
spec.terminationUri | string | yes | min length: 1 |
Status is managed by the KubeVoIP operator through the Kubernetes status subresource. Status fields are intentionally omitted from this generated reference because they can change while the resources are still alpha.
CallRoute
- API version:
kubevoip.com/v1alpha1 - Kind:
CallRoute - Plural:
callroutes - Scope:
Namespaced - Short names:
callroute
| Field | Type | Required | Constraints |
|---|---|---|---|
spec.gatewayRef | object | yes | - |
spec.gatewayRef.name | string | no | min length: 1 |
spec.match | object | yes | - |
spec.match.calledNumber | string | no | pattern: ^[+0-9.*]+$max length: 64 |
spec.priority | integer | no | minimum: 0maximum: 1000000default: 1000 |
spec.scopeRef | object | yes | - |
spec.scopeRef.name | string | no | min length: 1 |
spec.target | object | yes | exactly one route target is required Asterisk pool routes require extension |
spec.target.asteriskPoolRef | string | no | min length: 1 |
spec.target.extension | string | no | pattern: ^[0-9]+$ |
spec.target.sipUserRef | string | no | min length: 1 |
spec.target.trunkRef | string | no | min length: 1 |
Status is managed by the KubeVoIP operator through the Kubernetes status subresource. Status fields are intentionally omitted from this generated reference because they can change while the resources are still alpha.
CallScope
- API version:
kubevoip.com/v1alpha1 - Kind:
CallScope - Plural:
callscopes - Scope:
Namespaced - Short names:
scope
| Field | Type | Required | Constraints |
|---|---|---|---|
spec.gatewayRef | object | yes | - |
spec.gatewayRef.name | string | no | min length: 1 |
Status is managed by the KubeVoIP operator through the Kubernetes status subresource. Status fields are intentionally omitted from this generated reference because they can change while the resources are still alpha.
DialPolicy
- API version:
kubevoip.com/v1alpha1 - Kind:
DialPolicy - Plural:
dialpolicies - Scope:
Namespaced - Short names:
dialpolicy
| Field | Type | Required | Constraints |
|---|---|---|---|
spec.gatewayRef | object | yes | - |
spec.gatewayRef.name | string | no | min length: 1 |
spec.scopes | array[object] | yes | - |
spec.scopes[].name | string | yes | min length: 1 |
Status is managed by the KubeVoIP operator through the Kubernetes status subresource. Status fields are intentionally omitted from this generated reference because they can change while the resources are still alpha.
MediaRelay
- API version:
kubevoip.com/v1alpha1 - Kind:
MediaRelay - Plural:
mediarelays - Scope:
Namespaced - Short names:
relay
| Field | Type | Required | Constraints |
|---|---|---|---|
spec.image | string | no | min length: 1 |
spec.media | object | yes | start must not exceed end media range cannot exceed 2000 ports |
spec.media.end | integer | no | minimum: 1maximum: 65535 |
spec.media.start | integer | no | minimum: 1maximum: 65535 |
spec.network | object | no | - |
spec.network.externalAddress | string | no | min length: 1max length: 253 |
spec.network.mode | enum: Service, HostNetwork | no | default: Service |
spec.network.replicaOverrides | array[object] | no | - |
spec.network.replicaOverrides[].externalAddress | string | yes | min length: 1max length: 253 |
spec.network.replicaOverrides[].replica | integer | yes | minimum: 0 |
spec.network.service | object | no | - |
spec.network.service.annotations | object | no | - |
spec.network.service.externalTrafficPolicy | enum: Cluster, Local | no | default: Cluster |
spec.network.service.type | enum: ClusterIP, LoadBalancer | no | default: ClusterIP |
spec.networkProfileRef | object | yes | - |
spec.networkProfileRef.name | string | no | min length: 1 |
spec.replicas | integer | no | minimum: 1maximum: 32default: 1 |
Status is managed by the KubeVoIP operator through the Kubernetes status subresource. Status fields are intentionally omitted from this generated reference because they can change while the resources are still alpha.
AsteriskPool
- API version:
kubevoip.com/v1alpha1 - Kind:
AsteriskPool - Plural:
asteriskpools - Scope:
Namespaced - Short names:
astpool
| Field | Type | Required | Constraints |
|---|---|---|---|
spec.applications | object | no | - |
spec.applications.echoExtension | string | no | pattern: ^[0-9]+$default: 600 |
spec.image | string | no | min length: 1 |
spec.replicas | integer | no | minimum: 1maximum: 32default: 1 |
Status is managed by the KubeVoIP operator through the Kubernetes status subresource. Status fields are intentionally omitted from this generated reference because they can change while the resources are still alpha.
SIPGateway
- API version:
kubevoip.com/v1alpha1 - Kind:
SIPGateway - Plural:
sipgateways - Scope:
Namespaced - Short names:
sipgw
| Field | Type | Required | Constraints |
|---|---|---|---|
spec.databaseSecretRef | object | yes | - |
spec.databaseSecretRef.name | string | no | min length: 1 |
spec.externalAddress | string | no | min length: 1max length: 253 |
spec.image | string | no | min length: 1 |
spec.internalAddress | string | no | min length: 1max length: 253 |
spec.mediaRelayRef | object | yes | - |
spec.mediaRelayRef.name | string | no | min length: 1 |
spec.networkProfileRef | object | yes | - |
spec.networkProfileRef.name | string | no | min length: 1 |
spec.replicas | integer | no | minimum: 1maximum: 32default: 1 |
spec.service | object | no | - |
spec.service.annotations | object | no | - |
spec.service.externalTrafficPolicy | enum: Cluster, Local | no | default: Cluster |
spec.service.type | enum: ClusterIP, LoadBalancer | no | default: ClusterIP |
Status is managed by the KubeVoIP operator through the Kubernetes status subresource. Status fields are intentionally omitted from this generated reference because they can change while the resources are still alpha.