// AsciiDoc settings
:data-uri!:
:doctype: book
:experimental:
:idprefix:
:imagesdir: images
:numbered:
:sectanchors!:
:sectnums:
:source-highlighter: highlight.js
:toc: left
:linkattrs:
:toclevels: 2
:icons: font

//Latest version
:KroxyliciousVersion: 0.13
:gitRef: releases/tag/v0.13.0
:ApicurioVersion: 2.6.x
:KubernetesVersionMinimum: 1.31
:OpenShiftVersionMinimum: 4.18

:OperatorDownloadUrl: https://github.com/kroxylicious/kroxylicious/releases[GitHub releases page^]
:OperatorAssetZipFileName: kroxylicious-operator-{KroxyliciousVersion}.zip
:OperatorAssetTgzFileName: kroxylicious-operator-{KroxyliciousVersion}.tar.gz

//Proxy links
:github: https://github.com/kroxylicious/kroxylicious
:github-releases: https://github.com/kroxylicious/kroxylicious/{gitRef}
:github-issues: https://github.com/kroxylicious/kroxylicious/issues
:api-javadoc: https://javadoc.io/doc/io.kroxylicious/kroxylicious-api/{KroxyliciousVersion}
:kms-api-javadoc: https://javadoc.io/doc/io.kroxylicious/kroxylicious-kms/{KroxyliciousVersion}
:encryption-api-javadoc: https://javadoc.io/doc/io.kroxylicious/kroxylicious-encryption/{KroxyliciousVersion}
:start-script: https://github.com/kroxylicious/kroxylicious/blob/{gitRef}/kroxylicious-app/src/assembly/kroxylicious-start.sh

//Kubernetes links
:KubeTools: link:https://kubernetes.io/docs/tasks/tools/[Install Tools^]

//Kafka links
:ApacheKafkaSite: https://kafka.apache.org[Apache Kafka website^]
:kafka-protocol: https://kafka.apache.org/protocol.html

//java links
:java-17-javadoc: https://docs.oracle.com/en/java/javase/17/docs/api
:java-17-specs: https://docs.oracle.com/en/java/javase/17/docs/specs
:tlsProtocolNames: https://docs.oracle.com/en/java/javase/17/docs/specs/security/standard-names.html#sslcontext-algorithms
:cipherSuiteNames: https://docs.oracle.com/en/java/javase/21/docs/specs/security/standard-names.html#jsse-cipher-suite-names

//Vault links
:hashicorp-vault: https://developer.hashicorp.com/vault

//Fortanix DSM links
:fortanix-dsm: https://www.fortanix.com/platform/data-security-manager
:fortanix-support: https://support.fortanix.com/

//AWS links
:aws:  https://docs.aws.amazon.com/

// Apicurio links
:apicurio-docs: https://www.apicur.io/registry/docs/apicurio-registry/{ApicurioVersion}/

// Kubernetes links
:KubernetesSite: https://kubernetes.io/
:OperatorPattern: https://kubernetes.io/docs/concepts/extend-kubernetes/operator/

// Java Operator SDK links
:josdk: https://javaoperatorsdk.io/
:josdk-metrics: https://github.com/operator-framework/java-operator-sdk/blob/v5.0.4/docs/content/en/docs/features/_index.md#operator-sdk-metrics

// Conditional inclusion flags
// (note: we control optional inclusion with ifdefs/ifndefs directives, so the value of the attribute is irrelevant)
:include-fortanix-dsm-kms: 1
:include-aws-kms-service-config-identity-ec2-metadata: 1
:include-platform-bare-metal: 1
// We're not ready to enable OLM yet
//:include-olm: 1
//:OpenShiftOnly: 1

//API stability markers.
:unstable-api-version: denoted by a major version 0
:stable-api-version: version 1.0.0

// We have a development document (docs/index.adoc) that sits one level higher than the guides, so we need a way to override DocRoot.
ifndef::DocRoot[:DocRoot: ..]
:ProxyGuide: link:{DocRoot}/kroxylicious-proxy/[Kroxylicious Proxy guide]
:RecordEncryptionGuide: link:{DocRoot}/record-encryption-guide/[Kroxylicious Record Encryption guide]
:DeveloperGuide: link:{DocRoot}/developer-guide/[Kroxylicious Developer guide]
:OperatorGuide: link:{DocRoot}/kroxylicious-operator/[Kroxylicious Operator for Kubernetes guide]