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

# Constants

AnnotationLastAppliedAnnotations is the annotation key to store the last annotations of a DataPlane-owned object (e.g.
CACRT is the filename for the ca.crt.
CAFieldSecret is the field name in Kubernetes secret - WebhookCertificateConfigSecretName.
TLSFieldSecret is the field name in Kubernetes secret - WebhookCertificateConfigSecretName.
CertPurposeLabel indicates the purpose of a certificate.
ClusterCertEnvKey is the environment variable name for the cluster certificate.
ClusterCertificateVolume is the name of the volume that holds the certificate and keys which are used for serving traffic and ControlPlane and DataPlane communication.
ClusterCertificateVolumeMountPath holds the path where cluster certificate volume will be mounted.
ClusterCertEnvKey is the environment variable name for the cluster certificate key.
ControlPlaneAdmissionWebhookEnvVarValue is the default value for the admission webhook env var.
ControlPlaneAdmissionWebhookListenPort is the port on which the control plane admission webhook listens.
ControlPlaneAdmissionWebhookPortName is the name of the port on which the control plane admission webhook listens.
ControlPlaneAdmissionWebhookVolumeMountPath is the path where the admission webhook certificate will be mounted.
ControlPlaneAdmissionWebhookVolumeName is the name of the volume that holds the certificate that's used for serving the admission webhook in control plane.
ControlPlaneControllerContainerName is the name of the ingress controller container in a ControlPlane Deployment.
ControlPlaneManagedLabelValue indicates that an object's lifecycle is managed by the controlplane controller.
ControlPlanePrefix is used as a name prefix to generate controlplane-owned objects' name.
ControlPlaneServiceKindAdmin is the value for SecretUsedByServiceLabel or ControlPlaneServiceLabel that is used to indicate that a Service is an admin service.
ControlPlaneServiceKindWebhook is the value for the SecretUsedByServiceLabel or ControlPlaneServiceLabel that is used to indicate that a Service is a webhook service.
ControlPlaneServiceLabel is a Service's label that is used to indicate which kind of Service it is.
DataPlaneHTTPSPort is the port that the dataplane uses for Admin API.
DataPlaneAdminServiceLabelValue indicates that the service is intended to expose the DataPlane admin API.
DataPlaneAdminServicePortName is the port name of the DataPlane admin service.
DataPlaneConditionMessageRolledOutPreviewDeploymentNotYetReady contains the message that is set for the RolledOut Condition when Reason is Progressing and the operator is waiting for preview Deployment to be ready.
DataPlaneConditionMessageRolledOutRolloutInitialized contains the message that is set for the RolledOut Condition when Reason is Progressing and the DataPlane has initiated a rollout.
DataPlaneConditionReasonRolloutAwaitingPromotion is a reason which indicates a DataPlane preview has been deployed successfully and is awaiting promotion.
DataPlaneConditionReasonRolloutFailed is a reason which indicates a DataPlane has failed to roll out.
DataPlaneConditionReasonRolloutProgressing is a reason which indicates a DataPlane's new version is being rolled out.
DataPlaneConditionReasonRolloutPromotionDone is a reason which indicates that a promotion is done.
DataPlaneConditionReasonRolloutPromotionFailed is a reason which indicates a DataPlane has failed to promote.
DataPlaneConditionReasonRolloutPromotionInProgress is a reason which indicates that a promotion is in progress.
DataPlaneConditionReasonRolloutWaitingForChange is a reason which indicates a DataPlane is waiting for a change to trigger new version to be made available before promotion.
DataPlaneConditionTypeRolledOut is a condition type indicating whether or not, DataPlane's rollout has been successful or not.
DataPlaneDeploymentStateLabel indicates the state of a DataPlane deployment.
DataPlaneIngressServiceLabelValue indicates that the service is inteded to expose the DataPlane proxy.
DataPlaneInitRetryDelay is the time delay between every attempt (on controller startup) to connect to the Kong Admin API.
DataPlaneManagedLabelValue indicates that an object's lifecycle is managed by the dataplane controller.
DataPlaneMetricsPort is the port that the dataplane uses for metrics.
DataPlaneOwnedWaitForOwnerFinalizer is the finalizer added to resources owned by a DataPlane to ensure that the resources are not deleted before the DataPlane is deleted.
DataPlanePodStateLabel indicates the state of a DataPlane Pod.
DataPlanePrefix is used as a name prefix to generate dataplane-owned objects' name.
DataPlaneProxyContainerName is the name of the Kong proxy container.
DataPlaneHTTPSPort is the port that the dataplane uses for HTTP.
DataPlaneProxyServiceLabelValue is the legacy label value which indicates that the service is inteded to expose the DataPlane proxy.
DataPlaneHTTPSPort is the port that the dataplane uses for HTTPS.
DataPlanePODDNSDiscoveryStrategy is DNS strategy to use when creating Gateway's Admin API addresses.
DataPlaneServiceStateLabel indicates the state of a DataPlane service.
DataPlaneServiceTypeLabel is the label that is used for the services created by the DataPlane controller to expose the DataPlane deployment.
DataPlaneServiceTypeLabelLegacy is the legacy label that is used for the services created by the DataPlane controller to expose the DataPlane deployment.
DataPlaneStateLabelValueLive indicates that a DataPlane resource is a "live" resource.
DataPlaneStateLabelValuePreview indicates that a DataPlane resource is a "preview" resource.
DataPlaneReadyEndpoint is the endpoint to use for DataPlane readiness probe.
DefaultKongStatusPort is the port that the dataplane uses for status.
DataPlaneStatusReadyEndpoint is the endpoint to use for DataPlane readiness probe in the context of managed gateways.
DefaultControlPlaneBaseImage is the base container image that can be used by default for a ControlPlane resource if all other attempts to dynamically decide an image fail.
DefaultControlPlaneImage is the default container image that can be used if all other attempts to dynamically decide the default image fail.
DefaultDataPlaneBaseEnterpriseImage is the enterprise base container image.
DefaultDataPlaneBaseImage is the base container image that can be used by default for a DataPlane resource if all other attempts to dynamically decide an image fail.
DefaultDataPlaneEnterpriseImage is the default enterprise container image that can be used if all other attempts to dynamically decide the default image fail.
DefaultDataPlaneImage is the default container image that can be used if all other attempts to dynamically decide the default image fail.
renovate: datasource=docker depName=kong/kong-gateway.
DefaultHTTPPort is the default port used for HTTP ingress network traffic from outside clusters.
DefaultHTTPSPort is the default port used for HTTPS ingress network traffic from outside clusters.
DependenciesNotReadyMessage indicates the other conditions are not yet ready.
DependenciesNotReadyReason is a generic reason describing that the other Conditions are not true.
EnvVarKongDatabase is the environment variable name to specify database backend used for dataplane(Kong gateway).
GatewayManagedLabelValue indicates that the object's lifecycle is managed by the gateway controller.
GatewayOperatorManagedByLabel is the label that is used for objects which were created by this operator.
GatewayOperatorManagedByLabelLegacy is the legacy label used for object with were created by this operator Notice: use GatewayOperatorManagedByLabel instead.
GatewayOperatorManagedByNameLabel is the label that is used for objects which were created by this operator.
GatewayOperatorManagedByNamespaceLabel is the label that is used for objects which were created by this operator.
KeyFieldSecret is the field name in Kubernetes secret - WebhookCertificateConfigSecretName.
OperatorAnnotationPrefix is the common annotation prefix used by the operator.
OperatorLabelPrefix is the common label prefix used by the operator.
OperatorLabelSelector is a label name that is used for operator resources as a label selector key.
ReadyType indicates if the resource has all the dependent conditions Ready.
ResourceCreatedMessage indicates a missing resource was provisioned.
ResourceCreatedOrUpdatedReason generic message for missing or outdated resources.
ResourceReadyReason indicates the resource is ready.
ResourceUpdatedMessage indicates a resource was updated.
SecretUsedByServiceLabel is a Secret's label that is used to indicate which Service kind is using the Secret.
ServiceSecretLabel is a label that is added to operator related Service Secrets to designate which Service this particular Secret it used by.
ServiceSelectorOverrideAnnotation is used on the dataplane to override the Selector of both the admin and proxy services.
TLSCACRTPath is the full path for the ca.crt file.
TLSCRT is the filename for the tls.crt.
TLSCRTPath is the full path for the tls.crt file.
TLSKey is the filename for the tls.key.
TLSKeyPath is the full path for the tls.key file.
UnableToProvisionReason generic message for unexpected errors.
WaitingToBecomeReadyMessage indicates the target resource is not ready.
WaitingToBecomeReadyReason generic message for dependent resources waiting to be ready.
WebhookCertificateConfigBaseImage is the image to use by the certificate config Jobs.
WebhookCertificateConfigLabelvalue is the default label for all the resources related to the certificate config Jobs.
WebhookCertificateConfigName is the name given to the resources related by the certificate config Jobs.
WebhookCertificateConfigSecretName is the name of the secret containing the webhook certificate.
WebhookName is the ValidatingWebhookConfiguration name.
WebhookServiceName is the name of the service that exposes the validating webhook.

# Type aliases

CoditionReason literal to enumerate a specific condition reason.
ConditionType literal that defines the different types of condition.
ServiceType is a re-typing of string to be used to distinguish between proxy and admin service.