Skip to content
Merged
Show file tree
Hide file tree
Changes from 12 commits
Commits
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
5 changes: 4 additions & 1 deletion antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ nav:
- modules/concepts/nav.adoc
- modules/demos/nav.adoc
- modules/tutorials/nav.adoc
- modules/reference/nav.adoc
- modules/operators/nav.adoc
- modules/reference/nav.adoc
- modules/contributor/nav.adoc
- modules/ROOT/nav2.adoc
# The prerelease setting affects version sorting.
Expand All @@ -24,3 +24,6 @@ asciidoc:
# use the attributes below to link to the CRD docs
crd-docs-base-url: "https://crds.stackable.tech"
crd-docs: "{crd-docs-base-url}/{crd-docs-version}"
# this attribute is an annoying little hack to make the versioned
# link accessible to the UI template.
page-crd-docs: "{crd-docs}"
2 changes: 1 addition & 1 deletion modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ xref:operators:index.adoc[Operator overview]

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

https://crds.stackable.tech/[CRD Reference]
{crd-docs}[CRD Reference pass:[<i class="fa-solid fa-arrow-up-right-from-square fa-xs" style="margin-left: 5px; vertical-align: baseline;"></i>]]

++++
</div>
Expand Down
4 changes: 2 additions & 2 deletions modules/concepts/pages/authentication.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ In a diagram it would look like this:

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

NOTE: For more details, look at the xref:reference:authenticationclass.adoc[AuthenticationClass reference] as well as the xref:tutorials:authentication_with_openldap.adoc[OpenLDAP tutorial].
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].

[#tls]
=== TLS
Expand Down Expand Up @@ -78,4 +78,4 @@ include::example$authenticationclass-static-secret.yaml[]
== Further Reading

* xref:tutorials:authentication_with_openldap.adoc[] tutorial
* xref:reference:authenticationclass.adoc[] reference
* {crd-docs}/authentication.stackable.tech/authenticationclass/v1alpha1/[AuthenticationClass CRD reference]
2 changes: 1 addition & 1 deletion modules/concepts/pages/s3.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -205,4 +205,4 @@ credentials:

== What's next

Find details about the options of the S3 resource in the xref:reference:s3.adoc[S3 resources reference].
Read the {crd-docs}/s3.stackable.tech/s3bucket/v1alpha1/[S3Bucket CRD reference] and the {crd-docs}/s3.stackable.tech/s3connection/v1alpha1/[S3Connection CRD reference].
4 changes: 2 additions & 2 deletions modules/concepts/pages/service-discovery.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:page-aliases: service_discovery.adoc

// Abstract
Stackable operators provide a _service discovery ConfigMap_ for each product instance that is deployed. This ConfigMap has the same name as the product instance and contains information about how to connect to the instance. The ConfigMap is used by other Operators to connect products together and can also be used by you, the user, to connect external software to Stackable-operated software.
Stackable operators provide a _service discovery ConfigMap_ for each product instance that is deployed. **This ConfigMap has the same name as the product instance** and contains information about how to connect to the instance. The ConfigMap is used by other Operators to connect products together and can also be used by you, the user, to connect external software to Stackable-operated software.

== Motivation

Expand Down Expand Up @@ -118,7 +118,7 @@ For Stackable managed services the Stackable Operators will take care of this, b

Consult discovery ConfigMap documentation for specific products:

* xref:druid:discovery.adoc[Apache Druid]
* xref:druid:reference/discovery.adoc[Apache Druid]
* xref:hdfs:discovery.adoc[Apache Hadoop HDFS]
* xref:hive:discovery.adoc[Apache Hive]
* xref:kafka:discovery.adoc[Apache Kafka]
Expand Down
29 changes: 0 additions & 29 deletions modules/reference/examples/authenticationclass-ldap-full.yaml

This file was deleted.

4 changes: 1 addition & 3 deletions modules/reference/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
* xref:index.adoc[]
** xref:authenticationclass.adoc[]
** xref:s3.adoc[]
- {crd-docs}[CRD Reference pass:[<i class="fa-solid fa-arrow-up-right-from-square fa-xs" style="margin-left: 5px; vertical-align: baseline;"></i>]]
22 changes: 0 additions & 22 deletions modules/reference/pages/authenticationclass.adoc

This file was deleted.

3 changes: 0 additions & 3 deletions modules/reference/pages/index.adoc

This file was deleted.

99 changes: 0 additions & 99 deletions modules/reference/pages/s3.adoc

This file was deleted.

2 changes: 1 addition & 1 deletion modules/tutorials/pages/authentication_with_openldap.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ The LDAP connection details only need to be written down once, in the Authentica
== Further Reading

- xref:concepts:authentication.adoc[Authentication concepts page]
- xref:reference:authenticationclass.adoc[AuthenticationClass reference]
* {crd-docs}/authentication.stackable.tech/authenticationclass/v1alpha1/[AuthenticationClass CRD reference]
- xref:superset:getting_started/index.adoc[Getting started with the Stackable Operator for Apache Superset]
- xref:trino:getting_started/index.adoc[Getting started with the Stackable Operator for Trino]
// TODO Operator docs for LDAP
Loading