Skip to content

Commit 42a05e6

Browse files
TechassiTechassi
committed
chore: Merge branch 'main' into docs/release-notes-26.7.0
2 parents 10a6194 + ff36a19 commit 42a05e6

14 files changed

Lines changed: 65 additions & 17 deletions

File tree

‎Makefile‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,20 @@ netlify-fetch:
7474
git reset --hard -q $(CURRENT_COMMIT)
7575
git clean -fdq
7676

77-
netlify-build: netlify-fetch build-prod build-search-index
77+
netlify-build: netlify-fetch build-prod build-search-index purge-cache
7878

79-
.PHONY: build-only-dev build-local build-prod build-ui clean netlify-build netlify-fetch
79+
# Purge the bunny.net pull zone cache after a production build so freshly
80+
# deployed content is served instead of stale cached responses. Skipped when
81+
# the bunny.net credentials are not set (e.g. local builds).
82+
purge-cache:
83+
@if [ -n "$$BUNNY_API_KEY" ] && [ -n "$$BUNNY_PULL_ZONE_ID" ]; then \
84+
echo "Purging bunny.net pull zone $$BUNNY_PULL_ZONE_ID"; \
85+
curl --fail --show-error --silent \
86+
-X POST "https://api.bunny.net/pullzone/$$BUNNY_PULL_ZONE_ID/purgeCache" \
87+
-H "AccessKey: $$BUNNY_API_KEY" \
88+
-H "content-type: application/json"; \
89+
else \
90+
echo "Skipping bunny.net purge (BUNNY_API_KEY / BUNNY_PULL_ZONE_ID not set)"; \
91+
fi
92+
93+
.PHONY: build-only-dev build-local build-prod build-ui clean netlify-build netlify-fetch purge-cache

‎antora.yml‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,19 @@ asciidoc:
2727
# Whether this version is already end of life.
2828
# If true, a banner will be displayed informing the user.
2929
end-of-life: false
30-
# use the attributes below to link to the CRD docs
30+
# The CRD reference on the Stackable Hub. crd-ref links the listing;
31+
# deep links follow {crd-ref}/<group>/<apiVersion>/<kind>{crd-ref-release}
32+
crd-ref: "https://hub.stackable.tech/crds"
33+
# Keep this in line with the 'version' key above: '?release=dev' on main,
34+
# '?release=<major.minor>' on release branches (the release script sets it).
35+
crd-ref-release: "?release=dev"
36+
# DEPRECATED: the old CRD browser attributes below are still used by the
37+
# operator docs; they migrate to crd-ref repo by repo (operator sweep).
3138
crd-docs-base-url: "https://crds.stackable.tech"
39+
# used by the operator index pages, see the
40+
# operator-link-bar.adoc partial in the ROOT module
41+
hub-base-url: "https://hub.stackable.tech"
3242
crd-docs: "{crd-docs-base-url}/{crd-docs-version}"
3343
# to make attributes accessible to the UI template, they need to
3444
# be prefixed with "page-"
35-
page-crd-docs: "{crd-docs}"
3645
page-end-of-life: "{end-of-life}"

‎modules/ROOT/pages/index.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ xref:operators:index.adoc[Operator overview]
118118

119119
Read the CustomResourceDefinition (CRD) reference for all CRDs that are deployed by any Stackable operator.
120120

121-
{crd-docs}[CRD Reference {external-link-icon}^]
121+
{crd-ref}{crd-ref-release}[CRD Reference {external-link-icon}^]
122122

123123
++++
124124
</div>

‎modules/ROOT/partials/operator-link-bar.adoc‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
// Shared link bar for operator index pages.
2+
//
3+
// Usage in an operator's index.adoc:
4+
//
5+
// :github: https://github.com/stackabletech/airflow-operator/
6+
// :crd: {crd-docs-base-url}/airflow-operator/{crd-docs-version}/
7+
// :hub: {hub-base-url}/components/airflow
8+
//
9+
// include::ROOT:partial$operator-link-bar.adoc[]
10+
//
11+
// Every entry is optional: pages that don't define an attribute don't render
12+
// its entry (e.g. the internal operators have no Hub component page).
13+
[.link-bar]
14+
ifdef::github[* {github}[GitHub {external-link-icon}^]]
15+
ifdef::crd[* {crd}[CRD documentation {external-link-icon}^]]
16+
ifdef::hub[* {hub}[Stackable Hub {external-link-icon}^]]

‎modules/concepts/pages/authentication.adoc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ In a diagram it would look like this:
3838

3939
image::image$authentication-overview.drawio.svg[]
4040

41-
NOTE: Learn more in the xref:tutorials:authentication_with_openldap.adoc[OpenLDAP tutorial] and get a full overview of all the properties in the {crd-docs}/authentication.stackable.tech/authenticationclass/v1alpha1/#spec-provider-ldap[AuthenticationClass LDAP provider CRD reference{external-link-icon}^].
41+
NOTE: Learn more in the xref:tutorials:authentication_with_openldap.adoc[OpenLDAP tutorial] and get a full overview of all the properties in the {crd-ref}/authentication.stackable.tech/v1alpha1/authenticationclass{crd-ref-release}#provider.ldap[AuthenticationClass LDAP provider CRD reference{external-link-icon}^].
4242

4343
[#OIDC]
4444
=== OpenID Connect
@@ -59,7 +59,7 @@ include::example$authenticationclass-keycloak.yaml[]
5959
<7> Optionally enable TLS and configure verification. When present, connections to the idP will use `https://` instead of `http://`. See xref:tls-server-verification.adoc[].
6060
<8> Trust certificates signed by commonly trusted Certificate Authorities.
6161

62-
NOTE: Get a full overview of all the properties in the {crd-docs}/authentication.stackable.tech/authenticationclass/v1alpha1/#spec-provider-oidc[AuthenticationClass OIDC provider CRD reference{external-link-icon}^].
62+
NOTE: Get a full overview of all the properties in the {crd-ref}/authentication.stackable.tech/v1alpha1/authenticationclass{crd-ref-release}#provider.oidc[AuthenticationClass OIDC provider CRD reference{external-link-icon}^].
6363

6464
[#tls]
6565
=== TLS
@@ -113,4 +113,4 @@ include::example$authenticationclass-static-secret.yaml[]
113113
== Further reading
114114

115115
* xref:tutorials:authentication_with_openldap.adoc[] tutorial
116-
* {crd-docs}/authentication.stackable.tech/authenticationclass/v1alpha1/[AuthenticationClass CRD reference{external-link-icon}^]
116+
* {crd-ref}/authentication.stackable.tech/v1alpha1/authenticationclass{crd-ref-release}[AuthenticationClass CRD reference{external-link-icon}^]

‎modules/concepts/pages/opa.adoc‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,13 @@ See <<Further reading>> for links to specific product authorization documentatio
100100
Read more about the xref:opa:index.adoc[].
101101
Read more about product integration with OPA for these products:
102102

103-
* xref:trino:usage-guide/security.adoc#_authorization[Trino]
104-
* xref:kafka:usage.adoc[Kafka]
103+
* xref:airflow:usage-guide/security.adoc#_open_policy_agent[Airflow]
105104
* xref:druid:usage-guide/security.adoc#authorization[Druid]
105+
* xref:hbase:usage-guide/security.adoc#_authorization[HBase]
106+
* xref:hdfs:usage-guide/security.adoc#_authorization[HDFS]
107+
* xref:kafka:usage-guide/security.adoc#authorization[Kafka]
108+
* xref:nifi:usage_guide/security.adoc#authorization-opa[NiFi]
109+
* xref:superset:usage-guide/security.adoc#_opa_role_mapping[Superset]
110+
* xref:trino:usage-guide/security.adoc#_authorization[Trino]
106111

107112
You can also have a look at the xref:contributor:opa_configuration.adoc[implementation guidelines for OPA authorizers] or learn more about the xref:service_discovery.adoc[service discovery mechanism] used across the platform.

‎modules/concepts/pages/s3.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,4 +284,4 @@ region:
284284

285285
== What's next
286286

287-
Read the {crd-docs}/s3.stackable.tech/s3bucket/v1alpha1/[S3Bucket CRD reference{external-link-icon}^] and the {crd-docs}/s3.stackable.tech/s3connection/v1alpha1/[S3Connection CRD reference{external-link-icon}^].
287+
Read the {crd-ref}/s3.stackable.tech/v1alpha1/s3bucket{crd-ref-release}[S3Bucket CRD reference{external-link-icon}^] and the {crd-ref}/s3.stackable.tech/v1alpha1/s3connection{crd-ref-release}[S3Connection CRD reference{external-link-icon}^].

‎modules/contributor/pages/adr/ADR034-foundation-webhooks-deployment.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,5 +230,5 @@ Chosen <<option5>>, because it fits on all decision drivers.
230230

231231
== Links
232232

233-
- ADR https://docs.stackable.tech/home/nightly/contributor/adr/adr033-foundation-webhooks-ca-bundle.adoc[CA bundle injection]
233+
- ADR xref:adr/ADR033-foundation-webhooks-ca-bundle.adoc[CA bundle injection]
234234
- https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definition-versioning/[Kubernetes CRD versioning]

‎modules/reference/nav.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
* Reference
2-
** {crd-docs}[CRD Reference {external-link-icon}^]
2+
** {crd-ref}{crd-ref-release}[CRD Reference {external-link-icon}^]
33
** xref:glossary.adoc[]
44
** xref:duration.adoc[]

‎modules/tutorials/pages/authentication_with_openldap.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,7 @@ The LDAP connection details only need to be written down once, in the Authentica
367367
== Further Reading
368368

369369
- xref:concepts:authentication.adoc[Authentication concepts page]
370-
* {crd-docs}/authentication.stackable.tech/authenticationclass/v1alpha1/[AuthenticationClass CRD reference{external-link-icon}^]
370+
* {crd-ref}/authentication.stackable.tech/v1alpha1/authenticationclass{crd-ref-release}[AuthenticationClass CRD reference{external-link-icon}^]
371371
- xref:superset:getting_started/index.adoc[Getting started with the Stackable Operator for Apache Superset]
372372
- xref:trino:getting_started/index.adoc[Getting started with the Stackable Operator for Trino]
373373
// TODO Operator docs for LDAP

0 commit comments

Comments
 (0)