groups

Documentation

Index

• Constants
• type GroupScope
• type GroupSpec
  • func (s *GroupSpec) GetActualTags(resource genruntime.MetaObject) (infrav1.Tags, error)
  • func (s *GroupSpec) GetAdditionalTags() infrav1.Tags
  • func (s *GroupSpec) GetDesiredTags(resource genruntime.MetaObject) (infrav1.Tags, error)
  • func (s *GroupSpec) Parameters(ctx context.Context, object genruntime.MetaObject) (genruntime.MetaObject, error)
  • func (s *GroupSpec) ResourceRef() genruntime.MetaObject
  • func (s *GroupSpec) SetTags(resource genruntime.MetaObject, tags infrav1.Tags) error
  • func (s *GroupSpec) WasManaged(object genruntime.MetaObject) bool
• 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) Pause(ctx context.Context) error
  • func (s *Service) Reconcile(ctx context.Context) error
  • func (s *Service) ShouldDeleteIndividualResources(ctx context.Context) bool

Constants

const ServiceName = "group"

ServiceName is the name of this service.

Types

type GroupScope

type GroupScope interface {
	azure.AsyncStatusUpdater
	GroupSpec() azure.ASOResourceSpecGetter
	GetClient() client.Client
	ClusterName() string
}

GroupScope defines the scope interface for a group service.

type GroupSpec

type GroupSpec struct {
	Name           string
	Namespace      string
	Location       string
	ClusterName    string
	AdditionalTags infrav1.Tags
	Owner          metav1.OwnerReference
}

GroupSpec defines the specification for a Resource Group.

func (*GroupSpec) GetActualTags

func (s *GroupSpec) GetActualTags(resource genruntime.MetaObject) (infrav1.Tags, error)

GetActualTags implements aso.TagsGetterSetter.

func (*GroupSpec) GetAdditionalTags

func (s *GroupSpec) GetAdditionalTags() infrav1.Tags

GetAdditionalTags implements aso.TagsGetterSetter.

func (*GroupSpec) GetDesiredTags

func (s *GroupSpec) GetDesiredTags(resource genruntime.MetaObject) (infrav1.Tags, error)

GetDesiredTags implements aso.TagsGetterSetter.

func (*GroupSpec) Parameters

func (s *GroupSpec) Parameters(ctx context.Context, object genruntime.MetaObject) (genruntime.MetaObject, error)

Parameters implements aso.ResourceSpecGetter.

func (*GroupSpec) ResourceRef

func (s *GroupSpec) ResourceRef() genruntime.MetaObject

ResourceRef implements aso.ResourceSpecGetter.

func (*GroupSpec) SetTags

func (s *GroupSpec) SetTags(resource genruntime.MetaObject, tags infrav1.Tags) error

SetTags implements aso.TagsGetterSetter.

func (*GroupSpec) WasManaged

func (s *GroupSpec) WasManaged(object genruntime.MetaObject) bool

WasManaged implements azure.ASOResourceSpecGetter.

type Service

type Service struct {
	Scope GroupScope
	aso.Reconciler
}

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 ASO ResourceGroup was created by CAPZ, meaning that the resource group's lifecycle is managed.

func (*Service) Name

func (s *Service) Name() string

Name returns the service name.

func (*Service) Pause

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

Pause implements azure.Pauser.

func (*Service) Reconcile

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

Reconcile idempotently creates or updates a resource group.

func (*Service) ShouldDeleteIndividualResources

func (s *Service) ShouldDeleteIndividualResources(ctx context.Context) bool

ShouldDeleteIndividualResources returns false if the resource group is managed and reconciled by ASO, meaning that we can rely on a single resource group delete operation as opposed to deleting every individual resource.