api-docs.asciidoc

API Reference

Packages

• kubestatic.quortex.io/v1alpha1

  • ExternalIP

  • FirewallRule

kubestatic.quortex.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the v1alpha1 API group

Resource Types

• ExternalIP

• FirewallRule

Direction(string)

Direction describes the traffic direction. Ingress applies to incoming traffic. Egress applies to outbound traffic.

Appears In:

• FirewallRuleSpec

ExternalIP

ExternalIP is the Schema for the externalips API

Field	Description
apiVersion string	kubestatic.quortex.io/v1alpha1
kind string	ExternalIP
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec ExternalIPSpec

ExternalIPSpec

ExternalIPSpec defines the desired state of ExternalIP

Appears In:

• ExternalIP

Field	Description
nodeName string	NodeName is the node’s instance on which the address must be attached
disableReconciliation boolean	Whether to disable reconciliation of this resource for development purpose
preventEIPDeallocation boolean	PreventDeallocation tells if EIP should be deallocated on ExternalIP deletion

FirewallRule

FirewallRule is the Schema for the firewallrules API

Field	Description
apiVersion string	kubestatic.quortex.io/v1alpha1
kind string	FirewallRule
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec FirewallRuleSpec

FirewallRuleSpec

FirewallRuleSpec defines the desired state of FirewallRule

Appears In:

• FirewallRule

Field	Description
publicIPAddress string	The public IP address of the node to which the firewall rule must be attached. Set either this or nodeName. If both are set, publicIPAddress takes precedence. Using publicAddress is useful when the FirewallRule must be attached to a node with ExternalIP auto-assign. In this case, the ExternalIP may be attached to several nodes during the cluster lifecycle, setting this ensure that the FirewallRule is always attached to the right node.
nodeName string	NodeName is the node’s instance on which the firewall rule must be attached
description string	A description for the firewall rule. This is informational only.
direction Direction	The traffic direction. Ingress applies to incoming traffic. Egress applies to outbound traffic.
fromPort integer	The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
protocol string	The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)). Use -1 to specify all protocols.
ipRanges IPRange array	The IPv4 ranges.
toPort integer	The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
disableReconciliation boolean	Whether to disable reconciliation of this resource for development purpose

IPRange

IPRange Describes an IPv4 range.

Appears In:

• FirewallRuleSpec

Field	Description
cidr string	The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
description string	A description for the rule that references this IPv4 address range.