Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

v1

package

Go to main page

Versions in this module

v1

v1.0.1

Dec 5, 2024

v1.0.0

Nov 28, 2024

v1.0.0-rc9

Nov 25, 2024

v1.0.0-rc8

Nov 22, 2024

v1.0.0-rc7

Nov 22, 2024

v1.0.0-rc6

Nov 19, 2024

v1.0.0-rc5

Nov 19, 2024

v1.0.0-rc4

Nov 12, 2024

v1.0.0-rc3

Nov 12, 2024

v1.0.0-rc2

Nov 12, 2024

v1.0.0-rc10

Nov 26, 2024

v1.0.0-rc1

Nov 11, 2024

v0

v0.0.100

Nov 12, 2024

Changes in this version

+ const AtomicMergeStrategy

+ const GroupName

+ const PolicyRuleMergeStrategy

+ var AddToScheme = SchemeBuilder.AddToScheme

+ var AuthPoliciesResource = GroupVersion.WithResource("authpolicies")

+ var AuthPolicyGroupKind = schema.GroupKind

+ var DNSPoliciesResource = GroupVersion.WithResource("dnspolicies")

+ var DNSPolicyGroupKind = schema.GroupKind

+ var GroupVersion = schema.GroupVersion

+ var RateLimitPoliciesResource = GroupVersion.WithResource("ratelimitpolicies")

+ var RateLimitPolicyGroupKind = schema.GroupKind

+ var RulesKeyTopLevelPredicates = "###_TOP_LEVEL_PREDICATES_###"

+ var SchemeBuilder = &scheme.Builder

+ var TLSPoliciesResource = GroupVersion.WithResource("tlspolicies")

+ var TLSPolicyGroupKind = schema.GroupKind

+ func AtomicDefaultsMergeStrategy(source, target machinery.Policy) machinery.Policy

+ func AtomicOverridesMergeStrategy(source, _ machinery.Policy) machinery.Policy

+ func DefaultsMergeStrategy(strategy string) machinery.MergeStrategy

+ func EffectivePolicyForPath[T machinery.Policy](path []machinery.Targetable, predicate func(machinery.Policy) bool) *T

+ func OverridesMergeStrategy(strategy string) machinery.MergeStrategy

+ func PathID(path []machinery.Targetable) string

+ func PoliciesInPath(path []machinery.Targetable, predicate func(machinery.Policy) bool) []machinery.Policy

+ func PolicyRuleDefaultsMergeStrategy(source, target machinery.Policy) machinery.Policy

+ func PolicyRuleOverridesMergeStrategy(source, target machinery.Policy) machinery.Policy

+ type AuthPolicy struct

+ Spec AuthPolicySpec

+ Status AuthPolicyStatus

+ func (in *AuthPolicy) DeepCopy() *AuthPolicy

+ func (in *AuthPolicy) DeepCopyInto(out *AuthPolicy)

+ func (in *AuthPolicy) DeepCopyObject() runtime.Object

+ func (p *AuthPolicy) Empty() bool

+ func (p *AuthPolicy) GetLocator() string

+ func (p *AuthPolicy) GetMergeStrategy() machinery.MergeStrategy

+ func (p *AuthPolicy) GetName() string

+ func (p *AuthPolicy) GetNamespace() string

+ func (p *AuthPolicy) GetStatus() kuadrantgatewayapi.PolicyStatus

+ func (p *AuthPolicy) GetTargetRef() gatewayapiv1alpha2.LocalPolicyTargetReference

+ func (p *AuthPolicy) GetTargetRefs() []machinery.PolicyTargetReference

+ func (p *AuthPolicy) Kind() string

+ func (p *AuthPolicy) Merge(other machinery.Policy) machinery.Policy

+ func (p *AuthPolicy) Rules() map[string]MergeableRule

+ func (p *AuthPolicy) SetRules(rules map[string]MergeableRule)

+ type AuthPolicyList struct

+ Items []AuthPolicy

+ func (in *AuthPolicyList) DeepCopy() *AuthPolicyList

+ func (in *AuthPolicyList) DeepCopyInto(out *AuthPolicyList)

+ func (in *AuthPolicyList) DeepCopyObject() runtime.Object

+ type AuthPolicySpec struct

+ Defaults *MergeableAuthPolicySpec

+ Overrides *MergeableAuthPolicySpec

+ TargetRef gatewayapiv1alpha2.LocalPolicyTargetReferenceWithSectionName

+ func (in *AuthPolicySpec) DeepCopy() *AuthPolicySpec

+ func (in *AuthPolicySpec) DeepCopyInto(out *AuthPolicySpec)

+ func (s *AuthPolicySpec) Proper() *AuthPolicySpecProper

+ type AuthPolicySpecProper struct

+ AuthScheme *AuthSchemeSpec

+ NamedPatterns map[string]MergeablePatternExpressions

+ func (in *AuthPolicySpecProper) DeepCopy() *AuthPolicySpecProper

+ func (in *AuthPolicySpecProper) DeepCopyInto(out *AuthPolicySpecProper)

+ type AuthPolicyStatus struct

+ Conditions []metav1.Condition

+ ObservedGeneration int64

+ func (in *AuthPolicyStatus) DeepCopy() *AuthPolicyStatus

+ func (in *AuthPolicyStatus) DeepCopyInto(out *AuthPolicyStatus)

+ func (s *AuthPolicyStatus) Equals(other *AuthPolicyStatus, logger logr.Logger) bool

+ func (s *AuthPolicyStatus) GetConditions() []metav1.Condition

+ type AuthSchemeSpec struct

+ Authentication map[string]MergeableAuthenticationSpec

+ Authorization map[string]MergeableAuthorizationSpec

+ Callbacks map[string]MergeableCallbackSpec

+ Metadata map[string]MergeableMetadataSpec

+ Response *MergeableResponseSpec

+ func (in *AuthSchemeSpec) DeepCopy() *AuthSchemeSpec

+ func (in *AuthSchemeSpec) DeepCopyInto(out *AuthSchemeSpec)

+ type CertificateSpec struct

+ CommonName string

+ Duration *metav1.Duration

+ IssuerRef certmanmetav1.ObjectReference

+ PrivateKey *certmanv1.CertificatePrivateKey

+ RenewBefore *metav1.Duration

+ RevisionHistoryLimit *int32

+ Usages []certmanv1.KeyUsage

+ func (in *CertificateSpec) DeepCopy() *CertificateSpec

+ func (in *CertificateSpec) DeepCopyInto(out *CertificateSpec)

+ type Counter struct

+ Expression Expression

+ func (in *Counter) DeepCopy() *Counter

+ func (in *Counter) DeepCopyInto(out *Counter)

+ type DNSPolicy struct

+ Spec DNSPolicySpec

+ Status DNSPolicyStatus

+ func NewDNSPolicy(name, ns string) *DNSPolicy

+ func (in *DNSPolicy) DeepCopy() *DNSPolicy

+ func (in *DNSPolicy) DeepCopyInto(out *DNSPolicy)

+ func (in *DNSPolicy) DeepCopyObject() runtime.Object

+ func (p *DNSPolicy) GetLocator() string

+ func (p *DNSPolicy) GetMergeStrategy() machinery.MergeStrategy

+ func (p *DNSPolicy) GetStatus() kuadrantgatewayapi.PolicyStatus

+ func (p *DNSPolicy) GetTargetRef() gatewayapiv1alpha2.LocalPolicyTargetReference

+ func (p *DNSPolicy) GetTargetRefs() []machinery.PolicyTargetReference

+ func (p *DNSPolicy) Kind() string

+ func (p *DNSPolicy) Merge(other machinery.Policy) machinery.Policy

+ func (p *DNSPolicy) Validate() error

+ func (p *DNSPolicy) WithExcludeAddresses(excluded []string) *DNSPolicy

+ func (p *DNSPolicy) WithHealthCheck(healthCheck dnsv1alpha1.HealthCheckSpec) *DNSPolicy

+ func (p *DNSPolicy) WithHealthCheckFor(endpoint string, port int, protocol string, failureThreshold int) *DNSPolicy

+ func (p *DNSPolicy) WithLoadBalancing(loadBalancing LoadBalancingSpec) *DNSPolicy

+ func (p *DNSPolicy) WithLoadBalancingFor(weight int, geo string, isDefaultGeo bool) *DNSPolicy

+ func (p *DNSPolicy) WithProviderRef(providerRef dnsv1alpha1.ProviderRef) *DNSPolicy

+ func (p *DNSPolicy) WithProviderSecret(s corev1.Secret) *DNSPolicy

+ func (p *DNSPolicy) WithTargetGateway(gwName string) *DNSPolicy

+ func (p *DNSPolicy) WithTargetGatewayListener(gwName string, lName string) *DNSPolicy

+ func (p *DNSPolicy) WithTargetRef(targetRef gatewayapiv1alpha2.LocalPolicyTargetReferenceWithSectionName) *DNSPolicy

+ type DNSPolicyList struct

+ Items []DNSPolicy

+ func (in *DNSPolicyList) DeepCopy() *DNSPolicyList

+ func (in *DNSPolicyList) DeepCopyInto(out *DNSPolicyList)

+ func (in *DNSPolicyList) DeepCopyObject() runtime.Object

+ type DNSPolicySpec struct

+ ExcludeAddresses ExcludeAddresses

+ HealthCheck *dnsv1alpha1.HealthCheckSpec

+ LoadBalancing *LoadBalancingSpec

+ ProviderRefs []dnsv1alpha1.ProviderRef

+ TargetRef gatewayapiv1alpha2.LocalPolicyTargetReferenceWithSectionName

+ func (in *DNSPolicySpec) DeepCopy() *DNSPolicySpec

+ func (in *DNSPolicySpec) DeepCopyInto(out *DNSPolicySpec)

+ type DNSPolicyStatus struct

+ Conditions []metav1.Condition

+ HealthCheck *dnsv1alpha1.HealthCheckStatus

+ ObservedGeneration int64

+ RecordConditions map[string][]metav1.Condition

+ TotalRecords int32

+ func (in *DNSPolicyStatus) DeepCopy() *DNSPolicyStatus

+ func (in *DNSPolicyStatus) DeepCopyInto(out *DNSPolicyStatus)

+ func (s *DNSPolicyStatus) GetConditions() []metav1.Condition

+ type Duration string

+ func (d Duration) Seconds() int

+ type ExcludeAddresses []string

+ func (ea ExcludeAddresses) Validate() error

+ func (in ExcludeAddresses) DeepCopy() ExcludeAddresses

+ func (in ExcludeAddresses) DeepCopyInto(out *ExcludeAddresses)

+ type Expression string

+ type GeoCode string

+ const DefaultGeo

+ const WildcardGeo

+ func (gc GeoCode) IsDefaultCode() bool

+ func (gc GeoCode) IsWildcard() bool

+ type Limit struct

+ Counters []Counter

+ Rates []Rate

+ Source string

+ When WhenPredicates

+ func (in *Limit) DeepCopy() *Limit

+ func (in *Limit) DeepCopyInto(out *Limit)

+ func (l *Limit) GetSource() string

+ func (l *Limit) GetSpec() any

+ func (l *Limit) WithSource(source string) MergeableRule

+ func (l Limit) CountersAsStringList() []string

+ type LoadBalancingSpec struct

+ DefaultGeo bool

+ Geo string

+ Weight int

+ func (in *LoadBalancingSpec) DeepCopy() *LoadBalancingSpec

+ func (in *LoadBalancingSpec) DeepCopyInto(out *LoadBalancingSpec)

+ type MergeableAuthPolicySpec struct

+ Strategy string

+ func (in *MergeableAuthPolicySpec) DeepCopy() *MergeableAuthPolicySpec

+ func (in *MergeableAuthPolicySpec) DeepCopyInto(out *MergeableAuthPolicySpec)

+ type MergeableAuthenticationSpec struct

+ Source string

+ func (in *MergeableAuthenticationSpec) DeepCopy() *MergeableAuthenticationSpec

+ func (in *MergeableAuthenticationSpec) DeepCopyInto(out *MergeableAuthenticationSpec)

+ func (r *MergeableAuthenticationSpec) GetSource() string

+ func (r *MergeableAuthenticationSpec) GetSpec() any

+ func (r *MergeableAuthenticationSpec) WithSource(source string) MergeableRule

+ type MergeableAuthorizationSpec struct

+ Source string

+ func (in *MergeableAuthorizationSpec) DeepCopy() *MergeableAuthorizationSpec

+ func (in *MergeableAuthorizationSpec) DeepCopyInto(out *MergeableAuthorizationSpec)

+ func (r *MergeableAuthorizationSpec) GetSource() string

+ func (r *MergeableAuthorizationSpec) GetSpec() any

+ func (r *MergeableAuthorizationSpec) WithSource(source string) MergeableRule

+ type MergeableCallbackSpec struct

+ Source string

+ func (in *MergeableCallbackSpec) DeepCopy() *MergeableCallbackSpec

+ func (in *MergeableCallbackSpec) DeepCopyInto(out *MergeableCallbackSpec)

+ func (r *MergeableCallbackSpec) GetSource() string

+ func (r *MergeableCallbackSpec) GetSpec() any

+ func (r *MergeableCallbackSpec) WithSource(source string) MergeableRule

+ type MergeableDenyWithSpec struct

+ Source string

+ func (in *MergeableDenyWithSpec) DeepCopy() *MergeableDenyWithSpec

+ func (in *MergeableDenyWithSpec) DeepCopyInto(out *MergeableDenyWithSpec)

+ func (r *MergeableDenyWithSpec) GetSource() string

+ func (r *MergeableDenyWithSpec) GetSpec() any

+ func (r *MergeableDenyWithSpec) WithSource(source string) MergeableRule

+ type MergeableHeaderSuccessResponseSpec struct

+ Source string

+ func (in *MergeableHeaderSuccessResponseSpec) DeepCopy() *MergeableHeaderSuccessResponseSpec

+ func (in *MergeableHeaderSuccessResponseSpec) DeepCopyInto(out *MergeableHeaderSuccessResponseSpec)

+ func (r *MergeableHeaderSuccessResponseSpec) GetSource() string

+ func (r *MergeableHeaderSuccessResponseSpec) GetSpec() any

+ func (r *MergeableHeaderSuccessResponseSpec) WithSource(source string) MergeableRule

+ type MergeableMetadataSpec struct

+ Source string

+ func (in *MergeableMetadataSpec) DeepCopy() *MergeableMetadataSpec

+ func (in *MergeableMetadataSpec) DeepCopyInto(out *MergeableMetadataSpec)

+ func (r *MergeableMetadataSpec) GetSource() string

+ func (r *MergeableMetadataSpec) GetSpec() any

+ func (r *MergeableMetadataSpec) WithSource(source string) MergeableRule

+ type MergeablePatternExpressions struct

+ Source string

+ func (in *MergeablePatternExpressions) DeepCopy() *MergeablePatternExpressions

+ func (in *MergeablePatternExpressions) DeepCopyInto(out *MergeablePatternExpressions)

+ func (r *MergeablePatternExpressions) GetSource() string

+ func (r *MergeablePatternExpressions) GetSpec() any

+ func (r *MergeablePatternExpressions) WithSource(source string) MergeableRule

+ type MergeablePolicy interface

+ DeepCopyObject func() runtime.Object

+ Empty func() bool

+ Rules func() map[string]MergeableRule

+ SetRules func(map[string]MergeableRule)

+ type MergeableRateLimitPolicySpec struct

+ Strategy string

+ func (in *MergeableRateLimitPolicySpec) DeepCopy() *MergeableRateLimitPolicySpec

+ func (in *MergeableRateLimitPolicySpec) DeepCopyInto(out *MergeableRateLimitPolicySpec)

+ type MergeableResponseSpec struct

+ Success MergeableWrappedSuccessResponseSpec

+ Unauthenticated *MergeableDenyWithSpec

+ Unauthorized *MergeableDenyWithSpec

+ func (in *MergeableResponseSpec) DeepCopy() *MergeableResponseSpec

+ func (in *MergeableResponseSpec) DeepCopyInto(out *MergeableResponseSpec)

+ type MergeableRule interface

+ GetSource func() string

+ GetSpec func() any

+ WithSource func(string) MergeableRule

+ func NewMergeableRule(rule MergeableRule, defaultSource string) MergeableRule

+ type MergeableSuccessResponseSpec struct

+ Source string

+ func (in *MergeableSuccessResponseSpec) DeepCopy() *MergeableSuccessResponseSpec

+ func (in *MergeableSuccessResponseSpec) DeepCopyInto(out *MergeableSuccessResponseSpec)

+ func (r *MergeableSuccessResponseSpec) GetSource() string

+ func (r *MergeableSuccessResponseSpec) GetSpec() any

+ func (r *MergeableSuccessResponseSpec) WithSource(source string) MergeableRule

+ type MergeableWhenPredicates struct

+ Predicates WhenPredicates

+ Source string

+ func (in *MergeableWhenPredicates) DeepCopy() *MergeableWhenPredicates

+ func (in *MergeableWhenPredicates) DeepCopyInto(out *MergeableWhenPredicates)

+ func (p *MergeableWhenPredicates) GetSource() string

+ func (p *MergeableWhenPredicates) GetSpec() any

+ func (p *MergeableWhenPredicates) WithSource(source string) MergeableRule

+ type MergeableWrappedSuccessResponseSpec struct

+ DynamicMetadata map[string]MergeableSuccessResponseSpec

+ Headers map[string]MergeableHeaderSuccessResponseSpec

+ func (in *MergeableWrappedSuccessResponseSpec) DeepCopy() *MergeableWrappedSuccessResponseSpec

+ func (in *MergeableWrappedSuccessResponseSpec) DeepCopyInto(out *MergeableWrappedSuccessResponseSpec)

+ type Predicate struct

+ Predicate string

+ func NewPredicate(predicate string) Predicate

+ func (in *Predicate) DeepCopy() *Predicate

+ func (in *Predicate) DeepCopyInto(out *Predicate)

+ type Rate struct

+ Limit int

+ Window Duration

+ func (in *Rate) DeepCopy() *Rate

+ func (in *Rate) DeepCopyInto(out *Rate)

+ func (r Rate) ToSeconds() (maxValue, seconds int)

+ type RateLimitPolicy struct

+ Spec RateLimitPolicySpec

+ Status RateLimitPolicyStatus

+ func (in *RateLimitPolicy) DeepCopy() *RateLimitPolicy

+ func (in *RateLimitPolicy) DeepCopyInto(out *RateLimitPolicy)

+ func (in *RateLimitPolicy) DeepCopyObject() runtime.Object

+ func (p *RateLimitPolicy) Empty() bool

+ func (p *RateLimitPolicy) GetLocator() string

+ func (p *RateLimitPolicy) GetMergeStrategy() machinery.MergeStrategy

+ func (p *RateLimitPolicy) GetName() string

+ func (p *RateLimitPolicy) GetNamespace() string

+ func (p *RateLimitPolicy) GetStatus() kuadrantgatewayapi.PolicyStatus

+ func (p *RateLimitPolicy) GetTargetRef() gatewayapiv1alpha2.LocalPolicyTargetReference

+ func (p *RateLimitPolicy) GetTargetRefs() []machinery.PolicyTargetReference

+ func (p *RateLimitPolicy) Kind() string

+ func (p *RateLimitPolicy) Merge(other machinery.Policy) machinery.Policy

+ func (p *RateLimitPolicy) Rules() map[string]MergeableRule

+ func (p *RateLimitPolicy) SetRules(rules map[string]MergeableRule)

+ type RateLimitPolicyList struct

+ Items []RateLimitPolicy

+ func (in *RateLimitPolicyList) DeepCopy() *RateLimitPolicyList

+ func (in *RateLimitPolicyList) DeepCopyInto(out *RateLimitPolicyList)

+ func (in *RateLimitPolicyList) DeepCopyObject() runtime.Object

+ type RateLimitPolicySpec struct

+ Defaults *MergeableRateLimitPolicySpec

+ Overrides *MergeableRateLimitPolicySpec

+ TargetRef gatewayapiv1alpha2.LocalPolicyTargetReferenceWithSectionName

+ func (in *RateLimitPolicySpec) DeepCopy() *RateLimitPolicySpec

+ func (in *RateLimitPolicySpec) DeepCopyInto(out *RateLimitPolicySpec)

+ func (s *RateLimitPolicySpec) Proper() *RateLimitPolicySpecProper

+ type RateLimitPolicySpecProper struct

+ Limits map[string]Limit

+ func (in *RateLimitPolicySpecProper) DeepCopy() *RateLimitPolicySpecProper

+ func (in *RateLimitPolicySpecProper) DeepCopyInto(out *RateLimitPolicySpecProper)

+ type RateLimitPolicyStatus struct

+ Conditions []metav1.Condition

+ ObservedGeneration int64

+ func (in *RateLimitPolicyStatus) DeepCopy() *RateLimitPolicyStatus

+ func (in *RateLimitPolicyStatus) DeepCopyInto(out *RateLimitPolicyStatus)

+ func (s *RateLimitPolicyStatus) GetConditions() []metav1.Condition

+ type TLSPolicy struct

+ Spec TLSPolicySpec

+ Status TLSPolicyStatus

+ func NewTLSPolicy(policyName, ns string) *TLSPolicy

+ func (in *TLSPolicy) DeepCopy() *TLSPolicy

+ func (in *TLSPolicy) DeepCopyInto(out *TLSPolicy)

+ func (in *TLSPolicy) DeepCopyObject() runtime.Object

+ func (p *TLSPolicy) GetLocator() string

+ func (p *TLSPolicy) GetMergeStrategy() machinery.MergeStrategy

+ func (p *TLSPolicy) GetStatus() kuadrantgatewayapi.PolicyStatus

+ func (p *TLSPolicy) GetTargetRef() gatewayapiv1alpha2.LocalPolicyTargetReference

+ func (p *TLSPolicy) GetTargetRefs() []machinery.PolicyTargetReference

+ func (p *TLSPolicy) Kind() string

+ func (p *TLSPolicy) Merge(other machinery.Policy) machinery.Policy

+ func (p *TLSPolicy) WithIssuerRef(issuerRef certmanmetav1.ObjectReference) *TLSPolicy

+ func (p *TLSPolicy) WithTargetGateway(gwName string) *TLSPolicy

+ func (p *TLSPolicy) WithTargetGatewaySection(gwName string, sectionName string) *TLSPolicy

+ type TLSPolicyList struct

+ Items []TLSPolicy

+ func (in *TLSPolicyList) DeepCopy() *TLSPolicyList

+ func (in *TLSPolicyList) DeepCopyInto(out *TLSPolicyList)

+ func (in *TLSPolicyList) DeepCopyObject() runtime.Object

+ type TLSPolicySpec struct

+ TargetRef gatewayapiv1alpha2.LocalPolicyTargetReferenceWithSectionName

+ func (in *TLSPolicySpec) DeepCopy() *TLSPolicySpec

+ func (in *TLSPolicySpec) DeepCopyInto(out *TLSPolicySpec)

+ type TLSPolicyStatus struct

+ Conditions []metav1.Condition

+ ObservedGeneration int64

+ func (in *TLSPolicyStatus) DeepCopy() *TLSPolicyStatus

+ func (in *TLSPolicyStatus) DeepCopyInto(out *TLSPolicyStatus)

+ func (s *TLSPolicyStatus) GetConditions() []metav1.Condition

+ type WhenPredicates []Predicate

+ func NewWhenPredicates(predicates ...string) WhenPredicates

+ func (in WhenPredicates) DeepCopy() WhenPredicates

+ func (in WhenPredicates) DeepCopyInto(out *WhenPredicates)

+ func (w WhenPredicates) Extend(other WhenPredicates) WhenPredicates

+ func (w WhenPredicates) Into() []string