Skip to content

Commit 33d6af1

Browse files
authored
Merge pull request #780 from stackabletech/fix/broken-links-backport
fix: Fix various broken links in docs (#779)
2 parents a27723d + 6eaef18 commit 33d6af1

3 files changed

Lines changed: 11 additions & 11 deletions

File tree

docs/modules/airflow/pages/usage-guide/applying-custom-resources.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This can be created through the Webserver UI by enabling the "in cluster configu
1313

1414
image::airflow_connection_ui.png[A screenshot of the 'Edit connection' window with the 'in cluster configuration' tick box ticked]
1515

16-
Alternatively, the connection can be {airflow-managing-connections}[defined] using an environment variable in URI format:
16+
Alternatively, the connection can be {airflow-managing-connections}[defined{external-link-icon}^] using an environment variable in URI format:
1717

1818
[source]
1919
AIRFLOW_CONN_KUBERNETES_IN_CLUSTER: "kubernetes://?__extra__=%7B%22extra__kubernetes__in_cluster%22%3A+true%2C+%22extra__kubernetes__kube_config%22%3A+%22%22%2C+%22extra__kubernetes__kube_config_path%22%3A+%22%22%2C+%22extra__kubernetes__namespace%22%3A+%22%22%7D"
@@ -64,7 +64,7 @@ include::example$example-pyspark-pi.yaml[]
6464
----
6565

6666
This is called from within a DAG by using the connection that was defined earlier.
67-
It is wrapped by the `KubernetesHook` that the Airflow Kubernetes provider makes available https://github.com/apache/airflow/blob/main/airflow/providers/cncf/kubernetes/operators/spark_kubernetes.py[here].
67+
It is wrapped by the `KubernetesHook` that the Airflow Kubernetes provider makes available https://github.com/apache/airflow/blob/main/providers/cncf/kubernetes/src/airflow/providers/cncf/kubernetes/operators/spark_kubernetes.py[here{external-link-icon}^].
6868
There are two classes that are used to:
6969

7070
* start the job
@@ -105,7 +105,7 @@ image::airflow_dag_log.png[Airflow Connections]
105105

106106
NOTE: If the `KubernetesExecutor` is employed the logs are only accessible via the SDP logging mechanism, described https://docs.stackable.tech/home/stable/concepts/logging[here].
107107

108-
TIP: A full example of the above is used as an integration test https://github.com/stackabletech/airflow-operator/tree/main/tests/templates/kuttl/mount-dags-gitsync[here].
108+
TIP: A full example of the above is used as an integration test https://github.com/stackabletech/airflow-operator/tree/main/tests/templates/kuttl/mount-dags-gitsync[here{external-link-icon}^].
109109

110110
== Logging
111111

docs/modules/airflow/pages/usage-guide/security.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= Security
22
:description: Secure Apache Airflow by configuring user authentication and authorization.
3-
:airflow-access-control-docs: https://airflow.apache.org/docs/apache-airflow/stable/security/access-control.html
3+
:airflow-access-control-docs: https://airflow.apache.org/docs/apache-airflow-providers-fab/stable/auth-manager/access-control.html
44
:keycloak: https://www.keycloak.org/
55

66
Secure Apache Airflow by configuring user authentication and authorization.
@@ -47,7 +47,7 @@ spec:
4747
<1> The reference to an AuthenticationClass called `ldap`
4848
<2> The default role that all users are assigned to
4949

50-
Users that log in with LDAP are assigned to a default {airflow-access-control-docs}[role] which is specified with the `userRegistrationRole` property.
50+
Users that log in with LDAP are assigned to a default {airflow-access-control-docs}[role{external-link-icon}^] which is specified with the `userRegistrationRole` property.
5151

5252
You can follow the xref:tutorials:authentication_with_openldap.adoc[] tutorial to learn how to set up an AuthenticationClass for an LDAP server, as well as consulting the {crd-docs}/authentication.stackable.tech/authenticationclass/v1alpha1/[AuthenticationClass reference {external-link-icon}^].
5353

@@ -61,7 +61,7 @@ An OpenID Connect provider can be used for authentication.
6161
Unfortunately, there is no generic support for OpenID Connect built into Airflow.
6262
This means that only specific OpenID Connect providers can be configured.
6363

64-
IMPORTANT: Airflow deployments on the Stackable Data Platform only support {keycloak}[Keycloak].
64+
IMPORTANT: Airflow deployments on the Stackable Data Platform only support {keycloak}[Keycloak{external-link-icon}^].
6565

6666
[source,yaml]
6767
----
@@ -84,7 +84,7 @@ spec:
8484
<2> The reference to the Secret containing the Airflow client credentials
8585
<3> The default role to which all users are assigned
8686

87-
Users that log in with OpenID Connect are assigned to a default {airflow-access-control-docs}[role] which is specified with the `userRegistrationRole` property.
87+
Users that log in with OpenID Connect are assigned to a default {airflow-access-control-docs}[role{external-link-icon}^] which is specified with the `userRegistrationRole` property.
8888

8989
The Secret containing the Airflow client credentials:
9090

@@ -130,7 +130,7 @@ Further information for specifying an AuthenticationClass for an OIDC provider c
130130

131131
== Authorization
132132

133-
The Airflow Webserver delegates the {airflow-access-control-docs}[handling of user access control] to the https://flask-appbuilder.readthedocs.io/en/latest/security.html[Flask AppBuilder].
133+
The Airflow Webserver delegates the {airflow-access-control-docs}[handling of user access control{external-link-icon}^] to the https://flask-appbuilder.readthedocs.io/en/latest/security.html[Flask AppBuilder{external-link-icon}^].
134134
The AuthManager in the Flask AppBuilder can be configured to fetch the user roles from the authentication backend, e.g. LDAP.
135135
Instead of using the integrated authorization, the Stackable Data Platform also provides an AuthManager which delegates the authorization requests to an xref:opa:index.adoc[Open Policy Agent (OPA)].
136136

@@ -142,7 +142,7 @@ You can view, add to, and assign the roles displayed in the Airflow Webserver UI
142142

143143
==== LDAP
144144

145-
Airflow supports assigning {airflow-access-control-docs}[Roles] to users based on their LDAP group membership, though this is not yet supported by the Stackable operator.
145+
Airflow supports assigning {airflow-access-control-docs}[Roles{external-link-icon}^] to users based on their LDAP group membership, though this is not yet supported by the Stackable operator.
146146
All the users logging in via LDAP get assigned to the same role which you can configure via the attribute `authenticationConfig.userRegistrationRole` on the AirflowCluster object:
147147

148148
[source,yaml]
@@ -164,7 +164,7 @@ spec:
164164
==== OpenID Connect
165165

166166
The mechanism for assigning roles to users described in the LDAP section also applies to OpenID Connect.
167-
Airflow supports assigning {airflow-access-control-docs}[Roles] to users based on their OpenID Connect scopes, though this is not yet supported by the Stackable operator.
167+
Airflow supports assigning {airflow-access-control-docs}[Roles{external-link-icon}^] to users based on their OpenID Connect scopes, though this is not yet supported by the Stackable operator.
168168
All the users logging in via OpenID Connect get assigned to the same role which you can configure via the attribute `authentication[*].userRegistrationRole` on the `AirflowCluster` object:
169169

170170
[source,yaml]

docs/modules/airflow/partials/nav.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,6 @@
2121
* xref:airflow:troubleshooting/index.adoc[]
2222
* xref:airflow:reference/index.adoc[]
2323
** xref:airflow:reference/crds.adoc[]
24-
*** {crd-docs}/airflow.stackable.tech/airflowcluster/v1alpha1/[AirflowCluster {external-link-icon}^]
24+
*** {crd-docs}/airflow.stackable.tech/airflowcluster/v1alpha2/[AirflowCluster {external-link-icon}^]
2525
** xref:airflow:reference/commandline-parameters.adoc[]
2626
** xref:airflow:reference/environment-variables.adoc[]

0 commit comments

Comments
 (0)