crd

Documentation

Overview

Package crd contains objects used to represent Kubernetes Custom Resource Definitions (CRDs) defined by Proclaim.

Index

• Constants
• type DNSSDServiceInstance
  • func (i *DNSSDServiceInstance) DeepCopyObject() runtime.Object
• type DNSSDServiceInstanceList
  • func (l *DNSSDServiceInstanceList) DeepCopyObject() runtime.Object
• type DNSSDServiceInstanceSpec
• type DNSSDServiceInstanceStatus
• type Status

Constants

const (
	// GroupName is the API group name used by Proclaim.
	GroupName = "proclaim.dogmatiq.io"

	// FinalizerName is the name of the finalizer used by Proclaim to ensure
	// that DNS-SD services are unadvertised when they're underlying resource
	// is deleted.
	FinalizerName = GroupName + "/unadvertise"

	// Version is the version of the API/CRDs.
	Version = "v1"
)

Types

type DNSSDServiceInstance

type DNSSDServiceInstance struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   DNSSDServiceInstanceSpec   `json:"spec,omitempty"`
	Status DNSSDServiceInstanceStatus `json:"status,omitempty"`
}

DNSSDServiceInstance is a resource that represents a DNS-SD service instance.

func (*DNSSDServiceInstance) DeepCopyObject

func (i *DNSSDServiceInstance) DeepCopyObject() runtime.Object

DeepCopyObject returns a deep clone of i.

type DNSSDServiceInstanceList

type DNSSDServiceInstanceList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []DNSSDServiceInstance `json:"items"`
}

DNSSDServiceInstanceList is a list of DNS-SD service instances.

func (*DNSSDServiceInstanceList) DeepCopyObject

func (l *DNSSDServiceInstanceList) DeepCopyObject() runtime.Object

DeepCopyObject returns a deep clone of l.

type DNSSDServiceInstanceSpec

type DNSSDServiceInstanceSpec struct {
	Name       string              `json:"name"`
	Service    string              `json:"service"`
	Domain     string              `json:"domain"`
	TargetHost string              `json:"targetHost"`
	TargetPort uint16              `json:"targetPort"`
	Priority   uint16              `json:"priority,omitempty"`
	Weight     uint16              `json:"weight,omitempty"`
	Attributes []map[string]string `json:"attributes,omitempty"`
	TTL        uint16              `json:"ttl,omitempty"`
}

DNSSDServiceInstanceSpec is the specification for a service instance.

type DNSSDServiceInstanceStatus

type DNSSDServiceInstanceStatus struct {
	ProviderID          string `json:"providerId,omitempty"`
	ProviderDescription string `json:"providerDescription,omitempty"`
	AdvertiserID        string `json:"advertiserId,omitempty"`
	Status              Status `json:"status,omitempty"`
}

DNSSDServiceInstanceStatus contains the status of a service instance.

type Status

type Status string

Status is an enumeration of the possible states of a service instance.

const (
	// StatusPending indicates that none of the Proclaim controllers that have
	// reconciled the resource have been configured to advertise on its domain.
	StatusPending Status = "Pending"

	// StatusAdvertising indicates that a controller has identified where to
	// create/update the DNS records and will soon attempt to do so.
	StatusAdvertising Status = "Advertising"

	// StatusAdvertiseError indicates that there was an upstream problem with
	// the provider while attempting to advertise the service instance.
	StatusAdvertiseError Status = "AdvertiseError"

	// StatusAdvertised indicates that the service instance has been advertised
	// successfully.
	StatusAdvertised Status = "Advertised"

	// StatusUnadvertising indicates that a controller has begin to remove
	// the DNS records for the service instance.
	StatusUnadvertising Status = "Unadvertising"

	// StatusUnadvertiseError indicates that there was an upstream problem with
	// the provider while attempting to unadvertise the service instance.
	StatusUnadvertiseError Status = "UnadvertiseError"

	// StatusUnadvertised indicates that the service instance has been
	// unadvertised successfully. This status will rarely be seen as it is set
	// shortly before Kubernetes deletes the resource entirely.
	StatusUnadvertised Status = "Unadvertised"
)