package
1.3.0
Repository: https://github.com/kong/gateway-operator.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

ControlPlaneGVR returns current package ControlPlane GVR.
DataPlaneGVR returns current package DataPlane GVR.

# Constants

AutomaticPromotion indicates that once all workflows and tests have completed successfully, the new resources should be promoted and replace the previous resources.
BreakBeforePromotion is the same as AutomaticPromotion but with an added breakpoint to enable manual inspection.
DataPlanePromoteWhenReadyAnnotationKey is the annotation key which can be used to annotate a DataPlane object to signal that the live resources should be promoted and replace the preview resources.
DataPlanePromoteWhenReadyAnnotationTrue is the annotation value that needs to be set to the DataPlane's DataPlanePromoteWhenReadyAnnotationKey annotation to signal that the new resources should be promoted.
GatewayConfigurationTargetKindGateway is a target kind which indicates that a Gateway resource is the target.
GatewayConfigurationTargetKindGatewayClass is a target kind which indicates that a GatewayClass resource is the target.
HostnameAddressType represents a DNS based ingress point.
IPAddressType is a textual representation of a numeric IP address.
PrivateIPAddressSourceType represents an address belonging to a private IP.
PrivateLoadBalancerAddressSourceType represents an address belonging to a private Load Balancer.
PublicIPAddressSourceType represents an address belonging to a public IP.
PublicLoadBalancerAddressSourceType represents an address belonging to a public Load Balancer.
RolloutResourcePlanDeploymentDeleteOnPromotionRecreateOnRollout which makes the operator delete the Deployment the rollout is not initiated by a spec change and then to re-create it when the rollout is initiated (the owner resource like a DataPlane is patched or updated).
RolloutResourcePlanDeploymentScaleDownOnPromotionScaleUpOnRollout is a rollout resource plan for Deployment which makes the operator scale down the Deployment to 0 when the rollout is not initiated by a spec change and then to scale it up when the rollout is initiated (the owner resource like a DataPlane is patched or updated).

# Variables

AddToScheme adds the types in this group-version to the given scheme.
SchemeBuilder is used to add go types to the GroupVersionKind scheme.
SchemeGroupVersion is group version used to register these objects.

# Structs

Address describes an address which can be either an IP address or a hostname.
BlueGreenStrategy defines the Blue Green deployment strategy.
ControlPlane is the Schema for the controlplanes API.
ControlPlaneDeploymentOptions is a shared type used on objects to indicate that their configuration results in a Deployment which is managed by the Operator and includes options for managing Deployments such as the the number of replicas or pod options like container image and resource requirements.
ControlPlaneList contains a list of ControlPlane.
ControlPlaneOptions indicates the specific information needed to deploy and connect a ControlPlane to a DataPlane object.
ControlPlaneSpec defines the desired state of ControlPlane.
ControlPlaneStatus defines the observed state of ControlPlane.
DataPlane is the Schema for the dataplanes API.
DataPlaneDeploymentOptions specifies options for the Deployments (as in the Kubernetes resource "Deployment") which are created and managed for the DataPlane resource.
DataPlaneList contains a list of DataPlane.
DataPlaneNetworkOptions defines network related options for a DataPlane.
DataPlaneOptions defines the information specifically needed to deploy the DataPlane.
DataPlaneRolloutStatus describes the DataPlane rollout status.
DataPlaneRolloutStatusDeployment is a rollout status field which contains fields specific for Deployments during the rollout.
DataPlaneRolloutStatusServices describes the status of the services during DataPlane rollout.
DataPlaneServiceOptions contains Services related DataPlane configuration.
DataPlaneServicePort contains information on service's port.
DataPlaneServices contains Services related DataPlane configuration, shared with the GatewayConfiguration.
DataPlaneSpec defines the desired state of DataPlane.
DataPlaneStatus defines the observed state of DataPlane.
DeploymentOptions is a shared type used on objects to indicate that their configuration results in a Deployment which is managed by the Operator and includes options for managing Deployments such as the number of replicas or pod options like container image and resource requirements.
GatewayConfigDataPlaneNetworkOptions defines network related options for a DataPlane.
GatewayConfigDataPlaneOptions indicates the specific information needed to configure and deploy a DataPlane object.
GatewayConfigDataPlaneServices contains Services related DataPlane configuration.
GatewayConfigServiceOptions is used to includes options to customize the ingress service, such as the annotations.
GatewayConfiguration is the Schema for the gatewayconfigurations API.
GatewayConfigurationList contains a list of GatewayConfiguration.
GatewayConfigurationSpec defines the desired state of GatewayConfiguration.
GatewayConfigurationStatus defines the observed state of GatewayConfiguration.
HorizontalScaling defines horizontal scaling options for the deployment.
KonnectCertificateOptions indicates how the operator should manage the certificates that managed entities will use to interact with Konnect.
NamespacedName is a resource identified by name and optional namespace.
Promotion is a type that contains fields that define how the operator handles promotion of resources during a blue/green rollout.
Rollout defines options for rollouts.
RolloutResourcePlan is a type that holds rollout resource plan related fields which control how the operator handles resources during and after a rollout.
RolloutResources is the type which contains the fields which control how the operator manages the resources it manages during or after the rollout concludes.
RolloutStatusService is a struct which contains status information about services that are exposed as part of the rollout.
RolloutStrategy holds the rollout strategy options.
Scaling defines the scaling options for the deployment.
ServiceOptions is used to includes options to customize the ingress service, such as the annotations.

# Type aliases

AddressSourceType defines the type of source this address represents.
AddressType defines how a network address is represented as a text string.
GatewayConfigurationTargetKind is an object kind that can be targeted for GatewayConfiguration attachment.
PromotionStrategy is the type of promotion strategy consts.
RolloutResourcePlanDeployment is the type that holds the resource plan for managing the Deployment objects during and after a rollout.