Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the networkmanagement v1alpha1 API group. +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/GoogleCloudPlatform/k8s-config-connector/pkg/clients/generated/pkg/apis/networkmanagement +k8s:defaulter-gen=TypeMeta +groupName=networkmanagement.cnrm.cloud.google.com
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // SchemeGroupVersion is the group version used to register these objects. SchemeGroupVersion = schema.GroupVersion{Group: "networkmanagement.cnrm.cloud.google.com", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme. SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} // AddToScheme is a global function that registers this API group & version to a scheme AddToScheme = SchemeBuilder.AddToScheme NetworkManagementConnectivityTestGVK = schema.GroupVersionKind{ Group: SchemeGroupVersion.Group, Version: SchemeGroupVersion.Version, Kind: reflect.TypeOf(NetworkManagementConnectivityTest{}).Name(), } )
Functions ¶
This section is empty.
Types ¶
type ConnectivitytestDestination ¶
type ConnectivitytestDestination struct {
/* A Compute Engine instance URI. */
// +optional
Instance *string `json:"instance,omitempty"`
/* The IP address of the endpoint, which can be an external or
internal IP. An IPv6 address is only allowed when the test's
destination is a global load balancer VIP. */
// +optional
IpAddress *string `json:"ipAddress,omitempty"`
/* A Compute Engine network URI. */
// +optional
Network *string `json:"network,omitempty"`
/* The IP protocol port of the endpoint. Only applicable when
protocol is TCP or UDP. */
// +optional
Port *int64 `json:"port,omitempty"`
/* Project ID where the endpoint is located. The Project ID can be
derived from the URI if you provide a VM instance or network URI.
The following are two cases where you must provide the project ID:
1. Only the IP address is specified, and the IP address is within
a GCP project. 2. When you are using Shared VPC and the IP address
that you provide is from the service project. In this case, the
network that the IP address resides in is defined in the host
project. */
// +optional
ProjectId *string `json:"projectId,omitempty"`
}
func (*ConnectivitytestDestination) DeepCopy ¶
func (in *ConnectivitytestDestination) DeepCopy() *ConnectivitytestDestination
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConnectivitytestDestination.
func (*ConnectivitytestDestination) DeepCopyInto ¶
func (in *ConnectivitytestDestination) DeepCopyInto(out *ConnectivitytestDestination)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ConnectivitytestSource ¶
type ConnectivitytestSource struct {
/* A Compute Engine instance URI. */
// +optional
Instance *string `json:"instance,omitempty"`
/* The IP address of the endpoint, which can be an external or
internal IP. An IPv6 address is only allowed when the test's
destination is a global load balancer VIP. */
// +optional
IpAddress *string `json:"ipAddress,omitempty"`
/* A Compute Engine network URI. */
// +optional
Network *string `json:"network,omitempty"`
/* Type of the network where the endpoint is located. Possible values: ["GCP_NETWORK", "NON_GCP_NETWORK"]. */
// +optional
NetworkType *string `json:"networkType,omitempty"`
/* The IP protocol port of the endpoint. Only applicable when
protocol is TCP or UDP. */
// +optional
Port *int64 `json:"port,omitempty"`
/* Project ID where the endpoint is located. The Project ID can be
derived from the URI if you provide a VM instance or network URI.
The following are two cases where you must provide the project ID:
1. Only the IP address is specified, and the IP address is
within a GCP project.
2. When you are using Shared VPC and the IP address
that you provide is from the service project. In this case,
the network that the IP address resides in is defined in the
host project. */
// +optional
ProjectId *string `json:"projectId,omitempty"`
}
func (*ConnectivitytestSource) DeepCopy ¶
func (in *ConnectivitytestSource) DeepCopy() *ConnectivitytestSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConnectivitytestSource.
func (*ConnectivitytestSource) DeepCopyInto ¶
func (in *ConnectivitytestSource) DeepCopyInto(out *ConnectivitytestSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NetworkManagementConnectivityTest ¶
type NetworkManagementConnectivityTest struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec NetworkManagementConnectivityTestSpec `json:"spec,omitempty"`
Status NetworkManagementConnectivityTestStatus `json:"status,omitempty"`
}
NetworkManagementConnectivityTest is the Schema for the networkmanagement API +k8s:openapi-gen=true
func (*NetworkManagementConnectivityTest) DeepCopy ¶
func (in *NetworkManagementConnectivityTest) DeepCopy() *NetworkManagementConnectivityTest
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NetworkManagementConnectivityTest.
func (*NetworkManagementConnectivityTest) DeepCopyInto ¶
func (in *NetworkManagementConnectivityTest) DeepCopyInto(out *NetworkManagementConnectivityTest)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NetworkManagementConnectivityTest) DeepCopyObject ¶
func (in *NetworkManagementConnectivityTest) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type NetworkManagementConnectivityTestList ¶
type NetworkManagementConnectivityTestList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []NetworkManagementConnectivityTest `json:"items"`
}
NetworkManagementConnectivityTestList contains a list of NetworkManagementConnectivityTest
func (*NetworkManagementConnectivityTestList) DeepCopy ¶
func (in *NetworkManagementConnectivityTestList) DeepCopy() *NetworkManagementConnectivityTestList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NetworkManagementConnectivityTestList.
func (*NetworkManagementConnectivityTestList) DeepCopyInto ¶
func (in *NetworkManagementConnectivityTestList) DeepCopyInto(out *NetworkManagementConnectivityTestList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NetworkManagementConnectivityTestList) DeepCopyObject ¶
func (in *NetworkManagementConnectivityTestList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type NetworkManagementConnectivityTestSpec ¶
type NetworkManagementConnectivityTestSpec struct {
/* The user-supplied description of the Connectivity Test.
Maximum of 512 characters. */
// +optional
Description *string `json:"description,omitempty"`
/* Required. Destination specification of the Connectivity Test.
You can use a combination of destination IP address, Compute
Engine VM instance, or VPC network to uniquely identify the
destination location.
Even if the destination IP address is not unique, the source IP
location is unique. Usually, the analysis can infer the destination
endpoint from route information.
If the destination you specify is a VM instance and the instance has
multiple network interfaces, then you must also specify either a
destination IP address or VPC network to identify the destination
interface.
A reachability analysis proceeds even if the destination location
is ambiguous. However, the result can include endpoints that you
don't intend to test. */
Destination ConnectivitytestDestination `json:"destination"`
/* The project that this resource belongs to. */
ProjectRef v1alpha1.ResourceRef `json:"projectRef"`
/* IP Protocol of the test. When not provided, "TCP" is assumed. */
// +optional
Protocol *string `json:"protocol,omitempty"`
/* Other projects that may be relevant for reachability analysis.
This is applicable to scenarios where a test can cross project
boundaries. */
// +optional
RelatedProjects []string `json:"relatedProjects,omitempty"`
/* Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default. */
// +optional
ResourceID *string `json:"resourceID,omitempty"`
/* Required. Source specification of the Connectivity Test.
You can use a combination of source IP address, virtual machine
(VM) instance, or Compute Engine network to uniquely identify the
source location.
Examples: If the source IP address is an internal IP address within
a Google Cloud Virtual Private Cloud (VPC) network, then you must
also specify the VPC network. Otherwise, specify the VM instance,
which already contains its internal IP address and VPC network
information.
If the source of the test is within an on-premises network, then
you must provide the destination VPC network.
If the source endpoint is a Compute Engine VM instance with multiple
network interfaces, the instance itself is not sufficient to
identify the endpoint. So, you must also specify the source IP
address or VPC network.
A reachability analysis proceeds even if the source location is
ambiguous. However, the test result may include endpoints that
you don't intend to test. */
Source ConnectivitytestSource `json:"source"`
}
func (*NetworkManagementConnectivityTestSpec) DeepCopy ¶
func (in *NetworkManagementConnectivityTestSpec) DeepCopy() *NetworkManagementConnectivityTestSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NetworkManagementConnectivityTestSpec.
func (*NetworkManagementConnectivityTestSpec) DeepCopyInto ¶
func (in *NetworkManagementConnectivityTestSpec) DeepCopyInto(out *NetworkManagementConnectivityTestSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NetworkManagementConnectivityTestStatus ¶
type NetworkManagementConnectivityTestStatus struct {
/* Conditions represent the latest available observations of the
NetworkManagementConnectivityTest's current state. */
Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
/* ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource. */
// +optional
ObservedGeneration *int64 `json:"observedGeneration,omitempty"`
}
func (*NetworkManagementConnectivityTestStatus) DeepCopy ¶
func (in *NetworkManagementConnectivityTestStatus) DeepCopy() *NetworkManagementConnectivityTestStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NetworkManagementConnectivityTestStatus.
func (*NetworkManagementConnectivityTestStatus) DeepCopyInto ¶
func (in *NetworkManagementConnectivityTestStatus) DeepCopyInto(out *NetworkManagementConnectivityTestStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.