armada

Documentation

Index

• Constants
• type Service
  • func NewService(scope *actuators.Scope) *Service
  • func (s *Service) CreateOrUpdateNetworkSecurityGroup(resourceGroupName string, networkSecurityGroupName string, location string) (*armada.SecurityGroupsCreateOrUpdateFuture, error)
  • func (s *Service) CreateOrUpdateVnet(resourceGroupName string, virtualNetworkName string, location string) (*armada.VirtualNetworksCreateOrUpdateFuture, error)
  • func (s *Service) DeleteNetworkInterface(resourceGroup string, networkInterfaceName string) (armada.InterfacesDeleteFuture, error)
  • func (s *Service) DeleteNetworkSecurityGroup(resourceGroupName string, networkSecurityGroupName string) (armada.SecurityGroupsDeleteFuture, error)
  • func (s *Service) DeletePublicIPAddress(resourceGroup string, IPName string) (armada.PublicIPAddressesDeleteFuture, error)
  • func (s *Service) GetPublicIPAddress(resourceGroup string, IPName string) (armada.PublicIPAddress, error)
  • func (s *Service) NetworkSGIfExists(resourceGroupName string, networkSecurityGroupName string) (*armada.SecurityGroup, error)
  • func (s *Service) WaitForNetworkInterfacesDeleteFuture(future armada.InterfacesDeleteFuture) error
  • func (s *Service) WaitForNetworkSGsCreateOrUpdateFuture(future armada.SecurityGroupsCreateOrUpdateFuture) error
  • func (s *Service) WaitForPublicIPAddressDeleteFuture(future armada.PublicIPAddressesDeleteFuture) error
  • func (s *Service) WaitForVnetCreateOrUpdateFuture(future armada.VirtualNetworksCreateOrUpdateFuture) error

Constants

const (
	// VnetDefaultName is the default name for the cluster's virtual armada.
	VnetDefaultName = "ClusterAPIVnet"
	// SubnetDefaultName is the default name for the cluster's subnet.
	SubnetDefaultName = "ClusterAPISubnet"

	// SecurityGroupDefaultName is the default name for the network security group of the cluster.
	SecurityGroupDefaultName = "ClusterAPINSG"
)

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) CreateOrUpdateNetworkSecurityGroup

func (s *Service) CreateOrUpdateNetworkSecurityGroup(resourceGroupName string, networkSecurityGroupName string, location string) (*armada.SecurityGroupsCreateOrUpdateFuture, error)

CreateOrUpdateNetworkSecurityGroup creates or updates the nsg resource.

func (*Service) CreateOrUpdateVnet

func (s *Service) CreateOrUpdateVnet(resourceGroupName string, virtualNetworkName string, location string) (*armada.VirtualNetworksCreateOrUpdateFuture, error)

CreateOrUpdateVnet creates or updates a virtual network resource.

func (*Service) DeleteNetworkInterface

func (s *Service) DeleteNetworkInterface(resourceGroup string, networkInterfaceName string) (armada.InterfacesDeleteFuture, error)

DeleteNetworkInterface deletes the NIC resource.

func (*Service) DeleteNetworkSecurityGroup

func (s *Service) DeleteNetworkSecurityGroup(resourceGroupName string, networkSecurityGroupName string) (armada.SecurityGroupsDeleteFuture, error)

DeleteNetworkSecurityGroup deletes the nsg resource.

func (*Service) DeletePublicIPAddress

func (s *Service) DeletePublicIPAddress(resourceGroup string, IPName string) (armada.PublicIPAddressesDeleteFuture, error)

DeletePublicIPAddress deletes the Public IP address resource.

func (*Service) GetPublicIPAddress

func (s *Service) GetPublicIPAddress(resourceGroup string, IPName string) (armada.PublicIPAddress, error)

GetPublicIPAddress retrieves the Public IP address resource.

func (*Service) NetworkSGIfExists

func (s *Service) NetworkSGIfExists(resourceGroupName string, networkSecurityGroupName string) (*armada.SecurityGroup, error)

NetworkSGIfExists returns the nsg reference if the nsg resource exists.

func (*Service) WaitForNetworkInterfacesDeleteFuture

func (s *Service) WaitForNetworkInterfacesDeleteFuture(future armada.InterfacesDeleteFuture) error

WaitForNetworkInterfacesDeleteFuture waits for the DeleteNetworkInterface operation to complete.

func (*Service) WaitForNetworkSGsCreateOrUpdateFuture

func (s *Service) WaitForNetworkSGsCreateOrUpdateFuture(future armada.SecurityGroupsCreateOrUpdateFuture) error

WaitForNetworkSGsCreateOrUpdateFuture returns when the CreateOrUpdateNetworkSecurityGroup operation completes.

func (*Service) WaitForPublicIPAddressDeleteFuture

func (s *Service) WaitForPublicIPAddressDeleteFuture(future armada.PublicIPAddressesDeleteFuture) error

WaitForPublicIPAddressDeleteFuture waits for the DeletePublicIPAddress operation to complete.

func (*Service) WaitForVnetCreateOrUpdateFuture

func (s *Service) WaitForVnetCreateOrUpdateFuture(future armada.VirtualNetworksCreateOrUpdateFuture) error

WaitForVnetCreateOrUpdateFuture returns when the CreateOrUpdateVnet operation completes.