UserDefinedNetwork [k8s.ovn.org/v1]

Description

UserDefinedNetwork describe network request for a Namespace.

Type

`object`

Required

• spec

Specification

Property	Type	Description
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
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
metadata	ObjectMeta	Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec	object	UserDefinedNetworkSpec defines the desired state of UserDefinedNetworkSpec.
status	object	UserDefinedNetworkStatus contains the observed status of the UserDefinedNetwork.

.spec

Description

UserDefinedNetworkSpec defines the desired state of UserDefinedNetworkSpec.

Type

`object`

Required

• topology

Property	Type	Description
layer2	object	Layer2 is the Layer2 topology configuration.
layer3	object	Layer3 is the Layer3 topology configuration.
topology	string	Topology describes network configuration. Allowed values are "Layer3", "Layer2". Layer3 topology creates a layer 2 segment per node, each with a different subnet. Layer 3 routing is used to interconnect node subnets. Layer2 topology creates one logical switch shared by all nodes.

.spec.layer2

Description

Layer2 is the Layer2 topology configuration.

Type

`object`

Required

• role

Property	Type	Description
defaultGatewayIPs	array (string)	defaultGatewayIPs specifies the default gateway IP used in the internal OVN topology. Dual-stack clusters may set 2 IPs (one for each IP family), otherwise only 1 IP is allowed. This field is only allowed for "Primary" network. It is not recommended to set this field without explicit need and understanding of the OVN network topology. When omitted, an IP from the subnets field is used.
infrastructureSubnets	array (string)	infrastructureSubnets specifies a list of internal CIDR ranges that OVN-Kubernetes will reserve for internal network infrastructure. Any IP addresses within these ranges cannot be assigned to workloads. When omitted, OVN-Kubernetes will automatically allocate IP addresses from subnets for its infrastructure needs. When there are not enough available IPs in the provided infrastructureSubnets, OVN-Kubernetes will automatically allocate IP addresses from subnets for its infrastructure needs. When reservedSubnets is also specified the CIDRs cannot overlap. When defaultGatewayIPs is also specified, the default gateway IPs must belong to one of the infrastructure subnet CIDRs. Each item should be in range of the specified CIDR(s) in subnets. The maximum number of entries allowed is 4. The format should match standard CIDR notation (for example, "10.128.0.0/16"). This field must be omitted if subnets is unset or ipam.mode is Disabled.
ipam	object	IPAM section contains IPAM-related configuration for the network.
joinSubnets	array (string)	JoinSubnets are used inside the OVN network topology. Dual-stack clusters may set 2 subnets (one for each IP family), otherwise only 1 subnet is allowed. This field is only allowed for "Primary" network. It is not recommended to set this field without explicit need and understanding of the OVN network topology. When omitted, the platform will choose a reasonable default which is subject to change over time.
mtu	integer	MTU is the maximum transmission unit for a network. MTU is optional, if not provided, the globally configured value in OVN-Kubernetes (defaults to 1400) is used for the network.
reservedSubnets	array (string)	reservedSubnets specifies a list of CIDRs reserved for static IP assignment, excluded from automatic allocation. reservedSubnets is optional. When omitted, all IP addresses in subnets are available for automatic assignment. IPs from these ranges can still be requested through static IP assignment. Each item should be in range of the specified CIDR(s) in subnets. The maximum number of entries allowed is 25. The format should match standard CIDR notation (for example, "10.128.0.0/16"). This field must be omitted if subnets is unset or ipam.mode is Disabled.
role	string	Role describes the network role in the pod. Allowed value is "Secondary". Secondary network is only assigned to pods that use k8s.v1.cni.cncf.io/networks annotation to select given network.
subnets	array (string)	Subnets are used for the pod network across the cluster. Dual-stack clusters may set 2 subnets (one for each IP family), otherwise only 1 subnet is allowed. The format should match standard CIDR notation (for example, "10.128.0.0/16"). This field must be omitted if ipam.mode is Disabled.

.spec.layer2.ipam

Description

IPAM section contains IPAM-related configuration for the network.

Type

`object`

Property	Type	Description
lifecycle	string	Lifecycle controls IP addresses management lifecycle. The only allowed value is Persistent. When set, OVN Kubernetes assigned IP addresses will be persisted in an ipamclaims.k8s.cni.cncf.io object. These IP addresses will be reused by other pods if requested. Only supported when mode is Enabled.
mode	string	Mode controls how much of the IP configuration will be managed by OVN. Enabled means OVN-Kubernetes will apply IP configuration to the SDN infrastructure and it will also assign IPs from the selected subnet to the individual pods. Disabled means OVN-Kubernetes will only assign MAC addresses and provide layer 2 communication, letting users configure IP addresses for the pods. Disabled is only available for Secondary networks. By disabling IPAM, any Kubernetes features that rely on selecting pods by IP will no longer function (such as network policy, services, etc). Additionally, IP port security will also be disabled for interfaces attached to this network. Defaults to Enabled.

.spec.layer3

Description

Layer3 is the Layer3 topology configuration.

Type

`object`

Required

• role
• subnets

Property	Type	Description
joinSubnets	array (string)	JoinSubnets are used inside the OVN network topology. Dual-stack clusters may set 2 subnets (one for each IP family), otherwise only 1 subnet is allowed. This field is only allowed for "Primary" network. It is not recommended to set this field without explicit need and understanding of the OVN network topology. When omitted, the platform will choose a reasonable default which is subject to change over time.
mtu	integer	MTU is the maximum transmission unit for a network. MTU is optional, if not provided, the globally configured value in OVN-Kubernetes (defaults to 1400) is used for the network.
role	string	Role describes the network role in the pod. Allowed values are "Primary" and "Secondary". Primary network is automatically assigned to every pod created in the same namespace. Secondary network is only assigned to pods that use k8s.v1.cni.cncf.io/networks annotation to select given network.
subnets	array	Subnets are used for the pod network across the cluster. Dual-stack clusters may set 2 subnets (one for each IP family), otherwise only 1 subnet is allowed. Given subnet is split into smaller subnets for every node.
subnets[]	object

.spec.layer3.subnets

Description

Subnets are used for the pod network across the cluster.

Dual-stack clusters may set 2 subnets (one for each IP family), otherwise only 1 subnet is allowed. Given subnet is split into smaller subnets for every node.

Type

`array`

.spec.layer3.subnets[]

Description

Type

`object`

Required

• cidr

Property	Type	Description
cidr	string	CIDR specifies L3Subnet, which is split into smaller subnets for every node.
hostSubnet	integer	HostSubnet specifies the subnet size for every node. When not set, it will be assigned automatically.

.status

Description

UserDefinedNetworkStatus contains the observed status of the UserDefinedNetwork.

Type

`object`

Property	Type	Description
conditions	array
conditions[]	object	Condition contains details for one aspect of the current state of this API Resource.

.status.conditions

Description

Type

`array`

.status.conditions[]

Description

Condition contains details for one aspect of the current state of this API Resource.

Type

`object`

Required

• lastTransitionTime
• message
• reason
• status
• type

Property	Type	Description
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message	string	message is a human readable message indicating details about the transition. This may be an empty string.
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reason	string	reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
status	string	status of the condition, one of True, False, Unknown.
type	string	type of condition in CamelCase or in foo.example.com/CamelCase.

API endpoints

The following API endpoints are available:

• /apis/k8s.ovn.org/v1/userdefinednetworks

  • GET: list objects of kind UserDefinedNetwork

• /apis/k8s.ovn.org/v1/namespaces/{namespace}/userdefinednetworks

  • DELETE: delete collection of UserDefinedNetwork
  • GET: list objects of kind UserDefinedNetwork
  • POST: create an UserDefinedNetwork

• /apis/k8s.ovn.org/v1/namespaces/{namespace}/userdefinednetworks/{name}

  • DELETE: delete an UserDefinedNetwork
  • GET: read the specified UserDefinedNetwork
  • PATCH: partially update the specified UserDefinedNetwork
  • PUT: replace the specified UserDefinedNetwork

• /apis/k8s.ovn.org/v1/namespaces/{namespace}/userdefinednetworks/{name}/status

  • GET: read status of the specified UserDefinedNetwork
  • PATCH: partially update status of the specified UserDefinedNetwork
  • PUT: replace status of the specified UserDefinedNetwork

/apis/k8s.ovn.org/v1/userdefinednetworks

HTTP method

`GET`

Description

list objects of kind UserDefinedNetwork

HTTP responses

HTTP code	Reponse body
200 - OK	UserDefinedNetworkList schema
401 - Unauthorized	Empty

/apis/k8s.ovn.org/v1/namespaces/{namespace}/userdefinednetworks

HTTP method

`DELETE`

Description

delete collection of UserDefinedNetwork

HTTP responses

HTTP code	Reponse body
200 - OK	Status schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

list objects of kind UserDefinedNetwork

HTTP responses

HTTP code	Reponse body
200 - OK	UserDefinedNetworkList schema
401 - Unauthorized	Empty

HTTP method

`POST`

Description

create an UserDefinedNetwork

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
body	UserDefinedNetwork schema

HTTP responses

HTTP code	Reponse body
200 - OK	UserDefinedNetwork schema
201 - Created	UserDefinedNetwork schema
202 - Accepted	UserDefinedNetwork schema
401 - Unauthorized	Empty

/apis/k8s.ovn.org/v1/namespaces/{namespace}/userdefinednetworks/{name}

Global path parameters

Parameter	Type	Description
name	string	name of the UserDefinedNetwork

HTTP method

`DELETE`

Description

delete an UserDefinedNetwork

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

HTTP responses

HTTP code	Reponse body
200 - OK	Status schema
202 - Accepted	Status schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

read the specified UserDefinedNetwork

HTTP responses

HTTP code	Reponse body
200 - OK	UserDefinedNetwork schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update the specified UserDefinedNetwork

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP responses

HTTP code	Reponse body
200 - OK	UserDefinedNetwork schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace the specified UserDefinedNetwork

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
body	UserDefinedNetwork schema

HTTP responses

HTTP code	Reponse body
200 - OK	UserDefinedNetwork schema
201 - Created	UserDefinedNetwork schema
401 - Unauthorized	Empty

/apis/k8s.ovn.org/v1/namespaces/{namespace}/userdefinednetworks/{name}/status

Global path parameters

Parameter	Type	Description
name	string	name of the UserDefinedNetwork

HTTP method

`GET`

Description

read status of the specified UserDefinedNetwork

HTTP responses

HTTP code	Reponse body
200 - OK	UserDefinedNetwork schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update status of the specified UserDefinedNetwork

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP responses

HTTP code	Reponse body
200 - OK	UserDefinedNetwork schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace status of the specified UserDefinedNetwork

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
body	UserDefinedNetwork schema

HTTP responses

HTTP code	Reponse body
200 - OK	UserDefinedNetwork schema
201 - Created	UserDefinedNetwork schema
401 - Unauthorized	Empty