api

package
v0.9.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 2, 2020 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type FakeWebAPI 

type FakeWebAPI struct {
}

FakeWebAPI implements the fake behaviors for the gRPC definitions of WebAPI.

func NewFakeWebAPI 

func NewFakeWebAPI() *FakeWebAPI

NewFakeWebAPI creates a new FakeWebAPI instance.

func (*FakeWebAPI) AddApplication 

func (a *FakeWebAPI) AddApplication(ctx context.Context, req *webservice.AddApplicationRequest) (*webservice.AddApplicationResponse, error)

func (*FakeWebAPI) AddEnvironment 

func (a *FakeWebAPI) AddEnvironment(ctx context.Context, req *webservice.AddEnvironmentRequest) (*webservice.AddEnvironmentResponse, error)

func (*FakeWebAPI) ApproveStage 

func (a *FakeWebAPI) ApproveStage(ctx context.Context, req *webservice.ApproveStageRequest) (*webservice.ApproveStageResponse, error)

func (*FakeWebAPI) CancelDeployment 

func (a *FakeWebAPI) CancelDeployment(ctx context.Context, req *webservice.CancelDeploymentRequest) (*webservice.CancelDeploymentResponse, error)

func (*FakeWebAPI) DisableApplication 

func (a *FakeWebAPI) DisableApplication(ctx context.Context, req *webservice.DisableApplicationRequest) (*webservice.DisableApplicationResponse, error)

func (*FakeWebAPI) DisablePiped 

func (a *FakeWebAPI) DisablePiped(ctx context.Context, req *webservice.DisablePipedRequest) (*webservice.DisablePipedResponse, error)

func (*FakeWebAPI) DisableStaticAdmin 

func (a *FakeWebAPI) DisableStaticAdmin(ctx context.Context, req *webservice.DisableStaticAdminRequest) (*webservice.DisableStaticAdminResponse, error)

func (*FakeWebAPI) EnableApplication 

func (a *FakeWebAPI) EnableApplication(ctx context.Context, req *webservice.EnableApplicationRequest) (*webservice.EnableApplicationResponse, error)

func (*FakeWebAPI) EnablePiped 

func (a *FakeWebAPI) EnablePiped(ctx context.Context, req *webservice.EnablePipedRequest) (*webservice.EnablePipedResponse, error)

func (*FakeWebAPI) EnableStaticAdmin 

func (a *FakeWebAPI) EnableStaticAdmin(ctx context.Context, req *webservice.EnableStaticAdminRequest) (*webservice.EnableStaticAdminResponse, error)

func (*FakeWebAPI) GenerateApplicationSealedSecret 

func (a *FakeWebAPI) GenerateApplicationSealedSecret(ctx context.Context, req *webservice.GenerateApplicationSealedSecretRequest) (*webservice.GenerateApplicationSealedSecretResponse, error)

func (*FakeWebAPI) GetApplication 

func (a *FakeWebAPI) GetApplication(ctx context.Context, req *webservice.GetApplicationRequest) (*webservice.GetApplicationResponse, error)

func (*FakeWebAPI) GetApplicationLiveState 

func (a *FakeWebAPI) GetApplicationLiveState(ctx context.Context, req *webservice.GetApplicationLiveStateRequest) (*webservice.GetApplicationLiveStateResponse, error)

func (*FakeWebAPI) GetCommand 

func (a *FakeWebAPI) GetCommand(ctx context.Context, req *webservice.GetCommandRequest) (*webservice.GetCommandResponse, error)

func (*FakeWebAPI) GetDeployment 

func (a *FakeWebAPI) GetDeployment(ctx context.Context, req *webservice.GetDeploymentRequest) (*webservice.GetDeploymentResponse, error)

func (*FakeWebAPI) GetMe 

func (a *FakeWebAPI) GetMe(ctx context.Context, req *webservice.GetMeRequest) (*webservice.GetMeResponse, error)

func (*FakeWebAPI) GetPiped 

func (a *FakeWebAPI) GetPiped(ctx context.Context, req *webservice.GetPipedRequest) (*webservice.GetPipedResponse, error)

func (*FakeWebAPI) GetProject 

func (a *FakeWebAPI) GetProject(ctx context.Context, req *webservice.GetProjectRequest) (*webservice.GetProjectResponse, error)

func (*FakeWebAPI) GetStageLog 

func (a *FakeWebAPI) GetStageLog(ctx context.Context, req *webservice.GetStageLogRequest) (*webservice.GetStageLogResponse, error)

func (*FakeWebAPI) ListApplications 

func (a *FakeWebAPI) ListApplications(ctx context.Context, req *webservice.ListApplicationsRequest) (*webservice.ListApplicationsResponse, error)

func (*FakeWebAPI) ListDeploymentConfigTemplates 

func (a *FakeWebAPI) ListDeploymentConfigTemplates(ctx context.Context, req *webservice.ListDeploymentConfigTemplatesRequest) (*webservice.ListDeploymentConfigTemplatesResponse, error)

func (*FakeWebAPI) ListDeployments 

func (a *FakeWebAPI) ListDeployments(ctx context.Context, req *webservice.ListDeploymentsRequest) (*webservice.ListDeploymentsResponse, error)

func (*FakeWebAPI) ListEnvironments 

func (a *FakeWebAPI) ListEnvironments(ctx context.Context, req *webservice.ListEnvironmentsRequest) (*webservice.ListEnvironmentsResponse, error)

func (*FakeWebAPI) ListPipeds 

func (a *FakeWebAPI) ListPipeds(ctx context.Context, req *webservice.ListPipedsRequest) (*webservice.ListPipedsResponse, error)

func (*FakeWebAPI) RecreatePipedKey 

func (a *FakeWebAPI) RecreatePipedKey(ctx context.Context, req *webservice.RecreatePipedKeyRequest) (*webservice.RecreatePipedKeyResponse, error)

func (*FakeWebAPI) Register 

func (a *FakeWebAPI) Register(server *grpc.Server)

Register registers all handling of this service into the specified gRPC server.

func (*FakeWebAPI) RegisterPiped 

func (a *FakeWebAPI) RegisterPiped(ctx context.Context, req *webservice.RegisterPipedRequest) (*webservice.RegisterPipedResponse, error)

func (*FakeWebAPI) SyncApplication 

func (a *FakeWebAPI) SyncApplication(ctx context.Context, req *webservice.SyncApplicationRequest) (*webservice.SyncApplicationResponse, error)

func (*FakeWebAPI) UpdateEnvironmentDesc 

func (a *FakeWebAPI) UpdateEnvironmentDesc(ctx context.Context, req *webservice.UpdateEnvironmentDescRequest) (*webservice.UpdateEnvironmentDescResponse, error)

func (*FakeWebAPI) UpdateProjectRBACConfig 

func (a *FakeWebAPI) UpdateProjectRBACConfig(ctx context.Context, req *webservice.UpdateProjectRBACConfigRequest) (*webservice.UpdateProjectRBACConfigResponse, error)

func (*FakeWebAPI) UpdateProjectSSOConfig 

func (a *FakeWebAPI) UpdateProjectSSOConfig(ctx context.Context, req *webservice.UpdateProjectSSOConfigRequest) (*webservice.UpdateProjectSSOConfigResponse, error)

func (*FakeWebAPI) UpdateProjectStaticAdmin 

func (a *FakeWebAPI) UpdateProjectStaticAdmin(ctx context.Context, req *webservice.UpdateProjectStaticAdminRequest) (*webservice.UpdateProjectStaticAdminResponse, error)

type PipedAPI 

type PipedAPI struct {
	// contains filtered or unexported fields
}

PipedAPI implements the behaviors for the gRPC definitions of PipedAPI.

func NewPipedAPI 

func NewPipedAPI(ctx context.Context, ds datastore.DataStore, sls stagelogstore.Store, alss applicationlivestatestore.Store, cs commandstore.Store, logger *zap.Logger) *PipedAPI

NewPipedAPI creates a new PipedAPI instance.

func (*PipedAPI) CreateDeployment 

func (a *PipedAPI) CreateDeployment(ctx context.Context, req *pipedservice.CreateDeploymentRequest) (*pipedservice.CreateDeploymentResponse, error)

CreateDeployment creates/triggers a new deployment for an application that is managed by this piped. This will be used by DeploymentTrigger component.

func (*PipedAPI) GetApplicationMostRecentDeployment 

func (a *PipedAPI) GetApplicationMostRecentDeployment(ctx context.Context, req *pipedservice.GetApplicationMostRecentDeploymentRequest) (*pipedservice.GetApplicationMostRecentDeploymentResponse, error)

GetApplicationMostRecentDeployment returns the most recent deployment of the given application.

func (*PipedAPI) GetEnvironment 

func (a *PipedAPI) GetEnvironment(ctx context.Context, req *pipedservice.GetEnvironmentRequest) (*pipedservice.GetEnvironmentResponse, error)

GetEnvironment finds and returns the environment for the specified ID.

func (*PipedAPI) ListApplications 

func (a *PipedAPI) ListApplications(ctx context.Context, req *pipedservice.ListApplicationsRequest) (*pipedservice.ListApplicationsResponse, error)

ListApplications returns a list of registered applications that should be managed by the requested piped. Disabled applications should not be included in the response. Piped uses this RPC to fetch and sync the application configuration into its local database.

func (*PipedAPI) ListNotCompletedDeployments 

func (a *PipedAPI) ListNotCompletedDeployments(ctx context.Context, req *pipedservice.ListNotCompletedDeploymentsRequest) (*pipedservice.ListNotCompletedDeploymentsResponse, error)

ListNotCompletedDeployments returns a list of not completed deployments which are managed by this piped. DeploymentController component uses this RPC to spawns/syncs its local deployment executors.

func (*PipedAPI) ListUnhandledCommands 

func (a *PipedAPI) ListUnhandledCommands(ctx context.Context, req *pipedservice.ListUnhandledCommandsRequest) (*pipedservice.ListUnhandledCommandsResponse, error)

ListUnhandledCommands is periodically called by piped to obtain the commands that should be handled. Whenever an user makes an interaction from WebUI (cancel/approve/retry/sync) a new command with a unique identifier will be generated an saved into the datastore. Piped uses this RPC to list all still-not-handled commands to handle them, then report back the result to server. On other side, the web will periodically check the command status and feedback the result to user. In the future, we may need a solution to remove all old-handled commands from datastore for space.

func (*PipedAPI) Ping 

func (a *PipedAPI) Ping(ctx context.Context, req *pipedservice.PingRequest) (*pipedservice.PingResponse, error)

Ping is periodically sent to report its realtime status/stats to control-plane. The received stats will be pushed to the metrics collector.

func (*PipedAPI) Register 

func (a *PipedAPI) Register(server *grpc.Server)

Register registers all handling of this service into the specified gRPC server.

func (*PipedAPI) ReportApplicationLiveState 

func (a *PipedAPI) ReportApplicationLiveState(ctx context.Context, req *pipedservice.ReportApplicationLiveStateRequest) (*pipedservice.ReportApplicationLiveStateResponse, error)

ReportApplicationLiveState is periodically sent to correct full state of an application. For kubernetes application, this contains a full tree of its kubernetes resources. The tree data should be written into filestore immediately and then the state in cache should be refreshsed too.

func (*PipedAPI) ReportApplicationLiveStateEvents 

func (a *PipedAPI) ReportApplicationLiveStateEvents(ctx context.Context, req *pipedservice.ReportApplicationLiveStateEventsRequest) (*pipedservice.ReportApplicationLiveStateEventsResponse, error)

ReportApplicationLiveStateEvents is sent by piped to submit one or multiple events about the changes of application state. Control plane uses the received events to update the state of application-resource-tree. We want to start by a simple solution at this initial stage of development, so the API server just handles as below: - loads the releated application-resource-tree from filestore - checks and builds new state for the application-resource-tree - updates new state into fielstore and cache (cache data is for reading while handling web requests) In the future, we may want to redesign the behavior of this RPC by using pubsub/queue pattern. After receiving the events, all of them will be publish into a queue immediately, and then another Handler service will pick them inorder to apply to build new state. By that way we can control the traffic to the datastore in a better way.

func (*PipedAPI) ReportApplicationMostRecentDeployment 

func (a *PipedAPI) ReportApplicationMostRecentDeployment(ctx context.Context, req *pipedservice.ReportApplicationMostRecentDeploymentRequest) (*pipedservice.ReportApplicationMostRecentDeploymentResponse, error)

ReportApplicationMostRecentDeployment is used to update the basic information about the most recent deployment of a specific application.

func (*PipedAPI) ReportApplicationSyncState 

func (a *PipedAPI) ReportApplicationSyncState(ctx context.Context, req *pipedservice.ReportApplicationSyncStateRequest) (*pipedservice.ReportApplicationSyncStateResponse, error)

ReportApplicationSyncState is used to update the sync status of an application.

func (*PipedAPI) ReportCommandHandled 

func (a *PipedAPI) ReportCommandHandled(ctx context.Context, req *pipedservice.ReportCommandHandledRequest) (*pipedservice.ReportCommandHandledResponse, error)

ReportCommandHandled is called by piped to mark a specific command as handled. The request payload will contain the handle status as well as any additional result data. The handle result should be updated to both datastore and cache (for reading from web).

func (*PipedAPI) ReportDeploymentCompleted 

func (a *PipedAPI) ReportDeploymentCompleted(ctx context.Context, req *pipedservice.ReportDeploymentCompletedRequest) (*pipedservice.ReportDeploymentCompletedResponse, error)

ReportDeploymentCompleted used by piped to update the status of a specific deployment to SUCCESS | FAILURE | CANCELLED.

func (*PipedAPI) ReportDeploymentPlanned 

func (a *PipedAPI) ReportDeploymentPlanned(ctx context.Context, req *pipedservice.ReportDeploymentPlannedRequest) (*pipedservice.ReportDeploymentPlannedResponse, error)

ReportDeploymentPlanned used by piped to update the status of a specific deployment to PLANNED.

func (*PipedAPI) ReportDeploymentStatusChanged 

func (a *PipedAPI) ReportDeploymentStatusChanged(ctx context.Context, req *pipedservice.ReportDeploymentStatusChangedRequest) (*pipedservice.ReportDeploymentStatusChangedResponse, error)

ReportDeploymentStatusChanged is used to update the status of a specific deployment to RUNNING or ROLLING_BACK.

func (*PipedAPI) ReportPipedMeta 

func (a *PipedAPI) ReportPipedMeta(ctx context.Context, req *pipedservice.ReportPipedMetaRequest) (*pipedservice.ReportPipedMetaResponse, error)

ReportPipedMeta is sent by piped while starting up to report its metadata such as configured cloud providers.

func (*PipedAPI) ReportStageLogs 

func (a *PipedAPI) ReportStageLogs(ctx context.Context, req *pipedservice.ReportStageLogsRequest) (*pipedservice.ReportStageLogsResponse, error)

ReportStageLogs is sent by piped to save the log of a pipeline stage.

func (*PipedAPI) ReportStageLogsFromLastCheckpoint 

func (a *PipedAPI) ReportStageLogsFromLastCheckpoint(ctx context.Context, req *pipedservice.ReportStageLogsFromLastCheckpointRequest) (*pipedservice.ReportStageLogsFromLastCheckpointResponse, error)

ReportStageLogsFromLastCheckpoint is used to save the full logs from the most recently saved point.

func (*PipedAPI) ReportStageStatusChanged 

func (a *PipedAPI) ReportStageStatusChanged(ctx context.Context, req *pipedservice.ReportStageStatusChangedRequest) (*pipedservice.ReportStageStatusChangedResponse, error)

ReportStageStatusChanged used by piped to update the status of a specific stage of a deployment.

func (*PipedAPI) SaveDeploymentMetadata 

func (a *PipedAPI) SaveDeploymentMetadata(ctx context.Context, req *pipedservice.SaveDeploymentMetadataRequest) (*pipedservice.SaveDeploymentMetadataResponse, error)

SaveDeploymentMetadata used by piped to persist the metadata of a specific deployment.

func (*PipedAPI) SaveStageMetadata 

func (a *PipedAPI) SaveStageMetadata(ctx context.Context, req *pipedservice.SaveStageMetadataRequest) (*pipedservice.SaveStageMetadataResponse, error)

SaveStageMetadata used by piped to persist the metadata of a specific stage of a deployment.

type WebAPI 

type WebAPI struct {
	// contains filtered or unexported fields
}

WebAPI implements the behaviors for the gRPC definitions of WebAPI.

func NewWebAPI 

func NewWebAPI(
	ctx context.Context,
	ds datastore.DataStore,
	sls stagelogstore.Store,
	alss applicationlivestatestore.Store,
	cmds commandstore.Store,
	projs map[string]config.ControlPlaneProject,
	encrypter encrypter,
	logger *zap.Logger) *WebAPI

NewWebAPI creates a new WebAPI instance.

func (*WebAPI) AddApplication 

func (a *WebAPI) AddApplication(ctx context.Context, req *webservice.AddApplicationRequest) (*webservice.AddApplicationResponse, error)

TODO: Validate the specified piped to ensure that it belongs to the specified environment.

func (*WebAPI) AddEnvironment 

func (a *WebAPI) AddEnvironment(ctx context.Context, req *webservice.AddEnvironmentRequest) (*webservice.AddEnvironmentResponse, error)

func (*WebAPI) ApproveStage 

func (a *WebAPI) ApproveStage(ctx context.Context, req *webservice.ApproveStageRequest) (*webservice.ApproveStageResponse, error)

func (*WebAPI) CancelDeployment 

func (a *WebAPI) CancelDeployment(ctx context.Context, req *webservice.CancelDeploymentRequest) (*webservice.CancelDeploymentResponse, error)

func (*WebAPI) DisableApplication 

func (a *WebAPI) DisableApplication(ctx context.Context, req *webservice.DisableApplicationRequest) (*webservice.DisableApplicationResponse, error)

func (*WebAPI) DisablePiped 

func (a *WebAPI) DisablePiped(ctx context.Context, req *webservice.DisablePipedRequest) (*webservice.DisablePipedResponse, error)

func (*WebAPI) DisableStaticAdmin 

func (a *WebAPI) DisableStaticAdmin(ctx context.Context, req *webservice.DisableStaticAdminRequest) (*webservice.DisableStaticAdminResponse, error)

DisableStaticAdmin disables static admin login.

func (*WebAPI) EnableApplication 

func (a *WebAPI) EnableApplication(ctx context.Context, req *webservice.EnableApplicationRequest) (*webservice.EnableApplicationResponse, error)

func (*WebAPI) EnablePiped 

func (a *WebAPI) EnablePiped(ctx context.Context, req *webservice.EnablePipedRequest) (*webservice.EnablePipedResponse, error)

func (*WebAPI) EnableStaticAdmin 

func (a *WebAPI) EnableStaticAdmin(ctx context.Context, req *webservice.EnableStaticAdminRequest) (*webservice.EnableStaticAdminResponse, error)

EnableStaticAdmin enables static admin login.

func (*WebAPI) GenerateApplicationSealedSecret 

func (a *WebAPI) GenerateApplicationSealedSecret(ctx context.Context, req *webservice.GenerateApplicationSealedSecretRequest) (*webservice.GenerateApplicationSealedSecretResponse, error)

func (*WebAPI) GetApplication 

func (a *WebAPI) GetApplication(ctx context.Context, req *webservice.GetApplicationRequest) (*webservice.GetApplicationResponse, error)

func (*WebAPI) GetApplicationLiveState 

func (a *WebAPI) GetApplicationLiveState(ctx context.Context, req *webservice.GetApplicationLiveStateRequest) (*webservice.GetApplicationLiveStateResponse, error)

func (*WebAPI) GetCommand 

func (a *WebAPI) GetCommand(ctx context.Context, req *webservice.GetCommandRequest) (*webservice.GetCommandResponse, error)

func (*WebAPI) GetDeployment 

func (a *WebAPI) GetDeployment(ctx context.Context, req *webservice.GetDeploymentRequest) (*webservice.GetDeploymentResponse, error)

func (*WebAPI) GetMe 

func (a *WebAPI) GetMe(ctx context.Context, req *webservice.GetMeRequest) (*webservice.GetMeResponse, error)

GetMe gets information about the current user.

func (*WebAPI) GetPiped 

func (a *WebAPI) GetPiped(ctx context.Context, req *webservice.GetPipedRequest) (*webservice.GetPipedResponse, error)

func (*WebAPI) GetProject 

func (a *WebAPI) GetProject(ctx context.Context, req *webservice.GetProjectRequest) (*webservice.GetProjectResponse, error)

GetProject gets the specified porject without sensitive data.

func (*WebAPI) GetStageLog 

func (a *WebAPI) GetStageLog(ctx context.Context, req *webservice.GetStageLogRequest) (*webservice.GetStageLogResponse, error)

func (*WebAPI) ListApplications 

func (a *WebAPI) ListApplications(ctx context.Context, req *webservice.ListApplicationsRequest) (*webservice.ListApplicationsResponse, error)

func (*WebAPI) ListDeploymentConfigTemplates 

func (a *WebAPI) ListDeploymentConfigTemplates(ctx context.Context, req *webservice.ListDeploymentConfigTemplatesRequest) (*webservice.ListDeploymentConfigTemplatesResponse, error)

func (*WebAPI) ListDeployments 

func (a *WebAPI) ListDeployments(ctx context.Context, req *webservice.ListDeploymentsRequest) (*webservice.ListDeploymentsResponse, error)

func (*WebAPI) ListEnvironments 

func (a *WebAPI) ListEnvironments(ctx context.Context, req *webservice.ListEnvironmentsRequest) (*webservice.ListEnvironmentsResponse, error)

func (*WebAPI) ListPipeds 

func (a *WebAPI) ListPipeds(ctx context.Context, req *webservice.ListPipedsRequest) (*webservice.ListPipedsResponse, error)

TODO: Consider using piped-stats to decide piped connection status.

func (*WebAPI) RecreatePipedKey 

func (a *WebAPI) RecreatePipedKey(ctx context.Context, req *webservice.RecreatePipedKeyRequest) (*webservice.RecreatePipedKeyResponse, error)

func (*WebAPI) Register 

func (a *WebAPI) Register(server *grpc.Server)

Register registers all handling of this service into the specified gRPC server.

func (*WebAPI) RegisterPiped 

func (a *WebAPI) RegisterPiped(ctx context.Context, req *webservice.RegisterPipedRequest) (*webservice.RegisterPipedResponse, error)

func (*WebAPI) SyncApplication 

func (a *WebAPI) SyncApplication(ctx context.Context, req *webservice.SyncApplicationRequest) (*webservice.SyncApplicationResponse, error)

func (*WebAPI) UpdateEnvironmentDesc 

func (a *WebAPI) UpdateEnvironmentDesc(ctx context.Context, req *webservice.UpdateEnvironmentDescRequest) (*webservice.UpdateEnvironmentDescResponse, error)

func (*WebAPI) UpdateProjectRBACConfig 

func (a *WebAPI) UpdateProjectRBACConfig(ctx context.Context, req *webservice.UpdateProjectRBACConfigRequest) (*webservice.UpdateProjectRBACConfigResponse, error)

UpdateProjectRBACConfig updates the sso settings.

func (*WebAPI) UpdateProjectSSOConfig 

func (a *WebAPI) UpdateProjectSSOConfig(ctx context.Context, req *webservice.UpdateProjectSSOConfigRequest) (*webservice.UpdateProjectSSOConfigResponse, error)

UpdateProjectSSOConfig updates the sso settings.

func (*WebAPI) UpdateProjectStaticAdmin 

func (a *WebAPI) UpdateProjectStaticAdmin(ctx context.Context, req *webservice.UpdateProjectStaticAdminRequest) (*webservice.UpdateProjectStaticAdminResponse, error)

UpdateProjectStaticAdmin updates the static admin user settings.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.