deckhand

Documentation

Index

• func GetNetworkInterfaceName(machine *clusterv1.Machine) string
• func GetOSDiskName(machine *clusterv1.Machine) string
• func GetPublicIPName(machine *clusterv1.Machine) string
• func GetVMName(machine *clusterv1.Machine) string
• func ResourceName(id string) (string, error)
• type Service
  • func NewService(scope *actuators.Scope) *Service
  • func (s *Service) CheckGroupExistence(resourceGroupName string) (autorest.Response, error)
  • func (s *Service) CreateOrUpdateDeployment(machine *clusterv1.Machine, ...) (*deckhand.DeploymentsCreateOrUpdateFuture, error)
  • func (s *Service) CreateOrUpdateGroup(resourceGroupName string, location string) (deckhand.Group, error)
  • func (s *Service) DeleteGroup(resourceGroupName string) (deckhand.GroupsDeleteFuture, error)
  • func (s *Service) GetDeploymentResult(future deckhand.DeploymentsCreateOrUpdateFuture) (de deckhand.DeploymentExtended, err error)
  • func (s *Service) ValidateDeployment(machine *clusterv1.Machine, ...) error
  • func (s *Service) WaitForDeploymentsCreateOrUpdateFuture(future deckhand.DeploymentsCreateOrUpdateFuture) error
  • func (s *Service) WaitForGroupsDeleteFuture(future deckhand.GroupsDeleteFuture) error

Functions

func GetNetworkInterfaceName

func GetNetworkInterfaceName(machine *clusterv1.Machine) string

GetNetworkInterfaceName returns the nic resource name of the machine.

func GetOSDiskName

func GetOSDiskName(machine *clusterv1.Machine) string

GetOSDiskName returns the OS disk resource name of the machine.

func GetPublicIPName

func GetPublicIPName(machine *clusterv1.Machine) string

GetPublicIPName returns the public IP resource name of the machine.

func GetVMName

func GetVMName(machine *clusterv1.Machine) string

GetVMName returns the VM resource name of the machine.

func ResourceName

func ResourceName(id string) (string, error)

ResourceName extracts the name of the resource from its ID.

Types

type Service

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

Service holds a collection of interfaces. The interfaces are broken down like this to group functions together. One alternative is to have a large list of functions from the ec2 client.

func NewService

func NewService(scope *actuators.Scope) *Service

NewService returns a new service given the api clients.

func (*Service) CheckGroupExistence

func (s *Service) CheckGroupExistence(resourceGroupName string) (autorest.Response, error)

CheckGroupExistence checks oif the resource group exists or not.

func (*Service) CreateOrUpdateDeployment

func (s *Service) CreateOrUpdateDeployment(machine *clusterv1.Machine, clusterConfig *providerv1.AirshipClusterProviderSpec, machineConfig *providerv1.AirshipMachineProviderSpec) (*deckhand.DeploymentsCreateOrUpdateFuture, error)

CreateOrUpdateDeployment is used to create or update a kubernetes cluster. It does so by creating or updating an ARM deployment.

func (*Service) CreateOrUpdateGroup

func (s *Service) CreateOrUpdateGroup(resourceGroupName string, location string) (deckhand.Group, error)

CreateOrUpdateGroup creates or updates an airship resource group.

func (*Service) DeleteGroup

func (s *Service) DeleteGroup(resourceGroupName string) (deckhand.GroupsDeleteFuture, error)

DeleteGroup deletes an airship resource group.

func (*Service) GetDeploymentResult

func (s *Service) GetDeploymentResult(future deckhand.DeploymentsCreateOrUpdateFuture) (de deckhand.DeploymentExtended, err error)

GetDeploymentResult retrieves the result of the ARM deployment operation.

func (*Service) ValidateDeployment

func (s *Service) ValidateDeployment(machine *clusterv1.Machine, clusterConfig *providerv1.AirshipClusterProviderSpec, machineConfig *providerv1.AirshipMachineProviderSpec) error

ValidateDeployment validates the parameters of the cluster by calling the ARM validate method.

func (*Service) WaitForDeploymentsCreateOrUpdateFuture

func (s *Service) WaitForDeploymentsCreateOrUpdateFuture(future deckhand.DeploymentsCreateOrUpdateFuture) error

WaitForDeploymentsCreateOrUpdateFuture returns when the ARM operation completes.

func (*Service) WaitForGroupsDeleteFuture

func (s *Service) WaitForGroupsDeleteFuture(future deckhand.GroupsDeleteFuture) error

WaitForGroupsDeleteFuture returns when the DeleteGroup operation completes.