-
Notifications
You must be signed in to change notification settings - Fork 1
API Reference
Packages:
Resource Types:
TwingateConnector represents a Connector in Twingate.
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | twingate.com/v1beta | true |
kind | string | TwingateConnector | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object |
TwingateConnectorSpec defines the desired state of TwingateConnector Validations: |
false |
status | object |
|
false |
TwingateConnectorSpec defines the desired state of TwingateConnector
Name | Type | Description | Required |
---|---|---|---|
containerExtra | object |
|
false |
hasStatusNotificationsEnabled | boolean |
Enable status notifications for the Connector. Default: true |
false |
id | string |
|
false |
image | object |
Image defines the image to use for the Connector. |
false |
imagePolicy | object |
ImagePolicy defines the image to use for the Connector and a schedule to keep it up to date. Validations: |
false |
logAnalytics | boolean |
Enable real-time connection logs. Default: true |
false |
logLevel | integer |
Log level for the Connector (-1 to 7: -1 for no logs, 0 - least verbose, 7 - most verbose, default: 3). Default: 3 Minimum: -1 Maximum: 7 |
false |
name | string |
Name of the Connector (optional, if not specified Twingate will give a random name) |
false |
podAnnotations | object |
|
false |
podExtra | object |
|
false |
sidecarContainers | []object |
SidecarContainers allows injecting additional containers to the Connector Pod. |
false |
Image defines the image to use for the Connector.
Name | Type | Description | Required |
---|---|---|---|
repository | string |
Repository to use for the Connector. Default: twingate/connector |
false |
tag | string |
Tag to use for the Connector. Default: 1 |
false |
ImagePolicy defines the image to use for the Connector and a schedule to keep it up to date.
Name | Type | Description | Required |
---|---|---|---|
provider | enum |
Provider to use for checking for new versions. Enum: dockerhub, google |
true |
allowPrerelease | boolean |
Allow pre-release versions. Default: false |
false |
repository | string |
Repository to check for new versions tags. Default: twingate/connector |
false |
schedule | string |
Cron schedule to check for new versions. |
false |
version | string |
Semver version specifier (ex: '^1.0.0'). Uses NPM spec: https://github.com/npm/node-semver#ranges |
false |
TwingateResourceAccess represents a resource access policy in Twingate.
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | twingate.com/v1beta | true |
kind | string | TwingateResourceAccess | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object |
TwingateResourceAccessSpec defines the desired state of TwingateResourceAccess |
false |
status | object |
|
false |
TwingateResourceAccessSpec defines the desired state of TwingateResourceAccess
Name | Type | Description | Required |
---|---|---|---|
principalExternalRef | object |
|
false |
principalId | string |
principalId is the ID of the principal to provide access to the resource. Validations: |
false |
resourceRef | object |
resourceRef specifies the TwingateResource reference to provide access to. Validations: |
false |
securityPolicyId | string |
|
false |
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the external reference to match. (Note: name uniqueness is not enforce, if 2 entities match the same name, the first will be used) Validations: |
true |
type | enum |
Type of the external reference. Validations: |
true |
resourceRef specifies the TwingateResource reference to provide access to.
Name | Type | Description | Required |
---|---|---|---|
name | string |
Name of the resource. |
false |
namespace | string |
Namespace of the resource. |
false |
TwingateResource represents a resource in Twingate.
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | twingate.com/v1beta | true |
kind | string | TwingateResource | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object |
TwingateResourceSpec defines the desired state of TwingateResource Validations: |
false |
status | object |
|
false |
TwingateResourceSpec defines the desired state of TwingateResource
Name | Type | Description | Required |
---|---|---|---|
address | string |
Address of the resource. |
true |
name | string |
Name of the resource. |
true |
alias | string |
Alias of the resource. |
false |
id | string |
|
false |
isBrowserShortcutEnabled | boolean |
isBrowserShortcutEnabled specifies whether the resource will display a browser shortcut in the Twingate client. Default: false |
false |
isVisible | boolean |
isVisible specifies whether the resource will display in the main resources list in the Twingate client. Default: true |
false |
protocols | object |
protocols specifies the resource's protocol policies. |
false |
securityPolicyId | string |
|
false |
protocols specifies the resource's protocol policies.
Name | Type | Description | Required |
---|---|---|---|
allowIcmp | boolean |
allowIcmp specifies whether the resource will allow ICMP traffic. |
false |
tcp | object |
tcp specifies the resource's TCP protocol policy. Validations: |
false |
udp | object |
udp specifies the resource's UDP protocol policy. Validations: |
false |
tcp specifies the resource's TCP protocol policy.
Name | Type | Description | Required |
---|---|---|---|
policy | enum |
Enum: ALLOW_ALL, RESTRICTED |
false |
ports | []object |
Default: [] |
false |
Name | Type | Description | Required |
---|---|---|---|
end | integer |
Minimum: 1 Maximum: 65535 |
false |
start | integer |
Minimum: 1 Maximum: 65535 |
false |
udp specifies the resource's UDP protocol policy.
Name | Type | Description | Required |
---|---|---|---|
policy | enum |
Enum: ALLOW_ALL, RESTRICTED |
false |
ports | []object |
Default: [] |
false |
Name | Type | Description | Required |
---|---|---|---|
end | integer |
Minimum: 1 Maximum: 65535 |
false |
start | integer |
Minimum: 1 Maximum: 65535 |
false |
Copyright © 2023 Twingate.