github.com/kubewharf/katalyst-core@v0.5.3/pkg/controller/kcc/target/doc.go (about)

     1  /*
     2  Copyright 2022 The Katalyst Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  // Package target is the package that is responsible to maintain the kcc-target logic
    18  //
    19  // handler.go: store kcc-target mapping info (mata) in-memory, common use cases include
    20  // - maintain accessor lifecycle for a given kcc-target CRD
    21  // - find kcc-target CR for a given kcc CR (considering history data rather than current CR)
    22  // - find kcc CR for a given kcc-target CR (considering history data rather than current CR)
    23  // ...
    24  //
    25  // accessor.go: construct a handler for each given kcc-target (mapping with 1:1), common use cases include
    26  // - maintain the informer lifecycle for each kcc-target CRD
    27  // - handle events for each kcc-target CR (using registered handler function)
    28  // ...
    29  package target // import "github.com/kubewharf/katalyst-core/pkg/controller/kcc/target"