Skip to content

Commit

Permalink
Updating Github Pages branch with latest Master changes
Browse files Browse the repository at this point in the history
  • Loading branch information
armada-admin committed Nov 27, 2024
1 parent e268320 commit 07a600f
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 2 deletions.
2 changes: 1 addition & 1 deletion developer/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ For Kerberos authentication API accepts the same authorization metadata for gRPC
Armada will determine which actions you are able to perform based on your user's permissions.
These are defined as global or on a per queue basis.

Below is the list of global Armada permissions (defined [here](https://github.com/armadaproject/armada/blob/master/internal/armada/permissions/permissions.go)):
Below is the list of global Armada permissions (defined [here](https://github.com/armadaproject/armada/blob/master/internal/server/permissions/permissions.go)):
* `submit_any_jobs`
* `create_queue`
* `delete_queue`
Expand Down
7 changes: 6 additions & 1 deletion python_airflow_operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This class provides integration with Airflow and Armada
## armada.operators.armada module


### _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, \*\*kwargs)
### _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, \*\*kwargs)
Bases: `BaseOperator`, `LoggingMixin`

An Airflow operator that manages Job submission to Armada.
Expand Down Expand Up @@ -60,6 +60,9 @@ and handles job cancellation if the Airflow task is killed.
* **dry_run** (*bool*) –


* **reattach_policy** (*Optional**[**str**] **| **Callable**[**[**JobState**, **str**]**, **bool**]*) –



#### execute(context)
Submits the job to Armada and polls for completion.
Expand Down Expand Up @@ -167,6 +170,8 @@ acknowledged by Armada.
:type job_acknowledgement_timeout: int
:param dry_run: Run Operator in dry-run mode - render Armada request and terminate.
:type dry_run: bool
:param reattach_policy: Operator reattach policy to use (defaults to: never)
:type reattach_policy: Optional[str] | Callable[[JobState, str], bool]
:param kwargs: Additional keyword arguments to pass to the BaseOperator.


Expand Down
61 changes: 61 additions & 0 deletions python_armada_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,38 @@ Retrieves the details of a job from Armada.



#### get_job_errors(job_ids)
Retrieves termination reason from query api.


* **Parameters**


* **queue** – The name of the queue


* **job_set_id** – The name of the job set (a grouping of jobs)


* **external_job_uri** – externalJobUri annotation value


* **job_ids** (*List**[**str**]*) –



* **Returns**

The response from the server containing the job errors.



* **Return type**

JobErrorsResponse



#### get_job_events_stream(queue, job_set_id, from_message_id=None)
Get event stream for a job set.

Expand Down Expand Up @@ -362,6 +394,35 @@ Retrieves the status of a list of jobs from Armada.



#### get_job_status_by_external_job_uri(queue, job_set_id, external_job_uri)
Retrieves the status of a job based on externalJobUri annotation.


* **Parameters**


* **queue** (*str*) – The name of the queue


* **job_set_id** (*str*) – The name of the job set (a grouping of jobs)


* **external_job_uri** (*str*) – externalJobUri annotation value



* **Returns**

The response from the server containing the job status.



* **Return type**

JobStatusResponse



#### get_queue(name)
Get the queue by name.

Expand Down

0 comments on commit 07a600f

Please sign in to comment.