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.

Sign up for GitHub

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

Jump to bottom

Service exposition docs #320

Merged
merged 7 commits into from
Aug 31, 2023
Merged

Service exposition docs #320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f9fa627
added document
fhennig Aug 31, 2023
bbfd058
Merge remote-tracking branch 'origin/main' into docs/listenerclass
fhennig Aug 31, 2023
b365d4c
Updated docs
fhennig Aug 31, 2023
b0a5fbd
Added the external-unstable class to the getting started guide
fhennig Aug 31, 2023
1988c69
Updated docs
fhennig Aug 31, 2023
261656a
...
fhennig Aug 31, 2023
6fd8e00
regenerate charts
fhennig Aug 31, 2023
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
4 changes: 3 additions & 1 deletion deploy/helm/airflow-operator/crds/crds.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7023,13 +7023,15 @@ spec:
listenerClass:
default: cluster-internal
description: |-
In the future this setting will control, which ListenerClass <https://docs.stackable.tech/home/stable/listener-operator/listenerclass.html> will be used to expose the service. Currently only a subset of the ListenerClasses are supported by choosing the type of the created Services by looking at the ListenerClass name specified, In a future release support for custom ListenerClasses will be introduced without a breaking change:
This field controls which type of Service the Operator creates for this AirflowCluster:

* cluster-internal: Use a ClusterIP service

* external-unstable: Use a NodePort service

* external-stable: Use a LoadBalancer service

This is a temporary solution with the goal to keep yaml manifests forward compatible. In the future, this setting will control which ListenerClass <https://docs.stackable.tech/home/stable/listener-operator/listenerclass.html> will be used to expose the service, and ListenerClass names will stay the same, allowing for a non-breaking change.
enum:
- cluster-internal
- external-unstable
Expand Down
1 change: 1 addition & 0 deletions docs/modules/airflow/examples/getting_started/code/airflow.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ spec:
clusterConfig:
loadExamples: true
exposeConfig: false
listenerClass: external-unstable
credentialsSecret: simple-airflow-credentials
webservers:
roleGroups:
Expand Down
31 changes: 0 additions & 31 deletions docs/modules/airflow/examples/getting_started/code/airflow.yaml.j2
View file
Open in desktop

This file was deleted.

15 changes: 15 additions & 0 deletions docs/modules/airflow/pages/usage-guide/listenerclass.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
= Service exposition with ListenerClasses

Airflow offers a web UI and an API, both are exposed by the webserver process under the `webserver` role. The Operator deploys a service called `<name>-webserver` (where `<name>` is the name of the AirflowCluster) through which Airflow can be reached.

This service can have three different types: `cluster-internal`, `external-unstable` and `external-stable`. Read more about the types in the xref:concepts:service-exposition.adoc[service exposition] documentation at platform level.

This is how the listener class is configured:

[source,yaml]
----
spec:
clusterConfig:
listenerClass: cluster-internal # <1>
----
<1> The default `cluster-internal` setting.
1 change: 1 addition & 0 deletions docs/modules/airflow/partials/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
** xref:airflow:usage-guide/pod-placement.adoc[]
** xref:airflow:usage-guide/mounting-dags.adoc[]
** xref:airflow:usage-guide/applying-custom-resources.adoc[]
** xref:airflow:usage-guide/listenerclass.adoc[]
** xref:airflow:usage-guide/storage-resources.adoc[]
** xref:airflow:usage-guide/security.adoc[]
** xref:airflow:usage-guide/logging.adoc[]
Expand Down
10 changes: 5 additions & 5 deletions rust/crd/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,17 +169,17 @@ pub struct AirflowClusterConfig {
pub expose_config: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub load_examples: Option<bool>,
/// In the future this setting will control, which ListenerClass <https://docs.stackable.tech/home/stable/listener-operator/listenerclass.html>
/// will be used to expose the service.
/// Currently only a subset of the ListenerClasses are supported by choosing the type of the created Services
/// by looking at the ListenerClass name specified,
/// In a future release support for custom ListenerClasses will be introduced without a breaking change:
/// This field controls which type of Service the Operator creates for this AirflowCluster:
///
/// * cluster-internal: Use a ClusterIP service
///
/// * external-unstable: Use a NodePort service
///
/// * external-stable: Use a LoadBalancer service
///
/// This is a temporary solution with the goal to keep yaml manifests forward compatible.
/// In the future, this setting will control which ListenerClass <https://docs.stackable.tech/home/stable/listener-operator/listenerclass.html>
/// will be used to expose the service, and ListenerClass names will stay the same, allowing for a non-breaking change.
#[serde(default)]
pub listener_class: CurrentlySupportedListenerClasses,
/// Name of the Vector aggregator discovery ConfigMap.
Expand Down