Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

migration: using edge route if tls type is none (PROJQUAY-2611) #554

Merged
merged 1 commit into from
Oct 4, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
28 changes: 23 additions & 5 deletions controllers/redhatcop/quayecosystem_controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -535,6 +535,21 @@ func (r *QuayEcosystemReconciler) Reconcile(ctx context.Context, req ctrl.Reques
if canHandleExternalAccess(quayEcosystem) {
log.Info("attempting to migrate external access", "type", quayEcosystem.Spec.Quay.ExternalAccess.Type)

// if user has provided their own certs we gonna configure TLS as unmanaged. this
// should happen most of the times, exception made when quay is acessed directly
// without any kind of key (plain http). if not cert and key were found then we
// gonna migrate it using a Route with "edge" termination.
_, hasKey := configBundle.Data["ssl.key"]
_, hasCrt := configBundle.Data["ssl.cert"]
if hasKey && hasCrt {
quayRegistry.Spec.Components = append(
quayRegistry.Spec.Components, quay.Component{
Kind: "tls",
Managed: false,
},
)
}

// NOTE: Assume that if using edge `Route`, there is no custom TLS cert/key pair.
// Docs state that custom TLS can be provided to an edge `Route`: (https://access.redhat.com/documentation/en-us/red_hat_quay/3.3/html/deploy_red_hat_quay_on_openshift_with_quay_operator/customizing_your_red_hat_quay_cluster#user_provided_certificates)
// But this doesn't seem to be implemented: (https://sourcegraph.com/github.com/quay/quay-operator@v1/-/blob/pkg/controller/quayecosystem/resources/routes.go#L64).
Expand Down Expand Up @@ -712,12 +727,15 @@ func canHandleDatabase(q redhatcop.QuayEcosystem) bool {
return q.Spec.Quay.Database.Server == "" && q.Spec.Quay.Database.VolumeSize != ""
}

// canHandleExternalAccess returs true if the operator can manage quay's external access. This is
// useful while migrating from a QuayEcosystem and we need to determine if we set Route component
// as managed or unmanaged. We will set Route component to managed if QuayEcosystem has external
// access configured using an OpenShift's Route object.
func canHandleExternalAccess(q redhatcop.QuayEcosystem) bool {
return q.Spec.Quay.ExternalAccess != nil &&
q.Spec.Quay.ExternalAccess.Type == redhatcop.RouteExternalAccessType &&
q.Spec.Quay.ExternalAccess.TLS != nil &&
(q.Spec.Quay.ExternalAccess.TLS.Termination == redhatcop.PassthroughTLSTerminationType ||
q.Spec.Quay.ExternalAccess.TLS.Termination == redhatcop.EdgeTLSTerminationType)
if q.Spec.Quay.ExternalAccess == nil {
return false
}
return q.Spec.Quay.ExternalAccess.Type == redhatcop.RouteExternalAccessType
}

func canHandleRedis(q redhatcop.QuayEcosystem) bool {
Expand Down
54 changes: 54 additions & 0 deletions controllers/redhatcop/quayecosystem_controller_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,60 @@ var _ = Describe("Reconciling a QuayEcosystem", func() {
})

When("the external access component", func() {
Context("uses key and cert", func() {
JustBeforeEach(func() {
Expect(k8sClient.Create(context.Background(), quayEcosystem)).Should(Succeed())
quayConfig := types.NamespacedName{
Name: quayEnterpriseConfigSecretName,
Namespace: quayEcosystem.Namespace,
}

var secret corev1.Secret
Expect(k8sClient.Get(context.Background(), quayConfig, &secret)).Should(Succeed())
secret.Data["ssl.key"] = []byte(" ")
secret.Data["ssl.cert"] = []byte(" ")
Expect(k8sClient.Update(context.Background(), &secret)).Should(Succeed())
result, err = controller.Reconcile(context.Background(), reconcile.Request{NamespacedName: quayEcosystemName})
})

It("does not return an error", func() {
Expect(err).NotTo(HaveOccurred())
Expect(result.Requeue).To(BeFalse())
})

It("marks `route` component as managed", func() {
var quayRegistry v1.QuayRegistry
Expect(k8sClient.Get(context.Background(), quayRegistryName, &quayRegistry)).Should(Succeed())
Expect(quayRegistry.Spec.Components).NotTo(ContainElement(v1.Component{Kind: "route", Managed: false}))
Expect(quayRegistry.Spec.Components).To(ContainElement(v1.Component{Kind: "tls", Managed: false}))
})
})

Context("is using http protocol", func() {
JustBeforeEach(func() {
quayEcosystem.Spec.Quay.ExternalAccess = &redhatcop.ExternalAccess{
Type: redhatcop.RouteExternalAccessType,
TLS: &redhatcop.TLSExternalAccess{
Termination: redhatcop.NoneTLSTerminationType,
},
}
Expect(k8sClient.Create(context.Background(), quayEcosystem)).Should(Succeed())
result, err = controller.Reconcile(context.Background(), reconcile.Request{NamespacedName: quayEcosystemName})
})

It("does not return an error", func() {
Expect(err).NotTo(HaveOccurred())
Expect(result.Requeue).To(BeFalse())
})

It("marks `route` component as unmanaged", func() {
var quayRegistry v1.QuayRegistry
Expect(k8sClient.Get(context.Background(), quayRegistryName, &quayRegistry)).Should(Succeed())
Expect(quayRegistry.Spec.Components).NotTo(ContainElement(v1.Component{Kind: "tls", Managed: false}))
Expect(quayRegistry.Spec.Components).NotTo(ContainElement(v1.Component{Kind: "tls", Managed: true}))
})
})

Context("is unsupported for migration", func() {
JustBeforeEach(func() {
quayEcosystem.Spec.Quay.ExternalAccess = &redhatcop.ExternalAccess{Type: redhatcop.LoadBalancerExternalAccessType}
Expand Down