Skip to content

Commit 6430271

Browse files
committed
review feedback: docs
1 parent 8f6f461 commit 6430271

2 files changed

Lines changed: 7 additions & 6 deletions

File tree

docs/modules/airflow/pages/getting_started/first_steps.adoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,18 +60,19 @@ include::example$getting_started/code/getting_started.sh[tag=install-airflow]
6060

6161
Where:
6262

63-
* `metadata.name` contains the name of the Airflow cluster.
64-
* `spec.clusterConfig.metadataDatabase` specifies one of the supported database types (in this case, `postgresql`) along with references to the host, database and the secret containing the connection credentials.
63+
* `metadata.name`: contains the name of the Airflow cluster.
64+
* `spec.clusterConfig.metadataDatabase`: specifies one of the supported database types (in this case, `postgresql`) along with references to the host, database and the secret containing the connection credentials.
6565
* the product version of the Docker image provided by Stackable must be set in `spec.image.productVersion`.
6666
* `spec.celeryExecutors`: deploy executors managed by Airflow's Celery engine.
6767
Alternatively you can use `kuberenetesExectors` that use Airflow's Kubernetes engine for executor management.
6868
For more information see https://airflow.apache.org/docs/apache-airflow/stable/executor/index.html#executor-types).
6969
* `spec.celeryExecutors.celeryResultBackend`: specifies one of the supported database types (in this case, `postgresql`) along with references to the host, database and the secret containing the connection credentials.
7070
* `spec.celeryExecutors.celeryBrokerUrl`: specifies one of the supported queue/broker types (in this case, `redis`) along with references to the host and the secret containing the connection credentials.
71-
* the `spec.clusterConfig.loadExamples` key is optional and defaults to `false`.
71+
* `spec.clusterConfig.loadExamples`: this key is optional and defaults to `false`.
7272
It is set to `true` here as the example DAGs are used when verifying the installation.
73-
* the `spec.clusterConfig.exposeConfig` key is optional and defaults to `false`. It is set to `true` only as an aid to verify the configuration and should never be used as such in anything other than test or demo clusters.
74-
* the secret containing the admin user information must be referenced in `spec.clusterConfig.credentialsSecret`.
73+
* `spec.clusterConfig.exposeConfig`: this key is optional and defaults to `false`.
74+
It is set to `true` only as an aid to verify the configuration and should never be used as such in anything other than test or demo clusters.
75+
* `spec.clusterConfig.credentialsSecret`: specifies the secret containing the Airflow admin user information.
7576

7677
NOTE: The version you need to specify for `spec.image.productVersion` is the desired version of Apache Airflow.
7778
You can optionally specify the `spec.image.stackableVersion` to a certain release like `23.11.0` but it is recommended to leave it out and use the default provided by the operator.

docs/modules/airflow/pages/usage-guide/db-connect.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
Airflow requires a metadata database for storing e.g. DAG, task and job data.
55
The actual connection string is provided by the operator so that the user does not need to remember the exact structure.
6-
The same database can be accessed using different drivers: this is also handled by the operator, since the context is known (e.g. job metadata vs. queued job metadata) when parsing the resource file.
6+
The same database can be accessed using different drivers (e.g. job metadata vs. queued job metadata).
77

88
== Typed connections
99

0 commit comments

Comments
 (0)