1b960c129d
Phase helper provides plenty of useful methods for a phase client. But these methods are not used by phase executor initializers except for getting some configuration values. So, it is better to provide initializers with necessary values instead of passing them the phase helper. Change-Id: I8c596455e30444570a86efad73d792af0ca83a33 Relates-To: #464 Relates-To: #465
74 lines
2.0 KiB
Go
74 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/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
|
|
Progress bool
|
|
|
|
Timeout time.Duration
|
|
}
|
|
|
|
// RenderOptions holds options for render method
|
|
type RenderOptions struct {
|
|
FilterSelector document.Selector
|
|
}
|
|
|
|
// WaitOptions holds only timeout now, but may be extended in the future
|
|
type WaitOptions struct {
|
|
Timeout time.Duration
|
|
}
|
|
|
|
// 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
|
|
}
|