mirror of https://github.com/harness/drone.git
88 lines
3.1 KiB
Go
88 lines
3.1 KiB
Go
// Copyright 2023 Harness, Inc.
|
|
//
|
|
// 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 infraprovider
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/harness/gitness/types"
|
|
"github.com/harness/gitness/types/enum"
|
|
)
|
|
|
|
type InfraProvider interface {
|
|
// Provision provisions infrastructure against a gitspace with the provided parameters.
|
|
Provision(
|
|
ctx context.Context,
|
|
spaceID int64,
|
|
spacePath string,
|
|
gitspaceConfigIdentifier string,
|
|
gitspaceInstanceIdentifier string,
|
|
agentPort int,
|
|
requiredGitspacePorts []types.GitspacePort,
|
|
inputParameters []types.InfraProviderParameter,
|
|
configMetadata map[string]any,
|
|
) error
|
|
|
|
// Find finds infrastructure provisioned against a gitspace.
|
|
Find(
|
|
ctx context.Context,
|
|
spaceID int64,
|
|
spacePath string,
|
|
gitspaceConfigIdentifier string,
|
|
inputParameters []types.InfraProviderParameter,
|
|
) (*types.Infrastructure, error)
|
|
|
|
FindInfraStatus(
|
|
ctx context.Context,
|
|
gitspaceConfigIdentifier string,
|
|
gitspaceInstanceIdentifier string,
|
|
inputParameters []types.InfraProviderParameter,
|
|
) (*enum.InfraStatus, error)
|
|
|
|
// Stop frees up the resources allocated against a gitspace, which can be freed.
|
|
Stop(ctx context.Context, infra types.Infrastructure, configMetadata map[string]any) error
|
|
|
|
// CleanupInstanceResources cleans up resources exclusively allocated to a gitspace instance.
|
|
CleanupInstanceResources(ctx context.Context, infra types.Infrastructure) error
|
|
|
|
// Deprovision removes infrastructure provisioned against a gitspace.
|
|
// canDeleteUserData = false -> remove all resources except storage where user has stored it's data.
|
|
// canDeleteUserData = true -> remove all resources including storage.
|
|
Deprovision(
|
|
ctx context.Context,
|
|
infra types.Infrastructure,
|
|
canDeleteUserData bool,
|
|
configMetadata map[string]any,
|
|
) error
|
|
|
|
// AvailableParams provides a schema to define the infrastructure.
|
|
AvailableParams() []types.InfraProviderParameterSchema
|
|
|
|
// ValidateParams validates the supplied params before defining the infrastructure resource .
|
|
ValidateParams(inputParameters []types.InfraProviderParameter) error
|
|
|
|
// TemplateParams provides a list of params which are of type template.
|
|
TemplateParams() []types.InfraProviderParameterSchema
|
|
|
|
// ProvisioningType specifies whether the provider will provision new infra resources or it will reuse existing.
|
|
ProvisioningType() enum.InfraProvisioningType
|
|
|
|
// ValidateConfig checks if the provided infra config is as per the provider.
|
|
ValidateConfig(infraProviderConfig *types.InfraProviderConfig) error
|
|
|
|
// GenerateSetupYAML generates the setup file required for the infra provider in yaml format.
|
|
GenerateSetupYAML(infraProviderConfig *types.InfraProviderConfig) (string, error)
|
|
}
|