Skip to content

Commit 9830c4d

Browse files
EoinTrialdave-gantenbein
EoinTrial
and
dave-gantenbein
authored
Apply tech author recommendations to repo docs (#4384)
Updates contents of `docs` folder to: - align them with G-Research's writing conventions - implement tech author recommendations from Armada documentation review --------- Signed-off-by: EoinTrial <eoinsh@gmail.com> Co-authored-by: Dave Gantenbein <dave@gr-oss.io>
1 parent 9ee4c19 commit 9830c4d

15 files changed

+796
-613
lines changed

docs/python_airflow_operator.md renamed to docs/armada_airflow_operator.md

Lines changed: 33 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,44 @@
1-
---
2-
docname: python_airflow_operator
3-
images: {}
4-
path: /python-airflow-operator
5-
title: Armada Airflow Operator
6-
---
7-
8-
# Armada Airflow Operator
9-
10-
This class provides integration with Airflow and Armada
1+
# Armada Airflow operator
2+
- [Armada Airflow operator](#armada-airflow-operator)
3+
- [armada.operators.armada module](#armadaoperatorsarmada-module)
4+
- [_class_ armada.operators.armada.ArmadaOperator(name, channel\_args, armada\_queue, job\_request, job\_set\_prefix='', lookout\_url\_template=None, poll\_interval=30, container\_logs=None, k8s\_token\_retriever=None, deferrable=False, job\_acknowledgement\_timeout=300, dry\_run=False, reattach\_policy=None, extra\_links=None, \*\*kwargs)](#class-armadaoperatorsarmadaarmadaoperatorname-channel_args-armada_queue-job_request-job_set_prefix-lookout_url_templatenone-poll_interval30-container_logsnone-k8s_token_retrievernone-deferrablefalse-job_acknowledgement_timeout300-dry_runfalse-reattach_policynone-extra_linksnone-kwargs)
5+
- [execute(context)](#executecontext)
6+
- [_property_ hook(_: ArmadaHoo_ )](#property-hook-armadahoo-)
7+
- [lookout\_url(job\_id)](#lookout_urljob_id)
8+
- [on\_kill()](#on_kill)
9+
- [_property_ pod\_manager(_: KubernetesPodLogManage_ )](#property-pod_manager-kubernetespodlogmanage-)
10+
- [render\_extra\_links\_urls(context, jinja\_env=None)](#render_extra_links_urlscontext-jinja_envnone)
11+
- [render\_template\_fields(context, jinja\_env=None)](#render_template_fieldscontext-jinja_envnone)
12+
- [template\_fields(_: Sequence\[str_ \_ = ('job\_request', 'job\_set\_prefix'\_ )](#template_fields-sequencestr-_--job_request-job_set_prefix_-)
13+
- [template\_fields\_renderers(_: Dict\[str, str_ \_ = {'job\_request': 'py'\_ )](#template_fields_renderers-dictstr-str-_--job_request-py_-)
14+
- [armada.triggers.armada module](#armadatriggersarmada-module)
15+
- [armada.auth module](#armadaauth-module)
16+
- [_class_ armada.auth.TokenRetriever(\*args, \*\*kwargs)](#class-armadaauthtokenretrieverargs-kwargs)
17+
- [get\_token()](#get_token)
18+
- [armada.model module](#armadamodel-module)
19+
- [_class_ armada.model.GrpcChannelArgs(target, options=None, compression=None, auth=None)](#class-armadamodelgrpcchannelargstarget-optionsnone-compressionnone-authnone)
20+
- [_static_ deserialize(data, version)](#static-deserializedata-version)
21+
- [serialize()](#serialize)
22+
- [_class_ armada.model.RunningJobContext(armada\_queue: 'str', job\_id: 'str', job\_set\_id: 'str', submit\_time: 'DateTime', cluster: 'Optional\[str\]' = None, last\_log\_time: 'Optional\[DateTime\]' = None, job\_state: 'str' = 'UNKNOWN')](#class-armadamodelrunningjobcontextarmada_queue-str-job_id-str-job_set_id-str-submit_time-datetime-cluster-optionalstr--none-last_log_time-optionaldatetime--none-job_state-str--unknown)
23+
- [armada\_queue(_: st_ )](#armada_queue-st-)
24+
- [cluster(_: str | Non_ \_ = Non\_ )](#cluster-str--non-_--non_-)
25+
- [job\_id(_: st_ )](#job_id-st-)
26+
- [job\_set\_id(_: st_ )](#job_set_id-st-)
27+
- [job\_state(_: st_ \_ = 'UNKNOWN\_ )](#job_state-st-_--unknown_-)
28+
- [last\_log\_time(_: DateTime | Non_ \_ = Non\_ )](#last_log_time-datetime--non-_--non_-)
29+
- [_property_ state(_: JobStat_ )](#property-state-jobstat-)
30+
- [submit\_time(_: DateTim_ )](#submit_time-datetim-)
31+
32+
This class provides integration with Airflow and Armada.
1133

1234
## armada.operators.armada module
1335

14-
1536
### _class_ armada.operators.armada.ArmadaOperator(name, channel_args, armada_queue, job_request, job_set_prefix='', lookout_url_template=None, poll_interval=30, container_logs=None, k8s_token_retriever=None, deferrable=False, job_acknowledgement_timeout=300, dry_run=False, reattach_policy=None, extra_links=None, \*\*kwargs)
1637
Bases: `BaseOperator`, `LoggingMixin`
1738

1839
An Airflow operator that manages Job submission to Armada.
1940

20-
This operator submits a job to an Armada cluster, polls for its completion,
41+
This operator submits a job to an Armada cluster, polls for its completion
2142
and handles job cancellation if the Airflow task is killed.
2243

2344

docs/python_armada_client.md renamed to docs/armada_client_package.md

Lines changed: 41 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,48 @@
1-
---
2-
docname: python_armada_client
3-
images: {}
4-
path: /python-armada-client
5-
title: armada_client package
6-
---
7-
8-
# armada_client package
1+
# Armada client package
2+
- [Armada client package](#armada-client-package)
3+
- [armada\_client.client module](#armada_clientclient-module)
4+
- [_class_ armada\_client.client.ArmadaClient(channel, event\_timeout=datetime.timedelta(seconds=900))](#class-armada_clientclientarmadaclientchannel-event_timeoutdatetimetimedeltaseconds900)
5+
- [cancel\_jobs(queue, job\_set\_id, job\_id=None)](#cancel_jobsqueue-job_set_id-job_idnone)
6+
- [cancel\_jobset(queue, job\_set\_id, filter\_states)](#cancel_jobsetqueue-job_set_id-filter_states)
7+
- [create\_job\_request\_item(priority=1.0, pod\_spec=None, pod\_specs=None, namespace=None, client\_id=None, labels=None, annotations=None, required\_node\_labels=None, ingress=None, services=None)](#create_job_request_itempriority10-pod_specnone-pod_specsnone-namespacenone-client_idnone-labelsnone-annotationsnone-required_node_labelsnone-ingressnone-servicesnone)
8+
- [create\_queue(queue)](#create_queuequeue)
9+
- [create\_queue\_request(name, priority\_factor, user\_owners=None, group\_owners=None, resource\_limits=None, permissions=None)](#create_queue_requestname-priority_factor-user_ownersnone-group_ownersnone-resource_limitsnone-permissionsnone)
10+
- [create\_queues(queues)](#create_queuesqueues)
11+
- [delete\_queue(name)](#delete_queuename)
12+
- [event\_health()](#event_health)
13+
- [get\_job\_details(job\_ids)](#get_job_detailsjob_ids)
14+
- [get\_job\_errors(job\_ids)](#get_job_errorsjob_ids)
15+
- [get\_job\_events\_stream(queue, job\_set\_id, from\_message\_id=None)](#get_job_events_streamqueue-job_set_id-from_message_idnone)
16+
- [get\_job\_run\_details(run\_ids)](#get_job_run_detailsrun_ids)
17+
- [get\_job\_status(job\_ids)](#get_job_statusjob_ids)
18+
- [get\_job\_status\_by\_external\_job\_uri(queue, job\_set\_id, external\_job\_uri)](#get_job_status_by_external_job_uriqueue-job_set_id-external_job_uri)
19+
- [get\_queue(name)](#get_queuename)
20+
- [get\_queues()](#get_queues)
21+
- [preempt\_jobs(queue, job\_set\_id, job\_id)](#preempt_jobsqueue-job_set_id-job_id)
22+
- [reprioritize\_jobs(new\_priority, job\_ids, job\_set\_id, queue)](#reprioritize_jobsnew_priority-job_ids-job_set_id-queue)
23+
- [submit\_health()](#submit_health)
24+
- [submit\_jobs(queue, job\_set\_id, job\_request\_items)](#submit_jobsqueue-job_set_id-job_request_items)
25+
- [_static_ unmarshal\_event\_response(event)](#static-unmarshal_event_responseevent)
26+
- [_static_ unwatch\_events(event\_stream)](#static-unwatch_eventsevent_stream)
27+
- [update\_queue(queue)](#update_queuequeue)
28+
- [update\_queues(queues)](#update_queuesqueues)
29+
- [armada\_client.event module](#armada_clientevent-module)
30+
- [_class_ armada\_client.event.Event(event)](#class-armada_clienteventeventevent)
31+
- [armada\_client.permissions module](#armada_clientpermissions-module)
32+
- [_class_ armada\_client.permissions.Permissions(subjects, verbs)](#class-armada_clientpermissionspermissionssubjects-verbs)
33+
- [to\_grpc()](#to_grpc)
34+
- [_namedtuple_ armada\_client.permissions.Subject(kind, name)](#namedtuple-armada_clientpermissionssubjectkind-name)
35+
- [to\_grpc()](#to_grpc-1)
36+
- [armada\_client.log\_client module](#armada_clientlog_client-module)
37+
- [_class_ armada\_client.log\_client.JobLogClient(url, job\_id, disable\_ssl=False)](#class-armada_clientlog_clientjoblogclienturl-job_id-disable_sslfalse)
38+
- [logs(since\_time='')](#logssince_time)
39+
- [_class_ armada\_client.log\_client.LogLine(line, timestamp)](#class-armada_clientlog_clientloglineline-timestamp)
940

1041
## armada_client.client module
1142

1243
Armada Python GRPC Client
1344

14-
For the api definitions:
45+
For the API definitions:
1546
[https://armadaproject.io/api](https://armadaproject.io/api)
1647

1748

@@ -22,9 +53,7 @@ Client for accessing Armada over gRPC.
2253
* **Parameters**
2354

2455

25-
* **channel** – gRPC channel used for authentication. See
26-
[https://grpc.github.io/grpc/python/grpc.html](https://grpc.github.io/grpc/python/grpc.html)
27-
for more information.
56+
* **channel** – gRPC channel used for authentication. [See the gRPC documentation](https://grpc.github.io/grpc/python/grpc.html).
2857

2958

3059
* **event_timeout** (*datetime.timedelta*) –

0 commit comments

Comments
 (0)