Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/reference docs #360

Merged
merged 4 commits into from
Dec 21, 2023
Merged
Show file tree
Hide file tree
Changes from all 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
13 changes: 0 additions & 13 deletions docs/modules/airflow/pages/configuration.adoc

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
= Command Line Parameters

=== product-config
This operator accepts the following command line parameters:

== product-config

*Default value*: `/etc/stackable/airflow-operator/config-spec/properties.yaml`

Expand All @@ -12,7 +15,7 @@
stackable-airflow-operator run --product-config /foo/bar/properties.yaml
----

=== watch-namespace
== watch-namespace

*Default value*: All namespaces

Expand Down
3 changes: 3 additions & 0 deletions docs/modules/airflow/pages/reference/crds.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
= CRD Reference

Find all CRD reference for the Stackable Operator for Apache Airfow at: {crd-docs-base-url}/airflow-operator/{crd-docs-version}.
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
= Environment variables

=== PRODUCT_CONFIG
This operator accepts the following environment variables:

== PRODUCT_CONFIG

*Default value*: `/etc/stackable/airflow-operator/config-spec/properties.yaml`

Expand All @@ -25,7 +28,7 @@ docker run \
docker.stackable.tech/stackable/airflow-operator:latest
----

=== WATCH_NAMESPACE
== WATCH_NAMESPACE

*Default value*: All namespaces

Expand Down
6 changes: 6 additions & 0 deletions docs/modules/airflow/pages/reference/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
= Reference

Consult the reference documentation section to find exhaustive information on:

* Descriptions and default values of all properties in the CRDs used by this operator in the xref:reference/crds.adoc[].
* The xref:reference/commandline-parameters.adoc[] and xref:reference/environment-variables.adoc[] accepted by the operator.
4 changes: 2 additions & 2 deletions docs/modules/airflow/pages/usage-guide/security.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ image::airflow_security.png[Airflow Security menu]

=== LDAP

Airflow supports xref:nightly@home:concepts:authentication.adoc[authentication] of users against an LDAP server. This requires setting up an xref:nightly@home:concepts:authentication.adoc#authenticationclass[AuthenticationClass] for the LDAP server.
Airflow supports xref:home:concepts:authentication.adoc[authentication] of users against an LDAP server. This requires setting up an AuthenticationClass for the LDAP server.
The AuthenticationClass is then referenced in the AirflowCluster resource as follows:

[source,yaml]
Expand All @@ -35,7 +35,7 @@ spec:

Users that log in with LDAP are assigned to a default https://airflow.apache.org/docs/apache-airflow/stable/security/access-control.html#access-control[Role] which is specified with the `userRegistrationRole` property.

You can follow the xref:nightly@home:tutorials:authentication_with_openldap.adoc[] tutorial to learn how to set up an AuthenticationClass for an LDAP server, as well as consulting the xref:nightly@home:reference:authenticationclass.adoc[] reference.
You can follow the xref:home: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}^].

The users and roles can be viewed as before in the Webserver UI, but note that the blue "+" button is not available when authenticating against LDAP:

Expand Down
6 changes: 5 additions & 1 deletion docs/modules/airflow/partials/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
* xref:airflow:getting_started/index.adoc[]
** xref:airflow:getting_started/installation.adoc[]
** xref:airflow:getting_started/first_steps.adoc[]
* xref:airflow:configuration.adoc[]
* xref:airflow:required-external-components.adoc[]
* xref:airflow:usage-guide/index.adoc[]
** xref:airflow:usage-guide/mounting-dags.adoc[]
Expand All @@ -17,3 +16,8 @@
*** xref:airflow:usage-guide/operations/pod-placement.adoc[]
*** xref:airflow:usage-guide/operations/pod-disruptions.adoc[]
*** xref:airflow:usage-guide/operations/graceful-shutdown.adoc[]
* xref:airflow:reference/index.adoc[]
** xref:airflow:reference/crds.adoc[]
*** {crd-docs}/airflow.stackable.tech/airflowcluster/v1alpha1/[AirflowCluster {external-link-icon}^]
** xref:airflow:reference/commandline-parameters.adoc[]
** xref:airflow:reference/environment-variables.adoc[]
5 changes: 5 additions & 0 deletions rust/crd/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -184,23 +184,28 @@ pub struct AirflowClusterSpec {
pub struct AirflowClusterConfig {
#[serde(flatten)]
pub authentication: AirflowAuthentication,

/// The name of the Secret object containing the admin user credentials and database connection details.
/// Read the
/// [getting started guide first steps](DOCS_BASE_URL_PLACEHOLDER/airflow/getting_started/first_steps)
/// to find out more.
pub credentials_secret: String,

/// The `gitSync` settings allow configuring DAGs to mount via `git-sync`.
/// Learn more in the
/// [mounting DAGs documentation](DOCS_BASE_URL_PLACEHOLDER/airflow/usage-guide/mounting-dags#_via_git_sync).
#[serde(default)]
pub dags_git_sync: Vec<GitSync>,

/// for internal use only - not for production use.
#[serde(default)]
pub expose_config: bool,

/// Whether to load example DAGs or not; defaults to false. The examples are used in the
/// [getting started guide](DOCS_BASE_URL_PLACEHOLDER/airflow/getting_started/).
#[serde(default)]
pub load_examples: bool,

/// This field controls which type of Service the Operator creates for this AirflowCluster:
///
/// * cluster-internal: Use a ClusterIP service
Expand Down