This is a cache of https://docs.openshift.com/container-platform/4.15/rest_api/config_apis/network-config-openshift-io-v1.html. It is a snapshot of the page at 2024-11-28T13:25:59.560+0000.
N<strong>e</strong>twork [config.op<strong>e</strong>nshift.io/v1] - Config APIs | API r<strong>e</strong>f<strong>e</strong>r<strong>e</strong>nc<strong>e</strong> | Op<strong>e</strong>nShift Contain<strong>e</strong>r Platform 4.15
    OpenShift docs are moving and will soon only be available at docs.redhat.com, the home of all Red Hat product documentation. explore the new docs experience today.
  1. Documentation
    2. history bug_report picture_as_pdf
&times;

Network [config.openshift.io/v1]

Description

Network holds cluster-wide information about Network. The canonical name is cluster. It is used to configure the desired network configuration, such as: IP address pools for services/pod IPs, network plugin, etc. Please view network.spec for an explanation on what applies when configuring this resource. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

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

spec holds user settable values for configuration. As a general rule, this SHOULD NOT be read directly. Instead, you should consume the NetworkStatus, as it indicates the currently deployed configuration. Currently, most spec fields are immutable after installation. Please view the individual ones for further details on each.

status

object

status holds observed values from the cluster. They may not be overridden.

.spec

Description

spec holds user settable values for configuration. As a general rule, this SHOULD NOT be read directly. Instead, you should consume the NetworkStatus, as it indicates the currently deployed configuration. Currently, most spec fields are immutable after installation. Please view the individual ones for further details on each.

Type

object

Property Type Description

clusterNetwork

array

IP address pool to use for pod IPs. This field is immutable after installation.

clusterNetwork[]

object

ClusterNetworkentry is a contiguous block of IP addresses from which pod IPs are allocated.

externalIP

object

externalIP defines configuration for controllers that affect Service.externalIP. If nil, then externalIP is not allowed to be set.

networkType

string

NetworkType is the plugin that is to be deployed (e.g. OpenShiftSDN). This should match a value that the cluster-network-operator understands, or else no networking will be installed. Currently supported values are: - OpenShiftSDN This field is immutable after installation.

serviceNetwork

array (string)

IP address pool for services. Currently, we only support a single entry here. This field is immutable after installation.

serviceNodePortRange

string

The port range allowed for Services of type NodePort. If not specified, the default of 30000-32767 will be used. Such Services without a NodePort specified will have one automatically allocated from this range. This parameter can be updated after the cluster is installed.

.spec.clusterNetwork

Description

IP address pool to use for pod IPs. This field is immutable after installation.

Type

array

.spec.clusterNetwork[]

Description

ClusterNetworkentry is a contiguous block of IP addresses from which pod IPs are allocated.

Type

object

Property Type Description

cidr

string

The complete block for pod IPs.

hostPrefix

integer

The size (prefix) of block to allocate to each node. If this field is not used by the plugin, it can be left unset.

.spec.externalIP

Description

externalIP defines configuration for controllers that affect Service.externalIP. If nil, then externalIP is not allowed to be set.

Type

object

Property Type Description

autoAssignCIDRs

array (string)

autoAssignCIDRs is a list of CIDRs from which to automatically assign Service.externalIP. These are assigned when the service is of type LoadBalancer. In general, this is only useful for bare-metal clusters. In Openshift 3.x, this was misleadingly called "IngressIPs". Automatically assigned external IPs are not affected by any externalIPPolicy rules. Currently, only one entry may be provided.

policy

object

policy is a set of restrictions applied to the externalIP field. If nil or empty, then externalIP is not allowed to be set.

.spec.externalIP.policy

Description

policy is a set of restrictions applied to the externalIP field. If nil or empty, then externalIP is not allowed to be set.

Type

object

Property Type Description

allowedCIDRs

array (string)

allowedCIDRs is the list of allowed CIDRs.

rejectedCIDRs

array (string)

rejectedCIDRs is the list of disallowed CIDRs. These take precedence over allowedCIDRs.

.status

Description

status holds observed values from the cluster. They may not be overridden.

Type

object

Property Type Description

clusterNetwork

array

IP address pool to use for pod IPs.

clusterNetwork[]

object

ClusterNetworkentry is a contiguous block of IP addresses from which pod IPs are allocated.

clusterNetworkMTU

integer

ClusterNetworkMTU is the MTU for inter-pod networking.

conditions

array

conditions represents the observations of a network.config current state. Known .status.conditions.type are: "NetworkTypeMigrationInProgress", "NetworkTypeMigrationMTUReady", "NetworkTypeMigrationTargetCNIAvailable", "NetworkTypeMigrationTargetCNIInUse" and "NetworkTypeMigrationOriginalCNIPurged"

conditions[]

object

Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

migration

object

Migration contains the cluster network migration configuration.

networkType

string

NetworkType is the plugin that is deployed (e.g. OpenShiftSDN).

serviceNetwork

array (string)

IP address pool for services. Currently, we only support a single entry here.

.status.clusterNetwork

Description

IP address pool to use for pod IPs.

Type

array

.status.clusterNetwork[]

Description

ClusterNetworkentry is a contiguous block of IP addresses from which pod IPs are allocated.

Type

object

Property Type Description

cidr

string

The complete block for pod IPs.

hostPrefix

integer

The size (prefix) of block to allocate to each node. If this field is not used by the plugin, it can be left unset.

.status.conditions

Description

conditions represents the observations of a network.config current state. Known .status.conditions.type are: "NetworkTypeMigrationInProgress", "NetworkTypeMigrationMTUReady", "NetworkTypeMigrationTargetCNIAvailable", "NetworkTypeMigrationTargetCNIInUse" and "NetworkTypeMigrationOriginalCNIPurged"

Type

array

.status.conditions[]

Description

Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

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. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)

.status.migration

Description

Migration contains the cluster network migration configuration.

Type

object

Property Type Description

mtu

object

MTU contains the MTU migration configuration.

networkType

string

NetworkType is the target plugin that is to be deployed. Currently supported values are: OpenShiftSDN, OVNKubernetes

.status.migration.mtu

Description

MTU contains the MTU migration configuration.

Type

object

Property Type Description

machine

object

Machine contains MTU migration configuration for the machine’s uplink.

network

object

Network contains MTU migration configuration for the default network.

.status.migration.mtu.machine

Description

Machine contains MTU migration configuration for the machine’s uplink.

Type

object

Property Type Description

from

integer

From is the MTU to migrate from.

to

integer

To is the MTU to migrate to.

.status.migration.mtu.network

Description

Network contains MTU migration configuration for the default network.

Type

object

Property Type Description

from

integer

From is the MTU to migrate from.

to

integer

To is the MTU to migrate to.

API endpoints

The following API endpoints are available:

  • /apis/config.openshift.io/v1/networks

    • DeLeTe: delete collection of Network

    • GeT: list objects of kind Network

    • POST: create a Network

  • /apis/config.openshift.io/v1/networks/{name}

    • DeLeTe: delete a Network

    • GeT: read the specified Network

    • PATCH: partially update the specified Network

    • PUT: replace the specified Network

/apis/config.openshift.io/v1/networks

HTTP method

DeLeTe

Description

delete collection of Network

Table 1. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

401 - Unauthorized

empty
HTTP method

GeT

Description

list objects of kind Network

Table 2. HTTP responses
HTTP code Reponse body

200 - OK

NetworkList schema

401 - Unauthorized

empty
HTTP method

POST

Description

create a Network

Table 3. 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.
Table 4. Body parameters
Parameter Type Description

body

Network schema
Table 5. HTTP responses
HTTP code Reponse body

200 - OK

Network schema

201 - Created

Network schema

202 - Accepted

Network schema

401 - Unauthorized

empty

/apis/config.openshift.io/v1/networks/{name}

Table 6. Global path parameters
Parameter Type Description

name

string

name of the Network
HTTP method

DeLeTe

Description

delete a Network

Table 7. 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
Table 8. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

empty
HTTP method

GeT

Description

read the specified Network

Table 9. HTTP responses
HTTP code Reponse body

200 - OK

Network schema

401 - Unauthorized

empty
HTTP method

PATCH

Description

partially update the specified Network

Table 10. 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.
Table 11. HTTP responses
HTTP code Reponse body

200 - OK

Network schema

401 - Unauthorized

empty
HTTP method

PUT

Description

replace the specified Network

Table 12. 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.
Table 13. Body parameters
Parameter Type Description

body

Network schema
Table 14. HTTP responses
HTTP code Reponse body

200 - OK

Network schema

201 - Created

Network schema

401 - Unauthorized

empty