bservice

package
v1.2.0 Latest Latest
Warning

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

 Go to latest Published: Mar 1, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

API Actor for managing Compute Group. This actor is a final API for endusers to manage Compute Group

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BService 

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

Structure for creating request to bservice

func New 

func New(client interfaces.Caller) *BService

Builder for bservice endpoints

func (BService) Create 

func (b BService) Create(ctx context.Context, req CreateRequest) (uint64, error)

Create creates blank BasicService instance

func (BService) Delete 

func (b BService) Delete(ctx context.Context, req DeleteRequest) (bool, error)

Delete deletes BasicService instance

func (BService) Disable 

func (b BService) Disable(ctx context.Context, req DisableRequest) (bool, error)

Disable disables service. Disabling a service technically means setting model status of all computes and service itself to DISABLED and stopping all computes.

func (BService) Enable 

func (b BService) Enable(ctx context.Context, req EnableRequest) (bool, error)

Enable enables service. Enabling a service technically means setting model status of all computes and service itself to ENABLED. It does not start computes.

func (BService) Get 

func (b BService) Get(ctx context.Context, req GetRequest) (*RecordBasicService, error)

Get gets detailed specifications for the BasicService.

func (BService) GroupAdd 

func (b BService) GroupAdd(ctx context.Context, req GroupAddRequest) (uint64, error)

GroupAdd creates new Compute Group within BasicService. Compute Group is NOT started automatically, so you need to explicitly start it

func (BService) GroupComputeRemove 

func (b BService) GroupComputeRemove(ctx context.Context, req GroupComputeRemoveRequest) (bool, error)

GroupComputeRemove makes group compute remove of the Basic Service

func (BService) GroupGet 

func (b BService) GroupGet(ctx context.Context, req GroupGetRequest) (*RecordGroup, error)

GroupGet gets detailed specifications for the Compute Group

func (BService) GroupParentAdd 

func (b BService) GroupParentAdd(ctx context.Context, req GroupParentAddRequest) (bool, error)

GroupParentAdd add parent Compute Group relation to the specified Compute Group

func (BService) GroupParentRemove 

func (b BService) GroupParentRemove(ctx context.Context, req GroupParentRemoveRequest) (bool, error)

GroupParentRemove removes parent Compute Group relation to the specified Compute Group

func (BService) GroupRemove 

func (b BService) GroupRemove(ctx context.Context, req GroupRemoveRequest) (bool, error)

GroupRemove destroy the specified Compute Group

func (BService) GroupResize 

func (b BService) GroupResize(ctx context.Context, req GroupResizeRequest) (uint64, error)

GroupResize resize the group by changing the number of computes

func (BService) GroupStart 

func (b BService) GroupStart(ctx context.Context, req GroupStartRequest) (bool, error)

GroupStart starts the specified Compute Group within BasicService

func (BService) GroupStop 

func (b BService) GroupStop(ctx context.Context, req GroupStopRequest) (bool, error)

GroupStop stops the specified Compute Group within BasicService

func (BService) GroupUpdate 

func (b BService) GroupUpdate(ctx context.Context, req GroupUpdateRequest) (bool, error)

GroupUpdate updates existing Compute group within Basic Service and apply new settings to its computes as necessary

func (BService) GroupUpdateExtNet 

func (b BService) GroupUpdateExtNet(ctx context.Context, req GroupUpdateExtNetRequest) (bool, error)

GroupUpdateExtNet updates External Network settings for the group according to the new list

func (BService) GroupUpdateVINS 

func (b BService) GroupUpdateVINS(ctx context.Context, req GroupUpdateVINSRequest) (bool, error)

GroupUpdateVINS update ViNS settings for the group according to the new list

func (BService) List 

func (b BService) List(ctx context.Context, req ListRequest) (ListBasicServices, error)

List gets list BasicService instances associated with the specified Resource Group

func (BService) ListDeleted 

func (b BService) ListDeleted(ctx context.Context, req ListRequest) (ListBasicServices, error)

ListDeleted gets list deleted BasicService instances associated with the specified Resource Group

func (BService) Restore 

func (b BService) Restore(ctx context.Context, req RestoreRequest) (bool, error)

Restore restores BasicService instance

func (BService) SnapshotCreate 

func (b BService) SnapshotCreate(ctx context.Context, req SnapshotCreateRequest) (bool, error)

SnapshotCreate create snapshot of the Basic Service

func (BService) SnapshotDelete 

func (b BService) SnapshotDelete(ctx context.Context, req SnapshotDeleteRequest) (bool, error)

SnapshotDelete delete snapshot of the Basic Service

func (BService) SnapshotList 

func (b BService) SnapshotList(ctx context.Context, req SnapshotListRequest) (ListSnapshots, error)

SnapshotList gets list existing snapshots of the Basic Service

func (BService) SnapshotRollback 

func (b BService) SnapshotRollback(ctx context.Context, req SnapshotRollbackRequest) (bool, error)

SnapshotRollback rollback snapshot of the Basic Service

func (BService) Start 

func (b BService) Start(ctx context.Context, req StartRequest) (bool, error)

Start starts service. Starting a service technically means starting computes from all service groups according to group relations

func (BService) Stop 

func (b BService) Stop(ctx context.Context, req StopRequest) (bool, error)

Stop stops service. Stopping a service technically means stopping computes from all service groups

type CreateRequest 

type CreateRequest struct {
	// Name of the service
	// Required: true
	Name string `url:"name" json:"name"`

	// ID of the Resource Group where this service will be placed
	// Required: true
	RGID uint64 `url:"rgId" json:"rgId"`

	// Name of the user to deploy SSH key for. Pass empty string if no SSH key deployment is required
	// Required: false
	SSHUser string `url:"sshUser,omitempty" json:"sshUser,omitempty"`

	// SSH key to deploy for the specified user. Same key will be deployed to all computes of the service
	// Required: false
	SSHKey string `url:"sshKey,omitempty" json:"sshKey,omitempty"`
}

Request struct for BasicService

type DeleteRequest 

type DeleteRequest struct {
	// ID of the BasicService to be delete
	// Required: true
	ServiceID uint64 `url:"serviceId" json:"serviceId"`

	// If set to False, Basic service will be deleted to recycle bin. Otherwise destroyed immediately
	// Required: true
	Permanently bool `url:"permanently,omitempty" json:"permanently,omitempty"`
}

Request struct for delete basic service

type DisableRequest 

type DisableRequest struct {
	// ID of the service to disable
	// Required: true
	ServiceID uint64 `url:"serviceId" json:"serviceId"`
}

Request struct for disable service

type EnableRequest 

type EnableRequest struct {
	// ID of the service to enable
	// Required: true
	ServiceID uint64 `url:"serviceId" json:"serviceId"`
}

Request struct for disable service

type GetRequest 

type GetRequest struct {
	// ID of the service to query information
	// Required: true
	ServiceID uint64 `url:"serviceId" json:"serviceId"`
}

Request struct for get detailed information about service

type GroupAddRequest 

type GroupAddRequest struct {
	// ID of the Basic Service to add a group to
	// Required: true
	ServiceID uint64 `url:"serviceId" json:"serviceId"`

	// Name of the Compute Group to add
	// Required: true
	Name string `url:"name" json:"name"`

	// Computes number. Defines how many computes must be there in the group
	// Required: true
	Count uint64 `url:"count" json:"count"`

	// Compute CPU number. All computes in the group have the same CPU count
	// Required: true
	CPU uint64 `url:"cpu" json:"cpu"`

	// Compute RAM volume in MB. All computes in the group have the same RAM volume
	// Required: true
	RAM uint64 `url:"ram" json:"ram"`

	// Compute boot disk size in GB
	// Required: true
	Disk uint64 `url:"disk" json:"disk"`

	// OS image ID to create computes from
	// Required: true
	ImageID uint64 `url:"imageId" json:"imageId"`

	// Compute driver
	// should be one of:
	//	- KVM_X86
	//	- KVM_PPC
	// Required: true
	Driver string `url:"driver" json:"driver"`

	// Storage endpoint provider ID
	// Required: false
	SEPID uint64 `url:"sepId,omitempty" json:"sepId,omitempty"`

	// Pool to use if sepId is set, can be also empty if needed to be chosen by system
	// Required: false
	SEPPool string `url:"sepPool,omitempty" json:"sepPool,omitempty"`

	// Group role tag. Can be empty string, does not have to be unique
	// Required: false
	Role string `url:"role,omitempty" json:"role,omitempty"`

	// List of ViNSes to connect computes to
	// Required: false
	VINSes []uint64 `url:"vinses,omitempty" json:"vinses,omitempty"`

	// List of external networks to connect computes to
	// Required: false
	ExtNets []uint64 `url:"extnets,omitempty" json:"extnets,omitempty"`

	// Time of Compute Group readiness
	// Required: false
	TimeoutStart uint64 `url:"timeoutStart" json:"timeoutStart"`
}

Request struct for create new compute group within BasicService

type GroupComputeRemoveRequest 

type GroupComputeRemoveRequest struct {
	// ID of the Basic Service
	// Required: true
	ServiceID uint64 `url:"serviceId" json:"serviceId"`

	// ID of the Compute GROUP
	// Required: true
	CompGroupID uint64 `url:"compgroupId" json:"compgroupId"`

	// ID of the Compute
	// Required: true
	ComputeID uint64 `url:"computeId" json:"computeId"`
}

Request struct for remove group compute

type GroupGetRequest 

type GroupGetRequest struct {
	// ID of the Basic Service of Compute Group
	// Required: true
	ServiceID uint64 `url:"serviceId" json:"serviceId"`

	// ID of the Compute Group
	// Required: true
	CompGroupID uint64 `url:"compgroupId" json:"compgroupId"`
}

Request struct for get detailed information about Compute Group

type GroupParentAddRequest 

type GroupParentAddRequest struct {
	// ID of the Basic Service of Compute Group
	// Required: true
	ServiceID uint64 `url:"serviceId" json:"serviceId"`

	// ID of the Compute Group
	// Required: true
	CompGroupID uint64 `url:"compgroupId" json:"compgroupId"`

	// ID of the parent Compute Group to register with the current Compute Group
	// Required: true
	ParentID uint64 `url:"parentId" json:"parentId"`
}

Request struct for add parent Compute Group relation emove parent Compute Group relation to the specified Compute Group

type GroupParentRemoveRequest 

type GroupParentRemoveRequest struct {
	// ID of the Basic Service of Compute Group
	// Required: true
	ServiceID uint64 `url:"serviceId" json:"serviceId"`

	// ID of the Compute Group
	// Required: true
	CompGroupID uint64 `url:"compgroupId" json:"compgroupId"`

	// ID of the parent Compute Group
	// to remove from the current Compute Group
	// Required: true
	ParentID uint64 `url:"parentId" json:"parentId"`
}

Request struct for remove parent Compute Group relation to the specified Compute Group

type GroupRemoveRequest 

type GroupRemoveRequest struct {
	// ID of the Basic Service of Compute Group
	// Required: true
	ServiceID uint64 `url:"serviceId" json:"serviceId"`

	// ID of the Compute Group
	// Required: true
	CompGroupID uint64 `url:"compgroupId" json:"compgroupId"`
}

Request struct for destroy the specified Compute Group

type GroupResizeRequest 

type GroupResizeRequest struct {
	// ID of the Basic Service of Compute Group
	// Required: true
	ServiceID uint64 `url:"serviceId" json:"serviceId"`

	// ID of the Compute Group to resize
	// Required: true
	CompGroupID uint64 `url:"compgroupId" json:"compgroupId"`

	// Either delta or absolute value of computes
	// Required: true
	Count int64 `url:"count" json:"count"`

	// Either delta or absolute value of computes
	// Should be one of:
	//	- ABSOLUTE
	//	- RELATIVE
	// Required: true
	Mode string `url:"mode" json:"mode"`
}

Request struct for resize the group

type GroupStartRequest 

type GroupStartRequest struct {
	// ID of the Basic Service of Compute Group
	// Required: true
	ServiceID uint64 `url:"serviceId" json:"serviceId"`

	// ID of the Compute Group to start
	// Required: true
	CompGroupID uint64 `url:"compgroupId" json:"compgroupId"`
}

Request struct for start the specified Compute Group

type GroupStopRequest 

type GroupStopRequest struct {
	// ID of the Basic Service of Compute Group
	// Required: true
	ServiceID uint64 `url:"serviceId" json:"serviceId"`

	// ID of the Compute Group to stop
	// Required: true
	CompGroupID uint64 `url:"compgroupId" json:"compgroupId"`

	// Force stop Compute Group
	// Required: true
	Force bool `url:"force,omitempty" json:"force,omitempty"`
}

Request struct for stop the specified Compute Group

type GroupUpdateExtNetRequest 

type GroupUpdateExtNetRequest struct {
	// ID of the Basic Service of Compute Group
	// Required: true
	ServiceID uint64 `url:"serviceId" json:"serviceId"`

	// ID of the Compute Group
	// Required: true
	CompGroupID uint64 `url:"compgroupId" json:"compgroupId"`

	// List of Extnets to connect computes
	// Required: false
	ExtNets []uint64 `url:"extnets,omitempty" json:"extnets,omitempty"`
}

Request struct for update External Network settings

type GroupUpdateRequest 

type GroupUpdateRequest struct {
	// ID of the Basic Service of Compute Group
	// Required: true
	ServiceID uint64 `url:"serviceId" json:"serviceId"`

	// ID of the Compute Group
	// Required: true
	CompGroupID uint64 `url:"compgroupId" json:"compgroupId"`

	// Specify non-empty string to update Compute Group name
	// Required: false
	Name string `url:"name,omitempty" json:"name,omitempty"`

	// Specify non-empty string to update group role
	// Required: false
	Role string `url:"role,omitempty" json:"role,omitempty"`

	// Specify positive value to set new compute CPU count
	// Required: false
	CPU uint64 `url:"cpu,omitempty" json:"cpu,omitempty"`

	// Specify positive value to set new compute RAM volume in MB
	// Required: false
	RAM uint64 `url:"ram,omitempty" json:"ram,omitempty"`

	// Specify new compute boot disk size in GB
	// Required: false
	Disk uint64 `url:"disk,omitempty" json:"disk,omitempty"`

	// Force resize Compute Group
	// Required: false
	Force bool `url:"force,omitempty" json:"force,omitempty"`
}

Request struct for update existing Compute group

type GroupUpdateVINSRequest 

type GroupUpdateVINSRequest struct {
	// ID of the Basic Service of Compute Group
	// Required: true
	ServiceID uint64 `url:"serviceId" json:"serviceId"`

	// ID of the Compute Group
	// Required: true
	CompGroupID uint64 `url:"compgroupId" json:"compgroupId"`

	// List of ViNSes to connect computes
	// Required: false
	VINSes []uint64 `url:"vinses,omitempty" json:"vinses,omitempty"`
}

Request struct for update VINS settings

type ItemBasicService 

type ItemBasicService struct {
	// Account ID
	AccountID uint64 `json:"accountId"`

	// Account name
	AccountName string `json:"accountName"`

	// Base domain
	BaseDomain string `json:"baseDomain"`

	// Created by
	CreatedBy string `json:"createdBy"`

	// Created time
	CreatedTime uint64 `json:"createdTime"`

	// Deleted by
	DeletedBy string `json:"deletedBy"`

	// Deleted time
	DeletedTime uint64 `json:"deletedTime"`

	// Grid ID
	GID uint64 `json:"gid"`

	// List of group IDs
	Groups []uint64 `json:"groups"`

	// GUID
	GUID uint64 `json:"guid"`

	// ID
	ID uint64 `json:"id"`

	// Name
	Name string `json:"name"`

	// Parent service ID
	ParentSrvID uint64 `json:"parentSrvId"`

	// Parent service type
	ParentSrvType string `json:"parentSrvType"`

	// Resource group ID
	RGID uint64 `json:"rgId"`

	// Resource group name
	RGName string `json:"rgName"`

	// SSH user
	SSHUser string `json:"sshUser"`

	// Status
	Status string `json:"status"`

	// TechStatus
	TechStatus string `json:"techStatus"`

	// Updated by
	UpdatedBy string `json:"updatedBy"`

	// Updated time
	UpdatedTime uint64 `json:"updatedTime"`

	// User Managed or not
	UserManaged bool `json:"userManaged"`
}

Main information about BasicService

type ItemCompute 

type ItemCompute struct {
	// Compute group ID
	CompGroupID uint64 `json:"compgroupId"`

	// Compute group name
	CompGroupName string `json:"compgroupName"`

	// compute group role
	CompGroupRole string `json:"compgroupRole"`

	// ID
	ID uint64 `json:"id"`

	// Name
	Name string `json:"name"`
}

Main information about Compute

type ItemGroupCompute 

type ItemGroupCompute struct {
	// ID
	ID uint64 `json:"id"`

	// IP Addresses
	IPAddresses []string `json:"ipAddresses"`

	// Name
	Name string `json:"name"`

	// List of information about OS Users
	OSUsers ListOSUsers `json:"osUsers"`
}

Main information about Group Compute

type ItemOSUser 

type ItemOSUser struct {
	// Login
	Login string `json:"login"`

	// Password
	Password string `json:"password"`
}

Main information about OS User

type ItemSnapshot 

type ItemSnapshot struct {
	// GUID
	GUID string `json:"guid"`

	// Label
	Label string `json:"label"`

	// Timestamp
	Timestamp uint64 `json:"timestamp"`

	// Valid or not
	Valid bool `json:"valid"`
}

Main information about Snapshot

type ListBasicServices 

type ListBasicServices []ItemBasicService

List of BasicServices

type ListComputes 

type ListComputes []ItemCompute

List of Computes

type ListGroupComputes 

type ListGroupComputes []ItemGroupCompute

List of Group Computes

type ListOSUsers 

type ListOSUsers []ItemOSUser

List of information about OS Users

type ListRequest 

type ListRequest struct {
	// ID of the account to query for BasicService instances
	// Required: false
	AccountID uint64 `url:"accountId,omitempty" json:"accountId,omitempty"`

	// ID of the resource group to query for BasicService instances
	// Required: false
	RGID uint64 `url:"rgId,omitempty" json:"rgId,omitempty"`

	// Page number
	// Required: false
	Page uint64 `url:"page,omitempty" json:"page,omitempty"`

	// Page size
	// Required: false
	Size uint64 `url:"size,omitempty" json:"size,omitempty"`
}

Request struct for get list/deleted list BasicService instances

type ListSnapshots 

type ListSnapshots []ItemSnapshot

List of Snapshots

type RecordBasicService 

type RecordBasicService struct {
	// Account ID
	AccountID uint64 `json:"accountId"`

	// Account name
	AccountName string `json:"accountName"`

	// Base domain
	BaseDomain string `json:"baseDomain"`

	// List Computes
	Computes ListComputes `json:"computes"`

	// Number of cores
	CPUTotal uint64 `json:"cpuTotal"`

	// Created by
	CreatedBy string `json:"createdBy"`

	// Created time
	CreatedTime uint64 `json:"createdTime"`

	// Deleted by
	DeletedBy string `json:"deletedBy"`

	// Deleted time
	DeletedTime uint64 `json:"deletedTime"`

	// Amount of disk space used, GB
	DiskTotal uint64 `json:"diskTotal"`

	// Grid ID
	GID uint64 `json:"gid"`

	// List of Service Compute Group IDs
	Groups []uint64 `json:"groups"`

	// List of compute groups by name
	GroupsName []string `json:"groupsName"`

	// GUID
	GUID uint64 `json:"guid"`

	// ID
	ID uint64 `json:"id"`

	// Milestones
	Milestones uint64 `json:"milestones"`

	// Name
	Name string `json:"name"`

	// Parent service ID
	ParentSrvID uint64 `json:"parentSrvId"`

	// Parent service type
	ParentSrvType string `json:"parentSrvType"`

	// Total amount of RAM, MB
	RAMTotal uint64 `json:"ramTotal"`

	// Resource group ID
	RGID uint64 `json:"rgId"`

	// Resource group name
	RGName string `json:"rgName"`

	// List of snapshots
	Snapshots ListSnapshots `json:"snapshots"`

	// SSH key for connection
	SSHKey string `json:"sshKey"`

	// Username for SSH connection
	SSHUser string `json:"sshUser"`

	// status
	Status string `json:"status"`

	// TechStatus
	TechStatus string `json:"techStatus"`

	// Updated by
	UpdatedBy string `json:"updatedBy"`

	// Updated time
	UpdatedTime uint64 `json:"updatedTime"`

	// Whether user controlled
	UserManaged bool `json:"userManaged"`
}

Detailed info about BasicService

type RecordGroup 

type RecordGroup struct {
	// Account ID
	AccountID uint64 `json:"accountId"`

	// Account Name
	AccountName string `json:"accountName"`

	// List of Computes
	Computes ListGroupComputes `json:"computes"`

	// Consistency or not
	Consistency bool `json:"consistency"`

	// Number of CPU
	CPU uint64 `json:"cpu"`

	// Created by
	CreatedBy string `json:"createdBy"`

	// Created time
	CreatedTime uint64 `json:"createdTime"`

	// Deleted by
	DeletedBy string `json:"deletedBy"`

	// Deleted time
	DeletedTime uint64 `json:"deletedTime"`

	// Amount of disk
	Disk uint64 `json:"disk"`

	// Driver
	Driver string `json:"driver"`

	// list of External Network IDs
	ExtNets []uint64 `json:"extnets"`

	// Grid ID
	GID uint64 `json:"gid"`

	// GUID
	GUID uint64 `json:"guid"`

	// ID
	ID uint64 `json:"id"`

	// Image ID
	ImageID uint64 `json:"imageId"`

	// Milestones
	Milestones uint64 `json:"milestones"`

	// Name
	Name string `json:"name"`

	// List of Parent IDs
	Parents []uint64 `json:"parents"`

	// Pool name
	PoolName string `json:"poolName"`

	// Number of RAM, MB
	RAM uint64 `json:"ram"`

	// Resource group ID
	RGID uint64 `json:"rgId"`

	// Resource group name
	RGName string `json:"rgName"`

	// Role
	Role string `json:"role"`

	// SEPID
	SEPID uint64 `json:"sepId"`

	// Sequence number
	SeqNo uint64 `json:"seqNo"`

	// Service ID
	ServiceID uint64 `json:"serviceId"`

	// Status
	Status string `json:"status"`

	// TechStatus
	TechStatus string `json:"techStatus"`

	// Timeout Start
	TimeoutStart uint64 `json:"timeoutStart"`

	// Updated by
	UpdatedBy string `json:"updatedBy"`

	// Updated time
	UpdatedTime uint64 `json:"updatedTime"`

	// List of VINS IDs
	VINSes []uint64 `json:"vinses"`
}

Main information about Group

type RestoreRequest 

type RestoreRequest struct {
	// ID of the BasicService to be restored
	// Required: true
	ServiceID uint64 `url:"serviceId" json:"serviceId"`
}

Request struct for restores BasicService instance

type SnapshotCreateRequest 

type SnapshotCreateRequest struct {
	// ID of the Basic Service
	// Required: true
	ServiceID uint64 `url:"serviceId" json:"serviceId"`

	// Label of the snapshot
	// Required: true
	Label string `url:"label" json:"label"`
}

Request struct for create snapshot

type SnapshotDeleteRequest 

type SnapshotDeleteRequest struct {
	// ID of the Basic Service
	// Required: true
	ServiceID uint64 `url:"serviceId" json:"serviceId"`

	// Label of the snapshot
	// Required: true
	Label string `url:"label" json:"label"`
}

Request struct for delete snapshot

type SnapshotListRequest 

type SnapshotListRequest struct {
	// ID of the Basic Service
	// Required: true
	ServiceID uint64 `url:"serviceId" json:"serviceId"`
}

Request struct for get list existing snapshots

type SnapshotRollbackRequest 

type SnapshotRollbackRequest struct {
	// ID of the Basic Service
	// Required: true
	ServiceID uint64 `url:"serviceId" json:"serviceId"`

	// Label of the snapshot
	// Required: true
	Label string `url:"label" json:"label"`
}

Request struct for rollback snapshot

type StartRequest 

type StartRequest struct {
	// ID of the service to start
	// Required: true
	ServiceID uint64 `url:"serviceId" json:"serviceId"`
}

Request struct for start service

type StopRequest 

type StopRequest struct {
	// ID of the service to stop
	// Required: true
	ServiceID uint64 `url:"serviceId" json:"serviceId"`
}

Request struct for stop service

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.