mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-06-30 19:20:46 +00:00
6892a9ca57
Currently, backend options are parsed in the yaml parser. This has some issues: - backend specific code should be in the backend folders - it is not possible to add backend options for backends added via addons
63 lines
2 KiB
Go
63 lines
2 KiB
Go
// Copyright 2023 Woodpecker Authors
|
|
//
|
|
// 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
|
|
//
|
|
// http://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 types
|
|
|
|
import (
|
|
"context"
|
|
"io"
|
|
|
|
"github.com/urfave/cli/v2"
|
|
)
|
|
|
|
// Backend defines a container orchestration backend and is used
|
|
// to create and manage container resources.
|
|
type Backend interface {
|
|
// Name returns the name of the backend.
|
|
Name() string
|
|
|
|
// IsAvailable check if the backend is available.
|
|
IsAvailable(ctx context.Context) bool
|
|
|
|
// Flags return the configuration flags of the backend.
|
|
Flags() []cli.Flag
|
|
|
|
// Load loads the backend engine.
|
|
Load(ctx context.Context) (*BackendInfo, error)
|
|
|
|
// SetupWorkflow sets up the workflow environment.
|
|
SetupWorkflow(ctx context.Context, conf *Config, taskUUID string) error
|
|
|
|
// StartStep starts the workflow step.
|
|
StartStep(ctx context.Context, step *Step, taskUUID string) error
|
|
|
|
// WaitStep waits for the workflow step to complete and returns
|
|
// the completion results.
|
|
WaitStep(ctx context.Context, step *Step, taskUUID string) (*State, error)
|
|
|
|
// TailStep tails the workflow step logs.
|
|
TailStep(ctx context.Context, step *Step, taskUUID string) (io.ReadCloser, error)
|
|
|
|
// DestroyStep destroys the workflow step.
|
|
DestroyStep(ctx context.Context, step *Step, taskUUID string) error
|
|
|
|
// DestroyWorkflow destroys the workflow environment.
|
|
DestroyWorkflow(ctx context.Context, conf *Config, taskUUID string) error
|
|
}
|
|
|
|
// BackendInfo represents the reported information of a loaded backend
|
|
type BackendInfo struct {
|
|
Platform string
|
|
}
|