sigs.k8s.io/cluster-api-provider-aws@v1.5.5/pkg/planner/planner.go (about)

     1  /*
     2  Copyright 2021 The Kubernetes 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 planner
    18  
    19  import "context"
    20  
    21  // NOTE: this is based on this prior work https://gianarb.it/blog/reactive-plan-golang-example
    22  // which has been adapted for use here.
    23  
    24  // Plan represents an interface for a plan of operations.
    25  type Plan interface {
    26  	// Create will perform the plan and will return a list of operations/procedures
    27  	// that need to be run to accomplish the plan
    28  	Create(ctx context.Context) ([]Procedure, error)
    29  }
    30  
    31  // Procedure represents a procedure/operation that will be carried out
    32  // as part of executing a plan.
    33  type Procedure interface {
    34  	// Name is the name of the procedure/operation
    35  	Name() string
    36  	// Do will perform the operation/procedure
    37  	Do(ctx context.Context) error
    38  }