Skip to content

Move operator caching from resolver into a new package. #2316

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 5, 2021
Merged

Move operator caching from resolver into a new package. #2316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions pkg/controller/operators/olm/operator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ import (
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators/internal/pruning"
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators/olm/overrides"
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry/resolver"
resolvercache "github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry/resolver/cache"
"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/clients"
csvutility "github.com/operator-framework/operator-lifecycle-manager/pkg/lib/csv"
"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/event"
Expand Down Expand Up @@ -1364,7 +1365,7 @@ func (a *Operator) transitionCSVState(in v1alpha1.ClusterServiceVersion) (out *v
out = in.DeepCopy()
now := a.now()

operatorSurface, err := resolver.NewOperatorFromV1Alpha1CSV(out)
operatorSurface, err := resolvercache.NewOperatorFromV1Alpha1CSV(out)
if err != nil {
// If the resolver is unable to retrieve the operator info from the CSV the CSV requires changes, a syncError should not be returned.
logger.WithError(err).Warn("Unable to retrieve operator information from CSV")
Expand Down Expand Up @@ -1428,7 +1429,7 @@ func (a *Operator) transitionCSVState(in v1alpha1.ClusterServiceVersion) (out *v

groupSurface := resolver.NewOperatorGroup(operatorGroup)
otherGroupSurfaces := resolver.NewOperatorGroupSurfaces(otherGroups...)
providedAPIs := operatorSurface.ProvidedAPIs().StripPlural()
providedAPIs := operatorSurface.GetProvidedAPIs().StripPlural()

switch result := a.apiReconciler.Reconcile(providedAPIs, groupSurface, otherGroupSurfaces...); {
case operatorGroup.Spec.StaticProvidedAPIs && (result == resolver.AddAPIs || result == resolver.RemoveAPIs):
Expand Down
9 changes: 5 additions & 4 deletions pkg/controller/operators/olm/operator_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ import (
olmerrors "github.com/operator-framework/operator-lifecycle-manager/pkg/controller/errors"
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/install"
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry/resolver"
resolvercache "github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry/resolver/cache"
"github.com/operator-framework/operator-lifecycle-manager/pkg/fakes"
"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/clientfake"
csvutility "github.com/operator-framework/operator-lifecycle-manager/pkg/lib/csv"
Expand Down Expand Up @@ -872,7 +873,7 @@ func TestTransitionCSV(t *testing.T) {
logrus.SetLevel(logrus.DebugLevel)
namespace := "ns"

apiHash, err := resolver.APIKeyToGVKHash(opregistry.APIKey{Group: "g1", Version: "v1", Kind: "c1"})
apiHash, err := resolvercache.APIKeyToGVKHash(opregistry.APIKey{Group: "g1", Version: "v1", Kind: "c1"})
require.NoError(t, err)

defaultOperatorGroup := &v1.OperatorGroup{
Expand Down Expand Up @@ -3693,7 +3694,7 @@ func TestSyncOperatorGroups(t *testing.T) {
v1alpha1.CSVPhaseNone,
), labels.Set{resolver.APILabelKeyPrefix + "9f4c46c37bdff8d0": "provided"})

operatorCSV.Spec.InstallStrategy.StrategySpec.DeploymentSpecs[0].Spec.Template.Spec.Containers[0].Env = []corev1.EnvVar{corev1.EnvVar{
operatorCSV.Spec.InstallStrategy.StrategySpec.DeploymentSpecs[0].Spec.Template.Spec.Containers[0].Env = []corev1.EnvVar{{
Name: "OPERATOR_CONDITION_NAME",
Value: operatorCSV.GetName(),
}}
Expand Down Expand Up @@ -4631,7 +4632,7 @@ func TestOperatorGroupConditions(t *testing.T) {
},
expectError: true,
expectedConditions: []metav1.Condition{
metav1.Condition{
{
Type: v1.OperatorGroupServiceAccountCondition,
Status: metav1.ConditionTrue,
Reason: v1.OperatorGroupServiceAccountReason,
Expand Down Expand Up @@ -4674,7 +4675,7 @@ func TestOperatorGroupConditions(t *testing.T) {
},
expectError: true,
expectedConditions: []metav1.Condition{
metav1.Condition{
{
Type: v1.MutlipleOperatorGroupCondition,
Status: metav1.ConditionTrue,
Reason: v1.MultipleOperatorGroupsReason,
Expand Down
23 changes: 12 additions & 11 deletions pkg/controller/operators/olm/operatorgroup.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/install"
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators/decorators"
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry/resolver"
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry/resolver/cache"
hashutil "github.com/operator-framework/operator-lifecycle-manager/pkg/lib/kubernetes/pkg/util/hash"
"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/ownerutil"
opregistry "github.com/operator-framework/operator-registry/pkg/registry"
Expand All @@ -46,7 +47,7 @@ var (
)

func aggregationLabelFromAPIKey(k opregistry.APIKey, suffix string) (string, error) {
hash, err := resolver.APIKeyToGVKHash(k)
hash, err := cache.APIKeyToGVKHash(k)
if err != nil {
return "", err
}
Expand Down Expand Up @@ -188,7 +189,7 @@ func (a *Operator) syncOperatorGroups(obj interface{}) error {
groupSurface := resolver.NewOperatorGroup(op)
groupProvidedAPIs := groupSurface.ProvidedAPIs()
providedAPIsForCSVs := a.providedAPIsFromCSVs(op, logger)
providedAPIsForGroup := make(resolver.APISet)
providedAPIsForGroup := make(cache.APISet)
for api := range providedAPIsForCSVs {
providedAPIsForGroup[api] = struct{}{}
}
Expand Down Expand Up @@ -309,26 +310,26 @@ func (a *Operator) providedAPIsFromCSVs(group *v1.OperatorGroup, logger *logrus.
// TODO: Throw out CSVs that aren't members of the group due to group related failures?

// Union the providedAPIsFromCSVs from existing members of the group
operatorSurface, err := resolver.NewOperatorFromV1Alpha1CSV(csv)
operatorSurface, err := cache.NewOperatorFromV1Alpha1CSV(csv)
if err != nil {
logger.WithError(err).Warn("could not create OperatorSurface from csv")
continue
}
for providedAPI := range operatorSurface.ProvidedAPIs().StripPlural() {
for providedAPI := range operatorSurface.GetProvidedAPIs().StripPlural() {
providedAPIsFromCSVs[providedAPI] = csv
}
}
return providedAPIsFromCSVs
}

func (a *Operator) pruneProvidedAPIs(group *v1.OperatorGroup, groupProvidedAPIs resolver.APISet, providedAPIsFromCSVs map[opregistry.APIKey]*v1alpha1.ClusterServiceVersion, logger *logrus.Entry) {
func (a *Operator) pruneProvidedAPIs(group *v1.OperatorGroup, groupProvidedAPIs cache.APISet, providedAPIsFromCSVs map[opregistry.APIKey]*v1alpha1.ClusterServiceVersion, logger *logrus.Entry) {
// Don't prune providedAPIsFromCSVs if static
if group.Spec.StaticProvidedAPIs {
a.logger.Debug("group has static provided apis. skipping provided api pruning")
return
}

intersection := make(resolver.APISet)
intersection := make(cache.APISet)
for api := range providedAPIsFromCSVs {
if _, ok := groupProvidedAPIs[api]; ok {
intersection[api] = struct{}{}
Expand Down Expand Up @@ -978,7 +979,7 @@ func (a *Operator) updateNamespaceList(op *v1.OperatorGroup) ([]string, error) {
return namespaceList, nil
}

func (a *Operator) ensureOpGroupClusterRole(op *v1.OperatorGroup, suffix string, apis resolver.APISet) error {
func (a *Operator) ensureOpGroupClusterRole(op *v1.OperatorGroup, suffix string, apis cache.APISet) error {
clusterRole := &rbacv1.ClusterRole{
ObjectMeta: metav1.ObjectMeta{
Name: strings.Join([]string{op.GetName(), suffix}, "-"),
Expand Down Expand Up @@ -1029,7 +1030,7 @@ func (a *Operator) ensureOpGroupClusterRole(op *v1.OperatorGroup, suffix string,
return nil
}

func (a *Operator) ensureOpGroupClusterRoles(op *v1.OperatorGroup, apis resolver.APISet) error {
func (a *Operator) ensureOpGroupClusterRoles(op *v1.OperatorGroup, apis cache.APISet) error {
for _, suffix := range Suffices {
if err := a.ensureOpGroupClusterRole(op, suffix, apis); err != nil {
return err
Expand All @@ -1038,7 +1039,7 @@ func (a *Operator) ensureOpGroupClusterRoles(op *v1.OperatorGroup, apis resolver
return nil
}

func (a *Operator) findCSVsThatProvideAnyOf(provide resolver.APISet) ([]*v1alpha1.ClusterServiceVersion, error) {
func (a *Operator) findCSVsThatProvideAnyOf(provide cache.APISet) ([]*v1alpha1.ClusterServiceVersion, error) {
csvs, err := a.lister.OperatorsV1alpha1().ClusterServiceVersionLister().ClusterServiceVersions(metav1.NamespaceAll).List(labels.Everything())
if err != nil {
return nil, err
Expand All @@ -1051,12 +1052,12 @@ func (a *Operator) findCSVsThatProvideAnyOf(provide resolver.APISet) ([]*v1alpha
continue
}

operatorSurface, err := resolver.NewOperatorFromV1Alpha1CSV(csv)
operatorSurface, err := cache.NewOperatorFromV1Alpha1CSV(csv)
if err != nil {
continue
}

if len(operatorSurface.ProvidedAPIs().StripPlural().Intersection(provide)) > 0 {
if len(operatorSurface.GetProvidedAPIs().StripPlural().Intersection(provide)) > 0 {
providers = append(providers, csv)
}
}
Expand Down
Loading