airshipctl/pkg/phase/ifc/executor.go
Ruslan Aliev 3e44c42989 Introduce KRM based k8s applier
The KRM based k8s applier solves multiple design problems
which were introduced in previous airshipctl generation,
making apply code and process more clear, reliable and
readable. In particular:
 * k8s applier now is a KRM function and it allows the
   end user to choose or implement desired backend for
   k8s apply operations;
 * the related amount of code was reduced by three times,
   multiple unused and unnecessary structs/interfaces/design
   patterns were removed or rewrited in more clean and efficient
   way;
 * removed cli-utils dependency from airshipctl;
 * fixed several bugs and code issues, such as incorrect printing
   of tables, duplicated unit tests, improper generation and applying
   inventory config map, etc;
 * cli-utils version used in KRM function was bumped to 0.26.0;
 * phases with duplicated k8s resources were removed or fixed;
 * unit test coverage increased to 83.1%;
 * KRM function logs were integrated with klog library which allows
   to observe logs directly from cli-utils and other dependent libs.

Change-Id: Ief509f1d6abefd53caf7fcffc4e36b0319815373
Signed-off-by: Ruslan Aliev <raliev@mirantis.com>
Closes: #646
2021-10-27 08:14:22 +00:00

69 lines
2.0 KiB
Go

/*
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package ifc
import (
"io"
"time"
"opendev.org/airship/airshipctl/pkg/cluster/clustermap"
"opendev.org/airship/airshipctl/pkg/container"
"opendev.org/airship/airshipctl/pkg/document"
"opendev.org/airship/airshipctl/pkg/events"
inventoryifc "opendev.org/airship/airshipctl/pkg/inventory/ifc"
"opendev.org/airship/airshipctl/pkg/k8s/kubeconfig"
)
// Executor interface should be implemented by each runner
type Executor interface {
Run(chan events.Event, RunOptions)
Render(io.Writer, RenderOptions) error
Validate() error
Status() (ExecutorStatus, error)
}
// ExecutorStatus is a struct which defines the status
type ExecutorStatus struct{}
// RunOptions holds options for run method
type RunOptions struct {
DryRun bool
Timeout *time.Duration
}
// RenderOptions holds options for render method
type RenderOptions struct {
FilterSelector document.Selector
}
// ExecutorFactory for executor instantiation
type ExecutorFactory func(config ExecutorConfig) (Executor, error)
// ExecutorConfig container to store all executor options
type ExecutorConfig struct {
PhaseName string
ClusterName string
SinkBasePath string
TargetPath string
ClusterMap clustermap.ClusterMap
ExecutorDocument document.Document
KubeConfig kubeconfig.Interface
BundleFactory document.BundleFactoryFunc
PhaseConfigBundle document.Bundle
Inventory inventoryifc.Inventory
ContainerFunc container.ClientV1Alpha1FactoryFunc
}