API Reference

cloudflare-operator API Reference

Packages:

cloudflare-operator.io/v1

Package v1 contains API Schema definitions for the source v1 API group

Resource Types:

    Account

    Account is the Schema for the accounts API

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    AccountSpec


    apiToken
    AccountSpecApiToken

    Cloudflare API token

    interval
    Kubernetes meta/v1.Duration
    (Optional)

    Interval to check account status

    managedZones
    []string
    (Optional)

    List of zone names that should be managed by cloudflare-operator

    status
    AccountStatus

    AccountSpec

    (Appears on: Account)

    AccountSpec defines the desired state of Account

    Field Description
    apiToken
    AccountSpecApiToken

    Cloudflare API token

    interval
    Kubernetes meta/v1.Duration
    (Optional)

    Interval to check account status

    managedZones
    []string
    (Optional)

    List of zone names that should be managed by cloudflare-operator

    AccountSpecApiToken

    (Appears on: AccountSpec)

    Field Description
    secretRef
    Kubernetes core/v1.SecretReference

    Secret containing the API token (key must be named “apiToken”)

    AccountStatus

    (Appears on: Account)

    AccountStatus defines the observed state of Account

    Field Description
    conditions
    []Kubernetes meta/v1.Condition
    (Optional)

    Conditions contains the different condition statuses for the Account object.

    zones
    []AccountStatusZones
    (Optional)

    Zones contains all the zones of the Account

    AccountStatusZones

    (Appears on: AccountStatus)

    Field Description
    name
    string
    (Optional)

    Name of the zone

    id
    string
    (Optional)

    ID of the zone

    DNSRecord

    DNSRecord is the Schema for the dnsrecords API

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    DNSRecordSpec


    name
    string

    DNS record name (e.g. example.com)

    content
    string
    (Optional)

    DNS record content (e.g. 127.0.0.1)

    ipRef
    DNSRecordSpecIPRef
    (Optional)

    Reference to an IP object

    type
    string
    (Optional)

    DNS record type

    proxied
    bool
    (Optional)

    Whether the record is receiving the performance and security benefits of Cloudflare

    ttl
    int
    (Optional)

    Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for ‘automatic’ (e.g. 3600)

    data
    Kubernetes pkg/apis/apiextensions/v1.JSON
    (Optional)

    Data holds arbitrary key-value pairs used to further configure the DNS record

    priority
    uint16
    (Optional)

    Required for MX, SRV and URI records; unused by other record types. Records with lower priorities are preferred.

    interval
    Kubernetes meta/v1.Duration
    (Optional)

    Interval to check DNSRecord

    status
    DNSRecordStatus

    DNSRecordSpec

    (Appears on: DNSRecord)

    DNSRecordSpec defines the desired state of DNSRecord

    Field Description
    name
    string

    DNS record name (e.g. example.com)

    content
    string
    (Optional)

    DNS record content (e.g. 127.0.0.1)

    ipRef
    DNSRecordSpecIPRef
    (Optional)

    Reference to an IP object

    type
    string
    (Optional)

    DNS record type

    proxied
    bool
    (Optional)

    Whether the record is receiving the performance and security benefits of Cloudflare

    ttl
    int
    (Optional)

    Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for ‘automatic’ (e.g. 3600)

    data
    Kubernetes pkg/apis/apiextensions/v1.JSON
    (Optional)

    Data holds arbitrary key-value pairs used to further configure the DNS record

    priority
    uint16
    (Optional)

    Required for MX, SRV and URI records; unused by other record types. Records with lower priorities are preferred.

    interval
    Kubernetes meta/v1.Duration
    (Optional)

    Interval to check DNSRecord

    DNSRecordSpecIPRef

    (Appears on: DNSRecordSpec)

    Field Description
    name
    string
    (Optional)

    Name of the IP object

    DNSRecordStatus

    (Appears on: DNSRecord)

    DNSRecordStatus defines the observed state of DNSRecord

    Field Description
    conditions
    []Kubernetes meta/v1.Condition
    (Optional)

    Conditions contains the different condition statuses for the DNSRecord object.

    recordID
    string
    (Optional)

    Cloudflare DNS record ID

    IP

    IP is the Schema for the ips API

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    IPSpec


    address
    string
    (Optional)

    IP address (omit if type is dynamic)

    type
    string
    (Optional)

    IP address type (static or dynamic)

    interval
    Kubernetes meta/v1.Duration
    (Optional)

    Interval at which a dynamic IP should be checked

    ipSources
    []IPSpecIPSources
    (Optional)

    IPSources can be configured to get an IP from an external source (e.g. an API or public IP echo service)

    status
    IPStatus

    IPSpec

    (Appears on: IP)

    IPSpec defines the desired state of IP

    Field Description
    address
    string
    (Optional)

    IP address (omit if type is dynamic)

    type
    string
    (Optional)

    IP address type (static or dynamic)

    interval
    Kubernetes meta/v1.Duration
    (Optional)

    Interval at which a dynamic IP should be checked

    ipSources
    []IPSpecIPSources
    (Optional)

    IPSources can be configured to get an IP from an external source (e.g. an API or public IP echo service)

    IPSpecIPSources

    (Appears on: IPSpec)

    Field Description
    url
    string
    (Optional)

    URL of the IP source (e.g. https://checkip.amazonaws.com)

    requestBody
    string
    (Optional)

    RequestBody to be sent to the URL

    requestHeaders
    Kubernetes pkg/apis/apiextensions/v1.JSON
    (Optional)

    RequestHeaders to be sent to the URL

    requestHeadersSecretRef
    Kubernetes core/v1.SecretReference
    (Optional)

    RequestHeadersSecretRef is a secret reference to the headers to be sent to the URL (e.g. for authentication) where the key is the header name and the value is the header value

    requestMethod
    string

    RequestMethod defines the HTTP method to be used

    responseJQFilter
    string
    (Optional)

    ResponseJQFilter applies a JQ filter to the response to extract the IP

    postProcessingRegex
    string
    (Optional)

    PostProcessingRegex defines the regular expression to be used to extract the IP from the response or a JQ filter result

    insecureSkipVerify
    bool
    (Optional)

    InsecureSkipVerify defines whether to skip TLS certificate verification

    IPStatus

    (Appears on: IP)

    IPStatus defines the observed state of IP

    Field Description
    conditions
    []Kubernetes meta/v1.Condition
    (Optional)

    Conditions contains the different condition statuses for the IP object.

    lastObservedIP
    string
    (Optional)

    LastObservedIP contains the IP address observed at the last interval (used to determine whether the IP has changed)

    Zone

    Zone is the Schema for the zones API

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    ZoneSpec


    name
    string

    Name of the zone

    id
    string

    ID of the zone

    interval
    Kubernetes meta/v1.Duration
    (Optional)

    Interval to check zone status

    status
    ZoneStatus

    ZoneSpec

    (Appears on: Zone)

    ZoneSpec defines the desired state of Zone

    Field Description
    name
    string

    Name of the zone

    id
    string

    ID of the zone

    interval
    Kubernetes meta/v1.Duration
    (Optional)

    Interval to check zone status

    ZoneStatus

    (Appears on: Zone)

    ZoneStatus defines the observed state of Zone

    Field Description
    conditions
    []Kubernetes meta/v1.Condition
    (Optional)

    Conditions contains the different condition statuses for the Zone object.

    This page was automatically generated with gen-crd-api-reference-docs

    Last modified August 11, 2023: feat: update cloudflare-operator docs (a02117f)