groups

Documentation

Index

• Constants
• type GroupScope
• type GroupSpec
  • func (s *GroupSpec) OwnerResourceName() string
  • func (s *GroupSpec) Parameters(existing interface{}) (params interface{}, err error)
  • func (s *GroupSpec) ResourceGroupName() string
  • func (s *GroupSpec) ResourceName() string
• type Service
  • func New(scope GroupScope) *Service
  • func (s *Service) Delete(ctx context.Context) error
  • func (s *Service) IsManaged(ctx context.Context) (bool, error)
  • func (s *Service) Name() string
  • func (s *Service) Reconcile(ctx context.Context) error

Constants

const ServiceName = "group"

ServiceName is the name of this service.

Types

type GroupScope

type GroupScope interface {
	azure.Authorizer
	azure.AsyncStatusUpdater
	GroupSpec() azure.ResourceSpecGetter
	ClusterName() string
}

GroupScope defines the scope interface for a group service.

type GroupSpec

type GroupSpec struct {
	Name           string
	Location       string
	ClusterName    string
	AdditionalTags infrav1.Tags
}

GroupSpec defines the specification for a Resource Group.

func (*GroupSpec) OwnerResourceName

func (s *GroupSpec) OwnerResourceName() string

OwnerResourceName is a no-op for groups.

func (*GroupSpec) Parameters

func (s *GroupSpec) Parameters(existing interface{}) (params interface{}, err error)

Parameters returns the parameters for the group.

func (*GroupSpec) ResourceGroupName

func (s *GroupSpec) ResourceGroupName() string

ResourceGroupName returns the name of the group. Note that it is the same as the resource name in this case.

func (*GroupSpec) ResourceName

func (s *GroupSpec) ResourceName() string

ResourceName returns the name of the group.

type Service

type Service struct {
	Scope GroupScope
	async.Reconciler
	// contains filtered or unexported fields
}

Service provides operations on Azure resources.

func New

func New(scope GroupScope) *Service

New creates a new service.

func (*Service) Delete

func (s *Service) Delete(ctx context.Context) error

Delete deletes the resource group if it is managed by capz.

func (*Service) IsManaged

func (s *Service) IsManaged(ctx context.Context) (bool, error)

IsManaged returns true if the resource group has an owned tag with the cluster name as value, meaning that the resource group's lifecycle is managed.

func (*Service) Name

func (s *Service) Name() string

Name returns the service name.

func (*Service) Reconcile

func (s *Service) Reconcile(ctx context.Context) error

Reconcile gets/creates/updates a resource group.