PageRule

A kind: PageRule resource will manage one or more PageRules in a manage zone. Each resource contains a single PageRule record.

Attributes

Zone

Each kind: PageRule must contain a spec.zone string attribute. The value of this attribute must match a zone managed by Kubeflare. The API token to manage the DNS record(s) will be read from the associated Zone kind resource.

PageRule

For more information on this type, see the Cloudflare documentation.

The following attributes are supported in the pagerule or pagerules object. Priority and status are optional, and at least one of the other fields (rules) should be present on the object. Check the Cloudflare documentation to ensure the combination of rules (settings) are compatbile.

Name	Type	Description
requestUrl	string	The incoming (original) request url
priority	int
enabled	boolean
alwaysOnline	AlwaysOnline	When present, the always online page rule
alwaysUseHttps	AlwaysUseHTTPS	When present, the always use https page rule
autoMinify	AutoMinify	When present, the auto minify page rule
forwardingUrl	ForwardingURL	When present, the forwarding url page rule

AlwaysOnline

The AlwaysOnline object describes the always online page rule.

Name	Type	Description
enabled	boolean	The value of the always online setting

AlwaysUseHTTPS

The AlwaysUseHTTPS object is an empty object that enables the always use https pagerule.

AutoMinify

The AutoMinify object describes an auto minify page rule settings.

Name	Type	Description
html	boolean	The value for the html setting
css	boolean	The value for the css setting
js	boolean	The value for the js setting

ForwardingURL

The ForwardingURL object describes a forwarding url page rule.

Name	Type	Description
statusCode	int	301 or 302, the status code to send
redirectUrl	string	The redirect/forwarded url

Examples

Redirect (forward) www to apex domain

The following PageRule manifest will forward requests made to www.example.com to example.com:

apiVersion: crds.kubeflare.io/v1alpha1
kind: PageRule
metadata:
  name: www.example.com
spec:
  zone: example.com
  rule:
    requestUrl: "www.example.com/*"
    forwardingUrl:
      statusCode: 302
      redirectUrl: "https://example.com/$1

Always Use HTTPS

The following PageRule manifest will enable always use https on a specific path:

apiVersion: crds.kubeflare.io/v1alpha1
kind: PageRule
metadata:
  name: www.example.com
spec:
  zone: example.com
  rule:
    requestUrl: "www.example.com/*"
    alwaysUseHttps: {}