Skip to content

Commit

Permalink
doc: skrevet om alle fire operators
Browse files Browse the repository at this point in the history
  • Loading branch information
Kyrremann committed Oct 13, 2023
1 parent 4587d49 commit 04b378f
Showing 1 changed file with 47 additions and 5 deletions.
52 changes: 47 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,54 @@ Enkelt wrapperbibliotek rundt [KubernetesPodOperator](https://airflow.apache.org

## Våre operators

### Python operator
Alle våre operators lar deg klone et repo på forhånd, bare legg det til med `repo="navikt/<repo>`.
Vi har også støtte for å installere Python pakker ved oppstart av Airflow task, spesifiser `requirements.txt`-filen din med `requirements_path="/path/to/requirements.txt"`.

### Quarto operator

Denne kjører Quarto render for deg.

```python
from airflow import DAG
from airflow.utils.dates import days_ago
from dataverk_airflow import quarto_operator

Vi tilbyr en operator som lar deg kjøre både Jupyter notebooks, eller Python-scripts.
Begge operatorene lar deg klone et repo og kjøre en notebook fil eller et Python-script.

Internt i operatoren finner den ut om det er et Python-script eller en notebook som skal kjøres.
with DAG('navn-dag', start_date=days_ago(1), schedule_interval="*/10 * * * *") as dag:
t1 = quarto_operator(dag=dag,
name="<navn-på-task>",
repo="navikt/<repo>",
quarto={
"path": "/path/to/index.qmd",
"env": "dev/prod",
"id":"uuid",
"token":
"quarto-token"
},
slack_channel="<#slack-alarm-kanal>")
```

### Notebook operator

Denne lar deg kjøre en Jupyter notebook.

```python
from airflow import DAG
from airflow.utils.dates import days_ago
from dataverk_airflow import notebook_operator


with DAG('navn-dag', start_date=days_ago(1), schedule_interval="*/10 * * * *") as dag:
t1 = notebook_operator(dag=dag,
name="<navn-på-task>",
repo="navikt/<repo>",
nb_path="/path/to/notebook.ipynb",
slack_channel="<#slack-alarm-kanal>")
```

### Python operator

Denne lar deg kjøre vilkårlig Python-scripts.

```python
from airflow import DAG
Expand All @@ -21,7 +63,7 @@ with DAG('navn-dag', start_date=days_ago(1), schedule_interval="*/10 * * * *") a
t1 = python_operator(dag=dag,
name="<navn-på-task>",
repo="navikt/<repo>",
script_path="<sti-til-fil-i-repo>",
script_path="/path/to/script.py",
slack_channel="<#slack-alarm-kanal>")
```

Expand Down

0 comments on commit 04b378f

Please sign in to comment.