v1

README

CustomResourceDefinitions

This directory is used for generating CustomResourceDefinition resources to install into a Kubernetes cluster. Calico APIs that are backed using CRDs should be added here so that auto-generation picks up the API. See other structs in this directory as an example.

Once added, run make gen-crds in the root of this repository to update the custom resource definition yamls.

Then, once merged, use those yamls to update the CRDs served from https://github.com/projectcalico/calico

Documentation

Overview

API Schema definitions for configuring the installation of Calico and Calico Enterprise +k8s:deepcopy-gen=package,register +groupName=crd.projectcalico.org

Index

• type BGPConfiguration
• type BGPFilter
• type BGPPeer
• type BlockAffinity
• type CalicoNodeStatus
• type ClusterInformation
• type FelixConfiguration
• type GlobalNetworkPolicy
• type GlobalNetworkSet
• type HostEndpoint
• type IPAMBlock
• type IPAMConfig
• type IPAMHandle
• type IPPool
• type IPReservation
• type KubeControllersConfiguration
• type NetworkPolicy
• type NetworkSet

Types

type BGPConfiguration

type BGPConfiguration struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              v3.BGPConfigurationSpec `json:"spec,omitempty"`
}

BGPConfiguration contains the configuration for any BGP routing. +k8s:openapi-gen=true +kubebuilder:resource:scope=Cluster

type BGPFilter

type BGPFilter struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec v3.BGPFilterSpec `json:"spec,omitempty"`
}

+k8s:openapi-gen=true +kubebuilder:resource:scope=Cluster

type BGPPeer

type BGPPeer struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              v3.BGPPeerSpec `json:"spec,omitempty"`
}

+k8s:openapi-gen=true +kubebuilder:resource:scope=Cluster

type BlockAffinity

type BlockAffinity struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              v3.BlockAffinitySpec `json:"spec,omitempty"`
}

+k8s:openapi-gen=true +kubebuilder:resource:scope=Cluster

type CalicoNodeStatus

type CalicoNodeStatus struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   v3.CalicoNodeStatusSpec   `json:"spec,omitempty"`
	Status v3.CalicoNodeStatusStatus `json:"status,omitempty"`
}

+k8s:openapi-gen=true +kubebuilder:resource:scope=Cluster

type ClusterInformation

type ClusterInformation struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              v3.ClusterInformationSpec `json:"spec,omitempty"`
}

ClusterInformation contains the cluster specific information. +k8s:openapi-gen=true +kubebuilder:resource:scope=Cluster

type FelixConfiguration

type FelixConfiguration struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              v3.FelixConfigurationSpec `json:"spec,omitempty"`
}

Felix Configuration contains the configuration for Felix. +k8s:openapi-gen=true +kubebuilder:resource:scope=Cluster

type GlobalNetworkPolicy

type GlobalNetworkPolicy struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              v3.GlobalNetworkPolicySpec `json:"spec,omitempty"`
}

+k8s:openapi-gen=true +kubebuilder:resource:scope=Cluster

type GlobalNetworkSet

type GlobalNetworkSet struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              v3.GlobalNetworkSetSpec `json:"spec,omitempty"`
}

GlobalNetworkSet contains a set of arbitrary IP sub-networks/CIDRs that share labels to allow rules to refer to them via selectors. The labels of GlobalNetworkSet are not namespaced. +k8s:openapi-gen=true +kubebuilder:resource:scope=Cluster

type HostEndpoint

type HostEndpoint struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              v3.HostEndpointSpec `json:"spec,omitempty"`
}

+k8s:openapi-gen=true +kubebuilder:resource:scope=Cluster

type IPAMBlock

type IPAMBlock struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              v3.IPAMBlockSpec `json:"spec,omitempty"`
}

+k8s:openapi-gen=true +kubebuilder:resource:scope=Cluster

type IPAMConfig

type IPAMConfig struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              v3.IPAMConfigSpec `json:"spec,omitempty"`
}

+k8s:openapi-gen=true +kubebuilder:resource:scope=Cluster

type IPAMHandle

type IPAMHandle struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              v3.IPAMHandleSpec `json:"spec,omitempty"`
}

+k8s:openapi-gen=true +kubebuilder:resource:scope=Cluster

type IPPool

type IPPool struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              v3.IPPoolSpec `json:"spec,omitempty"`
}

+k8s:openapi-gen=true +kubebuilder:resource:scope=Cluster

type IPReservation

type IPReservation struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              v3.IPReservationSpec `json:"spec,omitempty"`
}

type KubeControllersConfiguration

type KubeControllersConfiguration struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              v3.KubeControllersConfigurationSpec   `json:"spec,omitempty"`
	Status            v3.KubeControllersConfigurationStatus `json:"status,omitempty"`
}

+k8s:openapi-gen=true +kubebuilder:resource:scope=Cluster

type NetworkPolicy

type NetworkPolicy struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              v3.NetworkPolicySpec `json:"spec,omitempty"`
}

+k8s:openapi-gen=true

type NetworkSet

type NetworkSet struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              v3.NetworkSetSpec `json:"spec,omitempty"`
}

NetworkSet is the Namespaced-equivalent of the GlobalNetworkSet. +k8s:openapi-gen=true