API Reference
Packages
networking.evroclabs.net/v1alpha1
Package v1alpha1 contains API Schema definitions for the networking v1alpha3 API group
Resource Types
- ExternalGateway
- ExternalGatewayList
- PublicIP
- PublicIPList
- SecurityGroup
- SecurityGroupList
- Subnet
- SubnetList
- VirtualPrivateCloud
- VirtualPrivateCloudList
Address
The IP address or CIDR that traffic is allowed to/from.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
IPAddressOrCIDR string | The IP address or CIDR that traffic is allowed to/from. Can be any IPv4 address with any valid mask. | Pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[0-9][0-9]?)\.)((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[0-9][0-9]?)\.)((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[0-9][0-9]?)\.)(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[0-9][0-9]?)(/(3[0-2]|[12][0-9]|[0-9]))?$ |
Direction
Underlying type: string
Direction is the direction of traffic the rule applies to. Can be 'Ingress' or 'Egress'.
Appears in:
ExternalGateway
The schema for an evroc ExternalGateway API.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | networking.evroclabs.net/v1alpha1 | ||
kind string | ExternalGateway | ||
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | ||
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec ExternalGatewaySpec | |||
status ExternalGatewayStatus |
ExternalGatewayList
ExternalGatewayList contains a list of ExternalGateway.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | networking.evroclabs.net/v1alpha1 | ||
kind string | ExternalGatewayList | ||
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | ||
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items ExternalGateway array |
ExternalGatewaySpec
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
vpcRef VpcRefOnExtGw | |||
homeSubnet HomeSubnetRef | |||
location ZonalLocation |
ExternalGatewayStatus
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
conditions ConditionsSet | The state of the ExternalGateway over time. Each condition follows the Kubernetes API conventions for a condition: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties | ||
privateIPv4Address string | The private IPv4 address of the external gateway. A default route will automatically be created by the evroc network layer so that any off-network traffic originating in this VPC will be routed via this address. The public IP addressed used as the source IP for any such traffic is not static. Contact evroc support for a list of possible IP ranges that could be used. | ||
location ZonalLocationOnStatus |
HomeSubnetRef
A reference to a subnet in this VPC that this external gateway node is on. On this subnet the external gateway will reserve and use the penultimate IP. All external traffic originating from all subnets that use this external gateway will first be routed to this IP before being routed to public internet. Deleting the subnet therefore, is blocked, if there is an external gateway residing in the subnet.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
IPRangeOrSingleIP
Underlying type: string
Appears in:
Ipv4CidrBlock
An IPv4 CIDR block.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
block string | Pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[0-9][0-9]?)\.)((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[0-9][0-9]?)\.)((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[0-9][0-9]?)\.)(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[0-9][0-9]?)/(1[6-9]|2[0-9]|3[0-2])$ |
Protocol
Underlying type: string
Protocol is the protocol the rule applies to. Can be 'TCP', 'UDP', or 'ICMP'.
Appears in:
PublicIP
The schema for an evroc Public IP address API.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | networking.evroclabs.net/v1alpha1 | ||
kind string | PublicIP | ||
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | ||
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec PublicIPSpec | |||
status PublicIPStatus |
PublicIPList
PublicIPList contains a list of PublicIP.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | networking.evroclabs.net/v1alpha1 | ||
kind string | PublicIPList | ||
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | ||
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items PublicIP array |
PublicIPSpec
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
vpc string | DEPRECATED. This field is maintained for now for backwards compatibility. It will be removed in a future version of the evroc API. New resources should not set this field. | ||
location RegionalLocation |
PublicIPStatus
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
publicIPv4Address string | The IPv4 address that has been reserved. | ||
conditions ConditionsSet | The state of the PublicIP over time. Each condition follows the Kubernetes API conventions for a condition: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties | ||
usedBy ObjectIdentifier | The object that is currently using this PublicIP object. If a there is an attempt to delete a PublicIP object while it is in use, the deletion will be blocked until the user no longer needs the PublicIP (either because it has been deleted, or has been reconfigured to no longer need the PublicIP). | ||
location RegionalLocationOnStatus |
Remote
The source (for ingress) or destination (for egress) that the rule applies to.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
securityGroupRef SecurityGroupRef | A reference to the security group that traffic is allowed to/from. | ||
subnetRef SubnetRef | A reference to the subnet that traffic is allowed to/from. | ||
address Address | The IP address or CIDR that traffic is allowed to/from. |
SecurityGroup
The schema for an evroc security group API.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | networking.evroclabs.net/v1alpha1 | ||
kind string | SecurityGroup | ||
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | ||
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec SecurityGroupSpec | |||
status SecurityGroupStatus |
SecurityGroupList
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | networking.evroclabs.net/v1alpha1 | ||
kind string | SecurityGroupList | ||
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | ||
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items SecurityGroup array |
SecurityGroupRef
A reference to the security group that traffic is allowed to/from.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | The name of the security group that traffic is allowed to/from. |
SecurityGroupRule
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | The name of the rule. Must be unique per security group. | ||
direction Direction | The direction of traffic the rule applies to. Can be 'Ingress' or 'Egress'. | Enum: [Ingress Egress] | |
protocol Protocol | The protocol the rule applies to. Can be 'TCP', 'UDP', or 'ICMP'. Empty indicates all protocols. | Enum: [All TCP UDP ICMP] | |
port integer | The port the rule applies to. Empty or '0' indicates all ports. Can only be set if the Protocol is TCP or UDP. | Maximum: 65535 | |
endPort integer | If specified, means that the rule applies to all ports from port to endPort. Empty or '0' indicates that only port is opened (if port is specified) or all ports are opened (if port is not specified). | Maximum: 65535 | |
remote Remote | The source (for ingress) or destination (for egress) that the rule applies to. |
SecurityGroupSpec
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
rules SecurityGroupRule array | The rules for this security group. | ||
location RegionalLocation |
SecurityGroupStatus
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
conditions ConditionsSet | |||
location RegionalLocationOnStatus |
Subnet
The schema for an evroc Subnet API.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | networking.evroclabs.net/v1alpha1 | ||
kind string | Subnet | ||
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | ||
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec SubnetSpec | |||
status SubnetStatus |
SubnetList
SubnetList contains a list of Subnet.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | networking.evroclabs.net/v1alpha1 | ||
kind string | SubnetList | ||
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | ||
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items Subnet array |
SubnetRef
A reference to the subnet that traffic is allowed to/from.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | The name of the subnet that traffic is allowed to/from. |
SubnetSpec
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
vpcRef VpcRef | |||
ipv4CidrBlock Ipv4CidrBlock | |||
location ZonalLocation |
SubnetStatus
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
conditions ConditionsSet | The state of the Subnet over time. Each condition follows the Kubernetes API conventions for a condition: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties | ||
availableIPv4Ranges IPRangeOrSingleIP array | availableIPv4Ranges is a list of either single IPs (e.g. "10.0.0.2") or IP ranges ("10.0.0.4-10.0.0.7") of IPv4 addresses currently not in use in this subnet. | ||
usingIPv4Ranges IPRangeOrSingleIP array | usingIPv4Ranges is a list of either single IPs (e.g. "10.0.0.2") or IP ranges ("10.0.0.4-10.0.0.7") of IPv4 addresses currently in use in this subnet. | ||
availableIPv4AddressCount integer | availableIPv4AddressCount is a count of the number of IPv4 addresses not yet assigned in this subnet | ||
usingIPv4AddressCount integer | usingIPv4AddressCount is a count of the number of IPv4 addresses currently in use in this subnet. Deletion of this subnet will be blocked if there are IPs in the subnet in use. Those resources need to be deleted first. | ||
location ZonalLocationOnStatus |
VirtualPrivateCloud
The schema for an evroc Virtual Private Cloud API.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | networking.evroclabs.net/v1alpha1 | ||
kind string | VirtualPrivateCloud | ||
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | ||
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec VirtualPrivateCloudSpec | |||
status VirtualPrivateCloudStatus |
VirtualPrivateCloudList
VirtualPrivateCloudList contains a list of VirtualPrivateCloud.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | networking.evroclabs.net/v1alpha1 | ||
kind string | VirtualPrivateCloudList | ||
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | ||
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items VirtualPrivateCloud array |
VirtualPrivateCloudSpec
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
location RegionalLocation |
VirtualPrivateCloudStatus
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
conditions ConditionsSet | The state of the Virtual Private Cloud over time. Each condition follows the Kubernetes API conventions for a condition: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties | ||
location RegionalLocationOnStatus |
VpcRef
A reference to a VPC object.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
VpcRefOnExtGw
A reference to a VPC object.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string |