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.

Sign up for GitHub

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

Deprecate disableSSLRedirect with sslRedirect #105

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Deprecate disableSSLRedirect with sslRedirect #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions internal/caddy/ingress/annotations.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,16 @@ import v1 "k8s.io/api/networking/v1"

const (
annotationPrefix = "caddy.ingress.kubernetes.io"
rewriteToAnnotation = "rewrite-to"
rewriteStripPrefixAnnotation = "rewrite-strip-prefix"
disableSSLRedirect = "disable-ssl-redirect"
backendProtocol = "backend-protocol"
insecureSkipVerify = "insecure-skip-verify"
rewriteStripPrefixAnnotation = "rewrite-strip-prefix"
rewriteToAnnotation = "rewrite-to"
sslRedirect = "ssl-redirect"

//// Deprecated annotations

// Use "ssl-redirect" instead, see https://github.com/caddyserver/ingress/issues/102
disableSSLRedirect = "disable-ssl-redirect"
)

func getAnnotation(ing *v1.Ingress, rule string) string {
Expand All @@ -22,3 +27,8 @@ func getAnnotationBool(ing *v1.Ingress, rule string, def bool) bool {
}
return val == "true"
}

func hasAnnotation(ing *v1.Ingress, rule string) bool {
_, ok := ing.Annotations[annotationPrefix+"/"+rule]
return ok
}
6 changes: 5 additions & 1 deletion internal/caddy/ingress/matcher.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,11 @@ func (p MatcherPlugin) IngressPlugin() converter.PluginInfo {
func (p MatcherPlugin) IngressHandler(input converter.IngressMiddlewareInput) (*caddyhttp.Route, error) {
match := caddy.ModuleMap{}

if getAnnotation(input.Ingress, disableSSLRedirect) != "true" {
// Ignore disable-ssl-redirect annotation if ssl-redirect is set or the disable-ssl-redirect is not set / set to false.
ignoreDisableSSLRedirect := hasAnnotation(input.Ingress, sslRedirect) || !getAnnotationBool(input.Ingress, disableSSLRedirect, false)

// If the disable-ssl-redirect annotation is ignored, then the ssl-redirect annotation is used.
if ignoreDisableSSLRedirect && getAnnotationBool(input.Ingress, sslRedirect, true) {
match["protocol"] = caddyconfig.JSON(caddyhttp.MatchProtocol("https"), nil)
}

Expand Down