controllers

Documentation

Index

• Constants
• type APISIXConfigurationReconciler
  • func (r *APISIXConfigurationReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *APISIXConfigurationReconciler) SetupWithManager(mgr ctrl.Manager) error
• type ControlPlaneConditionReason
• type ControlPlaneFinalizer
• type ControlPlaneReconciler
  • func (r *ControlPlaneReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *ControlPlaneReconciler) SetupWithManager(mgr ctrl.Manager) error
• type DataPlaneConditionReason
• type DataPlaneConditionType
• type DataPlaneReconciler
  • func (r *DataPlaneReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *DataPlaneReconciler) SetupWithManager(mgr ctrl.Manager) error

Constants

const (
	// ControlPlaneConditionReasonPodsNotReady is a reason which indicates why a ControlPlane
	// has not yet reached a fully Provisioned status.
	ControlPlaneConditionReasonPodsNotReady k8sutils.ConditionReason = "PodsNotReady"

	// ControlPlaneConditionReasonPodsReady is a reason which indicates how a ControlPlane
	// reached fully Provisioned status.
	ControlPlaneConditionReasonPodsReady k8sutils.ConditionReason = "PodsReady"

	// ControlPlaneConditionsReasonNoDataplane is a reason which indicates that no DataPlane
	// has been provisioned.
	ControlPlaneConditionReasonNoDataplane k8sutils.ConditionReason = "NoDataplane"
)

const (
	// DataPlaneConditionReasonPodsNotReady is a reason which indicates why a DataPlane
	// has not yet reached a fully Provisioned status.
	DataPlaneConditionReasonPodsNotReady k8sutils.ConditionReason = "PodsNotReady"

	// DataPlaneConditionReasonPodsReady is a reason which indicates how a DataPlane
	// reached fully Provisioned status.
	DataPlaneConditionReasonPodsReady k8sutils.ConditionReason = "PodsReady"

	// DataPlaneConditionValidationFailed is a reason which indicates validation of
	// a dataplane is failed.
	DataPlaneConditionValidationFailed k8sutils.ConditionReason = "ValidationFailed"
)

const (
	// ControlPlaneConditionTypeProvisioned is a condition type indicating whether or
	// not all Deployments (or Daemonsets) for the ControlPlane have been provisioned
	// successfully.
	ControlPlaneConditionTypeProvisioned k8sutils.ConditionType = "Provisioned"
)

const (
	// DataPlaneConditionTypeProvisioned is a condition type indicating whether or
	// not all Deployments (or Daemonsets) for the DataPlane have been provisioned
	// successfully.
	DataPlaneConditionTypeProvisioned k8sutils.ConditionType = "Provisioned"
)

Types

type APISIXConfigurationReconciler

type APISIXConfigurationReconciler struct {
	client.Client
	Scheme *runtime.Scheme
}

APISIXConfigurationReconciler reconciles a APISIXConfiguration object

func (*APISIXConfigurationReconciler) Reconcile

func (r *APISIXConfigurationReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

Reconcile is part of the main kubernetes reconciliation loop which aims to move the current state of the cluster closer to the desired state. TODO(user): Modify the Reconcile function to compare the state specified by the APISIXConfiguration object against the actual cluster state, and then perform operations to make the cluster state reflect the state specified by the user.

For more details, check Reconcile and its Result here: - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.12.2/pkg/reconcile

func (*APISIXConfigurationReconciler) SetupWithManager

func (r *APISIXConfigurationReconciler) SetupWithManager(mgr ctrl.Manager) error

SetupWithManager sets up the controller with the Manager.

type ControlPlaneConditionReason

type ControlPlaneConditionReason string

ControlPlaneConditionReason are the condition reasons for ControlPlane status conditions.

type ControlPlaneFinalizer

type ControlPlaneFinalizer string

ControlPlaneFinalizer defines finalizers added by controlplane controller.

const (
	// ControlPlaneFinalizerCleanupClusterRole is the finalizer to cleanup clusterroles owned by controlplane on deleting.
	ControlPlaneFinalizerCleanupClusterRole ControlPlaneFinalizer = "apisix-operator.apisix.apache.org/cleanup-clusterrole"
	// ControlPlaneFinalizerCleanupClusterRoleBinding is the finalizer to cleanup clusterrolebindings owned by controlplane on deleting.
	ControlPlaneFinalizerCleanupClusterRoleBinding ControlPlaneFinalizer = "apisix-operator.apisix.apache.org/cleanup-clusterrolebinding"
)

type ControlPlaneReconciler

type ControlPlaneReconciler struct {
	client.Client
	Scheme                   *runtime.Scheme
	ClusterCASecretName      string
	ClusterCASecretNamespace string
}

ControlPlaneReconciler reconciles a ControlPlane object

func (*ControlPlaneReconciler) Reconcile

func (r *ControlPlaneReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

Reconcile moves the current state of an object to the intended state.

func (*ControlPlaneReconciler) SetupWithManager

func (r *ControlPlaneReconciler) SetupWithManager(mgr ctrl.Manager) error

SetupWithManager sets up the controller with the Manager.

type DataPlaneConditionReason

type DataPlaneConditionReason string

DataPlaneConditionReason are the condition reasons for DataPlane status conditions.

type DataPlaneConditionType

type DataPlaneConditionType string

DataPlaneConditionType are condition types for DataPlane status conditions.

type DataPlaneReconciler

type DataPlaneReconciler struct {
	client.Client
	Scheme *runtime.Scheme

	ClusterCASecretName      string
	ClusterCASecretNamespace string
	// contains filtered or unexported fields
}

DataPlaneReconciler reconciles a DataPlane object

func (*DataPlaneReconciler) Reconcile

func (r *DataPlaneReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

Reconcile is part of the main kubernetes reconciliation loop which aims to move the current state of the cluster closer to the desired state. TODO(user): Modify the Reconcile function to compare the state specified by the DataPlane object against the actual cluster state, and then perform operations to make the cluster state reflect the state specified by the user.

Reconcile 是 k8s 调和循环的一部分，其目的是使集群的当前状态更加接近于理想状态。

For more details, check Reconcile and its Result here: - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.12.2/pkg/reconcile

func (*DataPlaneReconciler) SetupWithManager

func (r *DataPlaneReconciler) SetupWithManager(mgr ctrl.Manager) error

SetupWithManager sets up the controller with the Manager.