knative.dev/pkg@v0.0.0-20260602142205-ac97e43f6622/leaderelection/doc.go (about)

     1  /*
     2  Copyright 2020 The Knative 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  // LeaderElection provides an interface for controllers implementing using
    18  // controller injection:
    19  // https://github.com/knative/pkg/blob/main/injection/README.md
    20  //
    21  // Leaderelection uses the context-stuffing mechanism to provide config-driven
    22  // management of multiple election strategies (currently, using Kubernetes
    23  // etcd-based election primitives or StatefulSet indexes and counts).
    24  //
    25  // For more details, see the original design document:
    26  // https://docs.google.com/document/d/e/2PACX-1vTh40N-Kk6EPNzYpITiLg8YJk0qZyZv7KgMpcQS72T9Lv_F2PQeGybx4TtH0E1N1aUgLQer7b8u3lDc/pub
    27  package leaderelection