Manager's cache index related code is scattered in several places

[pmalek]

Problem statement

Currently manager's index related code is scattered across several places:

• https://github.com/Kong/gateway-operator/blob/fb23412717ccc423ce63d384f6a520d365d8faa1/internal/utils/index/index.go

• gateway-operator/modules/manager/controller_setup.go

  Lines 614 to 716 in 733f221

  	// SetupCacheIndicesForKonnectTypes sets up the cache indices for the controllers.
  	// This is done only once because 1 manager's cache can only have one index with
  	// a predefined key and so that different controllers can share the same indices.
  	func SetupCacheIndicesForKonnectTypes(ctx context.Context, mgr manager.Manager, developmentMode bool) error {
  	types := []struct {
  	Object interface {
  	client.Object
  	GetTypeName() string
  	}
  	IndexOptions []konnect.ReconciliationIndexOption
  	}{
  	{
  	Object: &configurationv1alpha1.KongPluginBinding{},
  	IndexOptions: konnect.IndexOptionsForKongPluginBinding(),
  	},
  	{
  	Object: &configurationv1alpha1.KongCredentialBasicAuth{},
  	IndexOptions: konnect.IndexOptionsForCredentialsBasicAuth(),
  	},
  	{
  	Object: &configurationv1alpha1.KongCredentialACL{},
  	IndexOptions: konnect.IndexOptionsForCredentialsACL(),
  	},
  	{
  	Object: &configurationv1alpha1.KongCredentialJWT{},
  	IndexOptions: konnect.IndexOptionsForCredentialsJWT(),
  	},
  	{
  	Object: &configurationv1alpha1.KongCredentialAPIKey{},
  	IndexOptions: konnect.IndexOptionsForCredentialsAPIKey(),
  	},
  	{
  	Object: &configurationv1alpha1.KongCredentialHMAC{},
  	IndexOptions: konnect.IndexOptionsForCredentialsHMAC(),
  	},
  	{
  	Object: &configurationv1.KongConsumer{},
  	IndexOptions: konnect.IndexOptionsForKongConsumer(),
  	},
  	{
  	Object: &configurationv1beta1.KongConsumerGroup{},
  	IndexOptions: konnect.IndexOptionsForKongConsumerGroup(),
  	},
  	{
  	Object: &configurationv1alpha1.KongService{},
  	IndexOptions: konnect.IndexOptionsForKongService(),
  	},
  	{
  	Object: &configurationv1alpha1.KongRoute{},
  	IndexOptions: konnect.IndexOptionsForKongRoute(),
  	},
  	{
  	Object: &configurationv1alpha1.KongUpstream{},
  	IndexOptions: konnect.IndexOptionsForKongUpstream(),
  	},
  	{
  	Object: &configurationv1alpha1.KongTarget{},
  	IndexOptions: konnect.IndexOptionsForKongTarget(),
  	},
  	{
  	Object: &configurationv1alpha1.KongSNI{},
  	IndexOptions: konnect.IndexOptionsForKongSNI(),
  	},
  	{
  	Object: &configurationv1alpha1.KongKey{},
  	IndexOptions: konnect.IndexOptionsForKongKey(),
  	},
  	{
  	Object: &configurationv1alpha1.KongKeySet{},
  	IndexOptions: konnect.IndexOptionsForKongKeySet(),
  	},
  	{
  	Object: &configurationv1alpha1.KongDataPlaneClientCertificate{},
  	IndexOptions: konnect.IndexOptionsForKongDataPlaneCertificate(),
  	},
  	{
  	Object: &configurationv1alpha1.KongVault{},
  	IndexOptions: konnect.IndexOptionsForKongVault(),
  	},
  	{
  	Object: &konnectv1alpha1.KonnectGatewayControlPlane{},
  	IndexOptions: konnect.IndexOptionsForKonnectGatewayControlPlane(),
  	},
  	}
  	for _, t := range types {
  	var (
  	entityTypeName = constraints.EntityTypeNameForObj(t.Object)
  	logger = log.GetLogger(ctx, entityTypeName, developmentMode)
  	)
  	for _, ind := range t.IndexOptions {
  	logger.Info("creating index", "indexField", ind.IndexField)
  	err := mgr.
  	GetCache().
  	IndexField(ctx, ind.IndexObject, ind.IndexField, ind.ExtractValue)
  	if err != nil {
  	return fmt.Errorf("failed to setup cache indices for %s: %w", entityTypeName, err)
  	}
  	}
  	}
  	return nil
  	}

• gateway-operator/modules/manager/controller_setup.go

  Lines 162 to 182 in 733f221

  	func setupIndexes(ctx context.Context, mgr manager.Manager, cfg Config) error {
  	if cfg.ControlPlaneControllerEnabled || cfg.GatewayControllerEnabled {
  	log.GetLogger(ctx, "ControlPlane", cfg.DevelopmentMode).Info(
  	"creating index",
  	"indexField", index.DataPlaneNameIndex,
  	)
  	if err := index.DataPlaneNameOnControlPlane(ctx, mgr.GetCache()); err != nil {
  	return fmt.Errorf("failed to setup index for DataPlane names on ControlPlane: %w", err)
  	}
  	if cfg.KongPluginInstallationControllerEnabled {
  	log.GetLogger(ctx, "DataPlane", cfg.DevelopmentMode).Info(
  	"creating index",
  	"indexField", index.KongPluginInstallationsIndex,
  	)
  	if err := index.KongPluginInstallationsOnDataPlane(ctx, mgr.GetCache()); err != nil {
  	return fmt.Errorf("failed to setup index for KongPluginInstallations on DataPlane: %w", err)
  	}
  	}
  	}
  	return nil
  	}

This issue tracks the effort of putting all that code in 1 place and using single boilerplate for scaffolding.

Acceptance criteria

• Manager's cache index related code is in 1 place.