Documentation
¶
Overview ¶
+groupName=network.openshift.io Package api is the internal version of the API.
Index ¶
- Constants
- Variables
- func Resource(resource string) schema.GroupResource
- func SetChangePodNetworkAnnotation(netns *NetNamespace, action PodNetworkAction, params string)
- type ClusterNetwork
- type ClusterNetworkEntry
- type ClusterNetworkList
- type EgressNetworkPolicy
- type EgressNetworkPolicyList
- type EgressNetworkPolicyPeer
- type EgressNetworkPolicyRule
- type EgressNetworkPolicyRuleType
- type EgressNetworkPolicySpec
- type HostSubnet
- type HostSubnetList
- type NetNamespace
- type NetNamespaceList
- type PodNetworkAction
Constants ¶
const (
// ChangePodNetworkAnnotation is an annotation on NetNamespace to request change of pod network
ChangePodNetworkAnnotation string = "pod.network.openshift.io/multitenant.change-network"
// Acceptable values for ChangePodNetworkAnnotation
GlobalPodNetwork PodNetworkAction = "global"
JoinPodNetwork PodNetworkAction = "join"
IsolatePodNetwork PodNetworkAction = "isolate"
)
const (
ClusterNetworkDefault = "default"
EgressNetworkPolicyMaxRules = 50
)
const (
// HostSubnet annotations. (Note: should be "hostsubnet.network.openshift.io/", but the incorrect name is now part of the API.)
AssignHostSubnetAnnotation = "pod.network.openshift.io/assign-subnet"
)
const (
GroupName = "network.openshift.io"
)
Variables ¶
var (
Install = schemeBuilder.AddToScheme
// DEPRECATED kept for generated code
SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}
// DEPRECATED kept for generated code
AddToScheme = schemeBuilder.AddToScheme
)
var (
ErrorPodNetworkAnnotationNotFound = fmt.Errorf("ChangePodNetworkAnnotation not found")
)
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource kept for generated code DEPRECATED
func SetChangePodNetworkAnnotation ¶
func SetChangePodNetworkAnnotation(netns *NetNamespace, action PodNetworkAction, params string)
SetChangePodNetworkAnnotation sets network change intent on NetNamespace
Types ¶
type ClusterNetwork ¶
type ClusterNetwork struct {
metav1.TypeMeta
metav1.ObjectMeta
ClusterNetworks []ClusterNetworkEntry
Network string
HostSubnetLength uint32
ServiceNetwork string
PluginName string
VXLANPort *uint32
}
func (*ClusterNetwork) DeepCopy ¶
func (in *ClusterNetwork) DeepCopy() *ClusterNetwork
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterNetwork.
func (*ClusterNetwork) DeepCopyInto ¶
func (in *ClusterNetwork) DeepCopyInto(out *ClusterNetwork)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterNetwork) DeepCopyObject ¶
func (in *ClusterNetwork) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterNetworkEntry ¶
type ClusterNetworkEntry struct {
CIDR string
HostSubnetLength uint32
}
func (*ClusterNetworkEntry) DeepCopy ¶
func (in *ClusterNetworkEntry) DeepCopy() *ClusterNetworkEntry
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterNetworkEntry.
func (*ClusterNetworkEntry) DeepCopyInto ¶
func (in *ClusterNetworkEntry) DeepCopyInto(out *ClusterNetworkEntry)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ClusterNetworkList ¶
type ClusterNetworkList struct {
metav1.TypeMeta
metav1.ListMeta
Items []ClusterNetwork
}
func (*ClusterNetworkList) DeepCopy ¶
func (in *ClusterNetworkList) DeepCopy() *ClusterNetworkList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterNetworkList.
func (*ClusterNetworkList) DeepCopyInto ¶
func (in *ClusterNetworkList) DeepCopyInto(out *ClusterNetworkList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterNetworkList) DeepCopyObject ¶
func (in *ClusterNetworkList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type EgressNetworkPolicy ¶
type EgressNetworkPolicy struct {
metav1.TypeMeta
metav1.ObjectMeta
Spec EgressNetworkPolicySpec
}
EgressNetworkPolicy describes the current egress network policy
func (*EgressNetworkPolicy) DeepCopy ¶
func (in *EgressNetworkPolicy) DeepCopy() *EgressNetworkPolicy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EgressNetworkPolicy.
func (*EgressNetworkPolicy) DeepCopyInto ¶
func (in *EgressNetworkPolicy) DeepCopyInto(out *EgressNetworkPolicy)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*EgressNetworkPolicy) DeepCopyObject ¶
func (in *EgressNetworkPolicy) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type EgressNetworkPolicyList ¶
type EgressNetworkPolicyList struct {
metav1.TypeMeta
metav1.ListMeta
Items []EgressNetworkPolicy
}
EgressNetworkPolicyList is a collection of EgressNetworkPolicy
func (*EgressNetworkPolicyList) DeepCopy ¶
func (in *EgressNetworkPolicyList) DeepCopy() *EgressNetworkPolicyList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EgressNetworkPolicyList.
func (*EgressNetworkPolicyList) DeepCopyInto ¶
func (in *EgressNetworkPolicyList) DeepCopyInto(out *EgressNetworkPolicyList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*EgressNetworkPolicyList) DeepCopyObject ¶
func (in *EgressNetworkPolicyList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type EgressNetworkPolicyPeer ¶
type EgressNetworkPolicyPeer struct {
CIDRSelector string
DNSName string
}
EgressNetworkPolicyPeer specifies a target to apply egress policy to
func (*EgressNetworkPolicyPeer) DeepCopy ¶
func (in *EgressNetworkPolicyPeer) DeepCopy() *EgressNetworkPolicyPeer
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EgressNetworkPolicyPeer.
func (*EgressNetworkPolicyPeer) DeepCopyInto ¶
func (in *EgressNetworkPolicyPeer) DeepCopyInto(out *EgressNetworkPolicyPeer)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type EgressNetworkPolicyRule ¶
type EgressNetworkPolicyRule struct {
Type EgressNetworkPolicyRuleType
To EgressNetworkPolicyPeer
}
EgressNetworkPolicyRule contains a single egress network policy rule
func (*EgressNetworkPolicyRule) DeepCopy ¶
func (in *EgressNetworkPolicyRule) DeepCopy() *EgressNetworkPolicyRule
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EgressNetworkPolicyRule.
func (*EgressNetworkPolicyRule) DeepCopyInto ¶
func (in *EgressNetworkPolicyRule) DeepCopyInto(out *EgressNetworkPolicyRule)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type EgressNetworkPolicyRuleType ¶
type EgressNetworkPolicyRuleType string
EgressNetworkPolicyRuleType gives the type of an EgressNetworkPolicyRule
const (
EgressNetworkPolicyRuleAllow EgressNetworkPolicyRuleType = "Allow"
EgressNetworkPolicyRuleDeny EgressNetworkPolicyRuleType = "Deny"
)
type EgressNetworkPolicySpec ¶
type EgressNetworkPolicySpec struct {
Egress []EgressNetworkPolicyRule
}
EgressNetworkPolicySpec provides a list of policies on outgoing traffic
func (*EgressNetworkPolicySpec) DeepCopy ¶
func (in *EgressNetworkPolicySpec) DeepCopy() *EgressNetworkPolicySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EgressNetworkPolicySpec.
func (*EgressNetworkPolicySpec) DeepCopyInto ¶
func (in *EgressNetworkPolicySpec) DeepCopyInto(out *EgressNetworkPolicySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HostSubnet ¶
type HostSubnet struct {
metav1.TypeMeta
metav1.ObjectMeta
// host may just be an IP address, resolvable hostname or a complete DNS
Host string
HostIP string
Subnet string
EgressIPs []string
EgressCIDRs []string
}
HostSubnet encapsulates the inputs needed to define the container subnet network on a node
func (*HostSubnet) DeepCopy ¶
func (in *HostSubnet) DeepCopy() *HostSubnet
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HostSubnet.
func (*HostSubnet) DeepCopyInto ¶
func (in *HostSubnet) DeepCopyInto(out *HostSubnet)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*HostSubnet) DeepCopyObject ¶
func (in *HostSubnet) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type HostSubnetList ¶
type HostSubnetList struct {
metav1.TypeMeta
metav1.ListMeta
Items []HostSubnet
}
HostSubnetList is a collection of HostSubnets
func (*HostSubnetList) DeepCopy ¶
func (in *HostSubnetList) DeepCopy() *HostSubnetList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HostSubnetList.
func (*HostSubnetList) DeepCopyInto ¶
func (in *HostSubnetList) DeepCopyInto(out *HostSubnetList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*HostSubnetList) DeepCopyObject ¶
func (in *HostSubnetList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type NetNamespace ¶
type NetNamespace struct {
metav1.TypeMeta
metav1.ObjectMeta
NetName string
NetID uint32
EgressIPs []string
}
NetNamespace holds information about the SDN configuration of a Namespace
func (*NetNamespace) DeepCopy ¶
func (in *NetNamespace) DeepCopy() *NetNamespace
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NetNamespace.
func (*NetNamespace) DeepCopyInto ¶
func (in *NetNamespace) DeepCopyInto(out *NetNamespace)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NetNamespace) DeepCopyObject ¶
func (in *NetNamespace) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type NetNamespaceList ¶
type NetNamespaceList struct {
metav1.TypeMeta
metav1.ListMeta
Items []NetNamespace
}
NetNamespaceList is a collection of NetNamespaces
func (*NetNamespaceList) DeepCopy ¶
func (in *NetNamespaceList) DeepCopy() *NetNamespaceList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NetNamespaceList.
func (*NetNamespaceList) DeepCopyInto ¶
func (in *NetNamespaceList) DeepCopyInto(out *NetNamespaceList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NetNamespaceList) DeepCopyObject ¶
func (in *NetNamespaceList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PodNetworkAction ¶
type PodNetworkAction string
func GetChangePodNetworkAnnotation ¶
func GetChangePodNetworkAnnotation(netns *NetNamespace) (PodNetworkAction, string, error)
GetChangePodNetworkAnnotation fetches network change intent from NetNamespace
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
+groupName=network.openshift.io Package v1 is the v1 version of the API.
|
+groupName=network.openshift.io Package v1 is the v1 version of the API. |