awxkit-async 1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- awxkit_async-1.0/PKG-INFO +209 -0
- awxkit_async-1.0/README.md +193 -0
- awxkit_async-1.0/awxkit_async/__init__.py +5 -0
- awxkit_async-1.0/awxkit_async/__main__.py +0 -0
- awxkit_async-1.0/awxkit_async/clients.py +176 -0
- awxkit_async-1.0/awxkit_async/enums.py +19 -0
- awxkit_async-1.0/awxkit_async/models.py +34 -0
- awxkit_async-1.0/awxkit_async/py.typed +0 -0
- awxkit_async-1.0/pyproject.toml +25 -0
|
@@ -0,0 +1,209 @@
|
|
|
1
|
+
Metadata-Version: 2.3
|
|
2
|
+
Name: awxkit-async
|
|
3
|
+
Version: 1.0
|
|
4
|
+
Summary: Библиотека для взаимодействия с awx посредством родительской библотеки awxkit
|
|
5
|
+
License: SCB
|
|
6
|
+
Author: Gluschenko Daniil
|
|
7
|
+
Author-email: gluschenkodm@sovcombank.group
|
|
8
|
+
Requires-Python: >=3.12
|
|
9
|
+
Classifier: License :: Other/Proprietary License
|
|
10
|
+
Classifier: Programming Language :: Python :: 3
|
|
11
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
13
|
+
Requires-Dist: awxkit (>=24.6.1,<25.0.0)
|
|
14
|
+
Description-Content-Type: text/markdown
|
|
15
|
+
|
|
16
|
+
# awxkit_async
|
|
17
|
+
|
|
18
|
+
Библиотека для взаимодействия с [AWX](https://github.com/ansible/awx) (частный случай Ansible Automation Controller) поверх родительской библиотеки [awxkit](https://pypi.org/project/awxkit/).
|
|
19
|
+
|
|
20
|
+
Она позволяет запускать **Job Template** и **Workflow Template**, а также получать статус запущенных задач. `awxkit_async` предоставляет как синхронный (`AWXClient`), так и асинхронный (`AsyncAWXClient`) интерфейс, построенный на `asyncio.to_thread` — это позволяет использовать её в `async`/`await` приложении, не блокируя event loop.
|
|
21
|
+
|
|
22
|
+
## Возможности
|
|
23
|
+
|
|
24
|
+
- Запуск Job Template и Workflow Template по ID.
|
|
25
|
+
- Передача `extra_vars` (переменных) и `limit` (ограничение по хостам) при запуске.
|
|
26
|
+
- Получение разового статуса запущенной задачи (без поллинга) с удобным объектом `JobStatusInfo`.
|
|
27
|
+
- Авторизация через OAuth2 Personal Access Token (Bearer).
|
|
28
|
+
- Синхронный и асинхронный интерфейсы.
|
|
29
|
+
- Полная поддержка типов (py.typed) для редакторов и линтеров.
|
|
30
|
+
|
|
31
|
+
## Требования
|
|
32
|
+
|
|
33
|
+
- Python >= 3.12
|
|
34
|
+
- Зависимость: `awxkit >= 24.6.1, < 25.0.0`
|
|
35
|
+
|
|
36
|
+
## Установка
|
|
37
|
+
|
|
38
|
+
Установка из приватного nexus-репозитория организации (в составе `pyproject.toml` уже объявлен источник):
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
poetry add awxkit-async
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Либо через `pip`, указав соответствующий `--index-url`.
|
|
45
|
+
|
|
46
|
+
## Быстрый старт
|
|
47
|
+
|
|
48
|
+
Для работы нужен **Personal Access Token** (PAT) из настроек AWX: `Users -> <ваш пользователь> -> Tokens` (тип OAuth2).
|
|
49
|
+
|
|
50
|
+
### Асинхронный клиент
|
|
51
|
+
|
|
52
|
+
```python
|
|
53
|
+
import asyncio
|
|
54
|
+
from awxkit_async import AsyncAWXClient, JobType, JobStatusInfo
|
|
55
|
+
|
|
56
|
+
BASE_URL = "https://ansible.example.com"
|
|
57
|
+
TOKEN = "ваш_token_здесь"
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
async def main():
|
|
61
|
+
client = AsyncAWXClient(BASE_URL, TOKEN)
|
|
62
|
+
|
|
63
|
+
# 1. Запуск Job Template (ID == 658)
|
|
64
|
+
job_id = await client.launch(658)
|
|
65
|
+
print(f"Запущена задача: {job_id}")
|
|
66
|
+
|
|
67
|
+
# 2. Запуск Workflow Template с переменными
|
|
68
|
+
wf_id = await client.launch(
|
|
69
|
+
55,
|
|
70
|
+
job_type=JobType.WORKFLOW,
|
|
71
|
+
extra_vars={"environment": "prod", "version": "1.2.3"},
|
|
72
|
+
)
|
|
73
|
+
print(f"Запущен workflow: {wf_id}")
|
|
74
|
+
|
|
75
|
+
# 3. Получить статус
|
|
76
|
+
status: JobStatusInfo = await client.get_status(job_id)
|
|
77
|
+
print(status.id, status.name, status.status, status.web_url)
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
asyncio.run(main())
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### Синхронный клиент
|
|
84
|
+
|
|
85
|
+
```python
|
|
86
|
+
from awxkit_async import AWXClient, JobType
|
|
87
|
+
|
|
88
|
+
client = AWXClient("https://ansible.example.com", "ваш_token_здесь")
|
|
89
|
+
|
|
90
|
+
job_id = client.launch(658, extra_vars={"foo": "bar"}, limit="host1,host2")
|
|
91
|
+
status = client.get_status(job_id)
|
|
92
|
+
|
|
93
|
+
print(status.status) # например "running"
|
|
94
|
+
print(status.is_successful) # True/False
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
## API
|
|
98
|
+
|
|
99
|
+
### Классы
|
|
100
|
+
|
|
101
|
+
#### `AWXClient`
|
|
102
|
+
Синхронный клиент.
|
|
103
|
+
|
|
104
|
+
```python
|
|
105
|
+
AWXClient(base_url: str, bearer_token: str, verify_ssl: bool = False)
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
- `base_url` — базовый URL инстанса AWX (например, `https://ansible.example.com`).
|
|
109
|
+
- `bearer_token` — OAuth2 Personal Access Token (Bearer).
|
|
110
|
+
- `verify_ssl` — проверять ли SSL-сертификат (по умолчанию `False`).
|
|
111
|
+
|
|
112
|
+
#### `AsyncAWXClient`
|
|
113
|
+
Асинхронная обёртка над `AWXClient`. Принимает те же аргументы. Все методы вызываются в отдельном потоке через `asyncio.to_thread`, поэтому event loop не блокируется.
|
|
114
|
+
|
|
115
|
+
### Методы
|
|
116
|
+
|
|
117
|
+
Оба клиента имеют одинаковые методы с одинаковой сигнатурой (кроме того, что асинхронные — `async def`).
|
|
118
|
+
|
|
119
|
+
#### `launch(...)` → `int`
|
|
120
|
+
Запускает Job Template или Workflow Template по ID и возвращает ID запущенной задачи.
|
|
121
|
+
|
|
122
|
+
| Параметр | Тип | По умолчанию | Описание |
|
|
123
|
+
|----------|-----|--------------|----------|
|
|
124
|
+
| `template_id` | `int` | — | ID шаблона задания или workflow. |
|
|
125
|
+
| `job_type` | `JobType` | `JobType.JOB` | Тип шаблона: `JobType.JOB` или `JobType.WORKFLOW`. |
|
|
126
|
+
| `extra_vars` | `Optional[Dict[str, Any]]` | `None` | Переменные. У шаблона должна быть включена опция *Prompt on launch*. |
|
|
127
|
+
| `limit` | `Optional[str]` | `None` | Ограничение по хостам. Игнорируется для Workflow. |
|
|
128
|
+
|
|
129
|
+
Асинхронная версия:
|
|
130
|
+
|
|
131
|
+
```python
|
|
132
|
+
job_id = await client.launch(template_id, job_type=JobType.WORKFLOW,
|
|
133
|
+
extra_vars={"a": 1}, limit="web-*")
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
#### `get_status(job_id, job_type=JobType.JOB)` → `JobStatusInfo`
|
|
137
|
+
Разово получает текущий статус запущенного задания **без поллинга**.
|
|
138
|
+
|
|
139
|
+
| Параметр | Тип | По умолчанию | Описание |
|
|
140
|
+
|----------|-----|--------------|----------|
|
|
141
|
+
| `job_id` | `int` | — | ID запущенной задачи (не шаблона). |
|
|
142
|
+
| `job_type` | `JobType` | `JobType.JOB` | Тип задачи: `JobType.JOB` или `JobType.WORKFLOW`. |
|
|
143
|
+
|
|
144
|
+
Асинхронная версия:
|
|
145
|
+
|
|
146
|
+
```python
|
|
147
|
+
status = await client.get_status(job_id)
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
### Перечисления (`enums.py`)
|
|
151
|
+
|
|
152
|
+
#### `JobType`
|
|
153
|
+
- `JobType.JOB` — Job Template (значение `"job"`).
|
|
154
|
+
- `JobType.WORKFLOW` — Workflow Template (значение `"workflow"`).
|
|
155
|
+
|
|
156
|
+
#### `JobState`
|
|
157
|
+
Возможные статусы выполнения задачи в AWX:
|
|
158
|
+
`NEW`, `PENDING`, `WAITING`, `RUNNING`, `SUCCESSFUL`, `FAILED`, `ERROR`, `CANCELED`.
|
|
159
|
+
|
|
160
|
+
### Модель (`models.py`)
|
|
161
|
+
|
|
162
|
+
#### `JobStatusInfo`
|
|
163
|
+
`@dataclass(frozen=True)` с информацией о статусе:
|
|
164
|
+
|
|
165
|
+
| Поле | Тип | Описание |
|
|
166
|
+
|------|-----|----------|
|
|
167
|
+
| `id` | `int` | ID задачи. |
|
|
168
|
+
| `name` | `str` | Название задачи. |
|
|
169
|
+
| `job_type` | `JobType` | Тип задачи. |
|
|
170
|
+
| `status` | `str` | Текущий статус (значение из `JobState`). |
|
|
171
|
+
| `failed` | `bool` | Флаг провала. |
|
|
172
|
+
| `started` | `Optional[str]` | Время запуска (ISO). |
|
|
173
|
+
| `finished` | `Optional[str]` | Время завершения (ISO). |
|
|
174
|
+
| `elapsed` | `float` | Время выполнения в секундах. |
|
|
175
|
+
| `explanation` | `str` | Пояснение к статусу. |
|
|
176
|
+
| `web_url` | `str` | Ссылка на задачу в веб-интерфейсе AWX. |
|
|
177
|
+
|
|
178
|
+
Дополнительные свойства:
|
|
179
|
+
|
|
180
|
+
- `status.is_finished` → `bool` — `True`, если задача достигла финального состояния (успешна, провалена, ошибка или отменена).
|
|
181
|
+
- `status.is_successful` → `bool` — `True`, если задача завершилась успешно (`JobState.SUCCESSFUL`).
|
|
182
|
+
|
|
183
|
+
## Пример: ожидание завершения задачи
|
|
184
|
+
|
|
185
|
+
Поскольку `get_status` выдаёт разовый статус без поллинга, ожидание завершения реализуется вручную:
|
|
186
|
+
|
|
187
|
+
```python
|
|
188
|
+
import asyncio
|
|
189
|
+
from awxkit_async import AsyncAWXClient, JobType
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
async def run_and_wait(client: AsyncAWXClient, template_id: int, timeout: int = 3600):
|
|
193
|
+
job_id = await client.launch(template_id)
|
|
194
|
+
deadline = asyncio.get_event_loop().time() + timeout
|
|
195
|
+
|
|
196
|
+
while asyncio.get_event_loop().time() < deadline:
|
|
197
|
+
status = await client.get_status(job_id)
|
|
198
|
+
if status.is_finished:
|
|
199
|
+
return status
|
|
200
|
+
await asyncio.sleep(5)
|
|
201
|
+
|
|
202
|
+
raise TimeoutError(f"Задача {job_id} не завершилась за {timeout}с")
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
## Замечания
|
|
206
|
+
|
|
207
|
+
- Ошибки отсутствующего шаблона/задачи выбрасываются как `Exception` с `status_code=404`.
|
|
208
|
+
- Прочие ошибки AWX пробрасываются из awxkit в исходном виде.
|
|
209
|
+
|
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
# awxkit_async
|
|
2
|
+
|
|
3
|
+
Библиотека для взаимодействия с [AWX](https://github.com/ansible/awx) (частный случай Ansible Automation Controller) поверх родительской библиотеки [awxkit](https://pypi.org/project/awxkit/).
|
|
4
|
+
|
|
5
|
+
Она позволяет запускать **Job Template** и **Workflow Template**, а также получать статус запущенных задач. `awxkit_async` предоставляет как синхронный (`AWXClient`), так и асинхронный (`AsyncAWXClient`) интерфейс, построенный на `asyncio.to_thread` — это позволяет использовать её в `async`/`await` приложении, не блокируя event loop.
|
|
6
|
+
|
|
7
|
+
## Возможности
|
|
8
|
+
|
|
9
|
+
- Запуск Job Template и Workflow Template по ID.
|
|
10
|
+
- Передача `extra_vars` (переменных) и `limit` (ограничение по хостам) при запуске.
|
|
11
|
+
- Получение разового статуса запущенной задачи (без поллинга) с удобным объектом `JobStatusInfo`.
|
|
12
|
+
- Авторизация через OAuth2 Personal Access Token (Bearer).
|
|
13
|
+
- Синхронный и асинхронный интерфейсы.
|
|
14
|
+
- Полная поддержка типов (py.typed) для редакторов и линтеров.
|
|
15
|
+
|
|
16
|
+
## Требования
|
|
17
|
+
|
|
18
|
+
- Python >= 3.12
|
|
19
|
+
- Зависимость: `awxkit >= 24.6.1, < 25.0.0`
|
|
20
|
+
|
|
21
|
+
## Установка
|
|
22
|
+
|
|
23
|
+
Установка из приватного nexus-репозитория организации (в составе `pyproject.toml` уже объявлен источник):
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
poetry add awxkit-async
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Либо через `pip`, указав соответствующий `--index-url`.
|
|
30
|
+
|
|
31
|
+
## Быстрый старт
|
|
32
|
+
|
|
33
|
+
Для работы нужен **Personal Access Token** (PAT) из настроек AWX: `Users -> <ваш пользователь> -> Tokens` (тип OAuth2).
|
|
34
|
+
|
|
35
|
+
### Асинхронный клиент
|
|
36
|
+
|
|
37
|
+
```python
|
|
38
|
+
import asyncio
|
|
39
|
+
from awxkit_async import AsyncAWXClient, JobType, JobStatusInfo
|
|
40
|
+
|
|
41
|
+
BASE_URL = "https://ansible.example.com"
|
|
42
|
+
TOKEN = "ваш_token_здесь"
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
async def main():
|
|
46
|
+
client = AsyncAWXClient(BASE_URL, TOKEN)
|
|
47
|
+
|
|
48
|
+
# 1. Запуск Job Template (ID == 658)
|
|
49
|
+
job_id = await client.launch(658)
|
|
50
|
+
print(f"Запущена задача: {job_id}")
|
|
51
|
+
|
|
52
|
+
# 2. Запуск Workflow Template с переменными
|
|
53
|
+
wf_id = await client.launch(
|
|
54
|
+
55,
|
|
55
|
+
job_type=JobType.WORKFLOW,
|
|
56
|
+
extra_vars={"environment": "prod", "version": "1.2.3"},
|
|
57
|
+
)
|
|
58
|
+
print(f"Запущен workflow: {wf_id}")
|
|
59
|
+
|
|
60
|
+
# 3. Получить статус
|
|
61
|
+
status: JobStatusInfo = await client.get_status(job_id)
|
|
62
|
+
print(status.id, status.name, status.status, status.web_url)
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
asyncio.run(main())
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Синхронный клиент
|
|
69
|
+
|
|
70
|
+
```python
|
|
71
|
+
from awxkit_async import AWXClient, JobType
|
|
72
|
+
|
|
73
|
+
client = AWXClient("https://ansible.example.com", "ваш_token_здесь")
|
|
74
|
+
|
|
75
|
+
job_id = client.launch(658, extra_vars={"foo": "bar"}, limit="host1,host2")
|
|
76
|
+
status = client.get_status(job_id)
|
|
77
|
+
|
|
78
|
+
print(status.status) # например "running"
|
|
79
|
+
print(status.is_successful) # True/False
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## API
|
|
83
|
+
|
|
84
|
+
### Классы
|
|
85
|
+
|
|
86
|
+
#### `AWXClient`
|
|
87
|
+
Синхронный клиент.
|
|
88
|
+
|
|
89
|
+
```python
|
|
90
|
+
AWXClient(base_url: str, bearer_token: str, verify_ssl: bool = False)
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
- `base_url` — базовый URL инстанса AWX (например, `https://ansible.example.com`).
|
|
94
|
+
- `bearer_token` — OAuth2 Personal Access Token (Bearer).
|
|
95
|
+
- `verify_ssl` — проверять ли SSL-сертификат (по умолчанию `False`).
|
|
96
|
+
|
|
97
|
+
#### `AsyncAWXClient`
|
|
98
|
+
Асинхронная обёртка над `AWXClient`. Принимает те же аргументы. Все методы вызываются в отдельном потоке через `asyncio.to_thread`, поэтому event loop не блокируется.
|
|
99
|
+
|
|
100
|
+
### Методы
|
|
101
|
+
|
|
102
|
+
Оба клиента имеют одинаковые методы с одинаковой сигнатурой (кроме того, что асинхронные — `async def`).
|
|
103
|
+
|
|
104
|
+
#### `launch(...)` → `int`
|
|
105
|
+
Запускает Job Template или Workflow Template по ID и возвращает ID запущенной задачи.
|
|
106
|
+
|
|
107
|
+
| Параметр | Тип | По умолчанию | Описание |
|
|
108
|
+
|----------|-----|--------------|----------|
|
|
109
|
+
| `template_id` | `int` | — | ID шаблона задания или workflow. |
|
|
110
|
+
| `job_type` | `JobType` | `JobType.JOB` | Тип шаблона: `JobType.JOB` или `JobType.WORKFLOW`. |
|
|
111
|
+
| `extra_vars` | `Optional[Dict[str, Any]]` | `None` | Переменные. У шаблона должна быть включена опция *Prompt on launch*. |
|
|
112
|
+
| `limit` | `Optional[str]` | `None` | Ограничение по хостам. Игнорируется для Workflow. |
|
|
113
|
+
|
|
114
|
+
Асинхронная версия:
|
|
115
|
+
|
|
116
|
+
```python
|
|
117
|
+
job_id = await client.launch(template_id, job_type=JobType.WORKFLOW,
|
|
118
|
+
extra_vars={"a": 1}, limit="web-*")
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
#### `get_status(job_id, job_type=JobType.JOB)` → `JobStatusInfo`
|
|
122
|
+
Разово получает текущий статус запущенного задания **без поллинга**.
|
|
123
|
+
|
|
124
|
+
| Параметр | Тип | По умолчанию | Описание |
|
|
125
|
+
|----------|-----|--------------|----------|
|
|
126
|
+
| `job_id` | `int` | — | ID запущенной задачи (не шаблона). |
|
|
127
|
+
| `job_type` | `JobType` | `JobType.JOB` | Тип задачи: `JobType.JOB` или `JobType.WORKFLOW`. |
|
|
128
|
+
|
|
129
|
+
Асинхронная версия:
|
|
130
|
+
|
|
131
|
+
```python
|
|
132
|
+
status = await client.get_status(job_id)
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### Перечисления (`enums.py`)
|
|
136
|
+
|
|
137
|
+
#### `JobType`
|
|
138
|
+
- `JobType.JOB` — Job Template (значение `"job"`).
|
|
139
|
+
- `JobType.WORKFLOW` — Workflow Template (значение `"workflow"`).
|
|
140
|
+
|
|
141
|
+
#### `JobState`
|
|
142
|
+
Возможные статусы выполнения задачи в AWX:
|
|
143
|
+
`NEW`, `PENDING`, `WAITING`, `RUNNING`, `SUCCESSFUL`, `FAILED`, `ERROR`, `CANCELED`.
|
|
144
|
+
|
|
145
|
+
### Модель (`models.py`)
|
|
146
|
+
|
|
147
|
+
#### `JobStatusInfo`
|
|
148
|
+
`@dataclass(frozen=True)` с информацией о статусе:
|
|
149
|
+
|
|
150
|
+
| Поле | Тип | Описание |
|
|
151
|
+
|------|-----|----------|
|
|
152
|
+
| `id` | `int` | ID задачи. |
|
|
153
|
+
| `name` | `str` | Название задачи. |
|
|
154
|
+
| `job_type` | `JobType` | Тип задачи. |
|
|
155
|
+
| `status` | `str` | Текущий статус (значение из `JobState`). |
|
|
156
|
+
| `failed` | `bool` | Флаг провала. |
|
|
157
|
+
| `started` | `Optional[str]` | Время запуска (ISO). |
|
|
158
|
+
| `finished` | `Optional[str]` | Время завершения (ISO). |
|
|
159
|
+
| `elapsed` | `float` | Время выполнения в секундах. |
|
|
160
|
+
| `explanation` | `str` | Пояснение к статусу. |
|
|
161
|
+
| `web_url` | `str` | Ссылка на задачу в веб-интерфейсе AWX. |
|
|
162
|
+
|
|
163
|
+
Дополнительные свойства:
|
|
164
|
+
|
|
165
|
+
- `status.is_finished` → `bool` — `True`, если задача достигла финального состояния (успешна, провалена, ошибка или отменена).
|
|
166
|
+
- `status.is_successful` → `bool` — `True`, если задача завершилась успешно (`JobState.SUCCESSFUL`).
|
|
167
|
+
|
|
168
|
+
## Пример: ожидание завершения задачи
|
|
169
|
+
|
|
170
|
+
Поскольку `get_status` выдаёт разовый статус без поллинга, ожидание завершения реализуется вручную:
|
|
171
|
+
|
|
172
|
+
```python
|
|
173
|
+
import asyncio
|
|
174
|
+
from awxkit_async import AsyncAWXClient, JobType
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
async def run_and_wait(client: AsyncAWXClient, template_id: int, timeout: int = 3600):
|
|
178
|
+
job_id = await client.launch(template_id)
|
|
179
|
+
deadline = asyncio.get_event_loop().time() + timeout
|
|
180
|
+
|
|
181
|
+
while asyncio.get_event_loop().time() < deadline:
|
|
182
|
+
status = await client.get_status(job_id)
|
|
183
|
+
if status.is_finished:
|
|
184
|
+
return status
|
|
185
|
+
await asyncio.sleep(5)
|
|
186
|
+
|
|
187
|
+
raise TimeoutError(f"Задача {job_id} не завершилась за {timeout}с")
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
## Замечания
|
|
191
|
+
|
|
192
|
+
- Ошибки отсутствующего шаблона/задачи выбрасываются как `Exception` с `status_code=404`.
|
|
193
|
+
- Прочие ошибки AWX пробрасываются из awxkit в исходном виде.
|
|
File without changes
|
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
import json
|
|
2
|
+
import urllib3
|
|
3
|
+
import asyncio
|
|
4
|
+
from typing import Optional, Dict, Any
|
|
5
|
+
|
|
6
|
+
from awxkit.api import ApiV2
|
|
7
|
+
from awxkit.config import config
|
|
8
|
+
|
|
9
|
+
from awxkit_async.enums import JobType
|
|
10
|
+
from awxkit_async.models import JobStatusInfo
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
|
|
14
|
+
|
|
15
|
+
class AWXClient:
|
|
16
|
+
"""Клиент для работы с AWX API через библиотеку awxkit."""
|
|
17
|
+
|
|
18
|
+
def __init__(
|
|
19
|
+
self,
|
|
20
|
+
base_url: str,
|
|
21
|
+
bearer_token: str,
|
|
22
|
+
verify_ssl: bool = False,
|
|
23
|
+
):
|
|
24
|
+
"""
|
|
25
|
+
Инициализирует подключение к AWX по Bearer-токену.
|
|
26
|
+
|
|
27
|
+
:param base_url: Базовый URL инстанса AWX (например, 'https://example.com')
|
|
28
|
+
:param bearer_token: OAuth2 Personal Access Token (Bearer)
|
|
29
|
+
:param verify_ssl: Проверять ли SSL-сертификат
|
|
30
|
+
"""
|
|
31
|
+
self.base_url = base_url.rstrip("/")
|
|
32
|
+
config.base_url = self.base_url
|
|
33
|
+
config.use_sessions = False
|
|
34
|
+
|
|
35
|
+
self.api = ApiV2()
|
|
36
|
+
self.api.connection.session.verify = verify_ssl
|
|
37
|
+
self.api.connection.session.headers.update({
|
|
38
|
+
"Authorization": f"Bearer {bearer_token}",
|
|
39
|
+
"Content-Type": "application/json",
|
|
40
|
+
"Accept": "application/json",
|
|
41
|
+
})
|
|
42
|
+
|
|
43
|
+
self.root = self.api.get()
|
|
44
|
+
|
|
45
|
+
def launch(
|
|
46
|
+
self,
|
|
47
|
+
template_id: int,
|
|
48
|
+
job_type: JobType = JobType.JOB,
|
|
49
|
+
extra_vars: Optional[Dict[str, Any]] = None,
|
|
50
|
+
limit: Optional[str] = None,
|
|
51
|
+
) -> int:
|
|
52
|
+
"""
|
|
53
|
+
Универсальный метод запуска Job Template или Workflow Template по ID.
|
|
54
|
+
|
|
55
|
+
:param template_id: ID шаблона задания или workflow
|
|
56
|
+
:param job_type: Тип запускаемого шаблона (JobType.JOB или JobType.WORKFLOW)
|
|
57
|
+
:param extra_vars: Словарь с переменными (должен быть включен Prompt on launch)
|
|
58
|
+
:param limit: Ограничение по хостам (игнорируется для Workflow)
|
|
59
|
+
:return: int: id запущенного job
|
|
60
|
+
"""
|
|
61
|
+
if job_type == JobType.WORKFLOW:
|
|
62
|
+
endpoint = self.root.workflow_job_templates
|
|
63
|
+
elif job_type == JobType.JOB:
|
|
64
|
+
endpoint = self.root.job_templates
|
|
65
|
+
else:
|
|
66
|
+
raise ValueError(f"Неподдерживаемый тип задачи: {job_type}")
|
|
67
|
+
|
|
68
|
+
response = endpoint.get(id=template_id)
|
|
69
|
+
if not response.results:
|
|
70
|
+
raise Exception(f"Шаблон с ID {template_id} не найден.", status_code=404)
|
|
71
|
+
|
|
72
|
+
template = response.results[0]
|
|
73
|
+
payload = self._build_payload(extra_vars=extra_vars, limit=limit)
|
|
74
|
+
launched_job = template.launch(payload=payload)
|
|
75
|
+
return int(launched_job.id)
|
|
76
|
+
|
|
77
|
+
def get_status(self, job_id: int, job_type: JobType = JobType.JOB) -> JobStatusInfo:
|
|
78
|
+
"""
|
|
79
|
+
Разово получает текущий статус запущенного Job или Workflow без поллинга.
|
|
80
|
+
|
|
81
|
+
:param job_id: ID запущенного задания (не шаблона)
|
|
82
|
+
:param job_type: Тип задачи (JobType.JOB или JobType.WORKFLOW)
|
|
83
|
+
:return: JobStatusInfo: Объект статуса задания
|
|
84
|
+
"""
|
|
85
|
+
if job_type == JobType.WORKFLOW:
|
|
86
|
+
endpoint = self.root.workflow_jobs
|
|
87
|
+
ui_path = f"/#/jobs/workflow/{job_id}"
|
|
88
|
+
elif job_type == JobType.JOB:
|
|
89
|
+
endpoint = self.root.jobs
|
|
90
|
+
ui_path = f"/#/jobs/playbook/{job_id}/output"
|
|
91
|
+
else:
|
|
92
|
+
raise ValueError(f"Неподдерживаемый тип задачи: {job_type}")
|
|
93
|
+
|
|
94
|
+
response = endpoint.get(id=job_id)
|
|
95
|
+
if not response.results:
|
|
96
|
+
raise Exception(f"Задача с ID {job_id} не найдена.", status_code=404)
|
|
97
|
+
|
|
98
|
+
job_instance = response.results[0]
|
|
99
|
+
return JobStatusInfo(
|
|
100
|
+
id=job_instance.id,
|
|
101
|
+
name=getattr(job_instance, "name", ""),
|
|
102
|
+
job_type=job_type,
|
|
103
|
+
status=job_instance.status,
|
|
104
|
+
failed=bool(getattr(job_instance, "failed", False)),
|
|
105
|
+
started=getattr(job_instance, "started", None),
|
|
106
|
+
finished=getattr(job_instance, "finished", None),
|
|
107
|
+
elapsed=float(getattr(job_instance, "elapsed", 0.0) or 0.0),
|
|
108
|
+
explanation=getattr(job_instance, "job_explanation", "") or "",
|
|
109
|
+
web_url=f"{self.base_url}{ui_path}",
|
|
110
|
+
)
|
|
111
|
+
|
|
112
|
+
@staticmethod
|
|
113
|
+
def _build_payload(
|
|
114
|
+
extra_vars: Optional[Dict[str, Any]] = None,
|
|
115
|
+
limit: Optional[str] = None,
|
|
116
|
+
) -> Dict[str, Any]:
|
|
117
|
+
"""Формирует словарь параметров для запуска."""
|
|
118
|
+
payload: Dict[str, Any] = {}
|
|
119
|
+
if extra_vars:
|
|
120
|
+
payload["extra_vars"] = json.dumps(extra_vars)
|
|
121
|
+
if limit:
|
|
122
|
+
payload["limit"] = limit
|
|
123
|
+
return payload
|
|
124
|
+
|
|
125
|
+
class AsyncAWXClient:
|
|
126
|
+
"""Асинхронная обертка над AWXClient с использованием asyncio.to_thread."""
|
|
127
|
+
|
|
128
|
+
def __init__(
|
|
129
|
+
self,
|
|
130
|
+
base_url: str,
|
|
131
|
+
bearer_token: str,
|
|
132
|
+
verify_ssl: bool = False,
|
|
133
|
+
):
|
|
134
|
+
self._client = AWXClient(
|
|
135
|
+
base_url=base_url,
|
|
136
|
+
bearer_token=bearer_token,
|
|
137
|
+
verify_ssl=verify_ssl,
|
|
138
|
+
)
|
|
139
|
+
|
|
140
|
+
async def launch(
|
|
141
|
+
self,
|
|
142
|
+
template_id: int,
|
|
143
|
+
job_type: JobType = JobType.JOB,
|
|
144
|
+
extra_vars: Optional[Dict[str, Any]] = None,
|
|
145
|
+
limit: Optional[str] = None,
|
|
146
|
+
):
|
|
147
|
+
"""
|
|
148
|
+
Универсальный метод запуска Job Template или Workflow Template по ID.
|
|
149
|
+
|
|
150
|
+
:param template_id: ID шаблона задания или workflow
|
|
151
|
+
:param job_type: Тип запускаемого шаблона (JobType.JOB или JobType.WORKFLOW)
|
|
152
|
+
:param extra_vars: Словарь с переменными (должен быть включен Prompt on launch)
|
|
153
|
+
:param limit: Ограничение по хостам (игнорируется для Workflow)
|
|
154
|
+
:return: int: id запущенного job
|
|
155
|
+
"""
|
|
156
|
+
return await asyncio.to_thread(
|
|
157
|
+
self._client.launch,
|
|
158
|
+
template_id=template_id,
|
|
159
|
+
job_type=job_type,
|
|
160
|
+
extra_vars=extra_vars,
|
|
161
|
+
limit=limit,
|
|
162
|
+
)
|
|
163
|
+
|
|
164
|
+
async def get_status(self, job_id: int, job_type: JobType = JobType.JOB) -> JobStatusInfo:
|
|
165
|
+
"""
|
|
166
|
+
Разово получает текущий статус запущенного Job или Workflow без поллинга.
|
|
167
|
+
|
|
168
|
+
:param job_id: ID запущенного задания (не шаблона)
|
|
169
|
+
:param job_type: Тип задачи (JobType.JOB или JobType.WORKFLOW)
|
|
170
|
+
:return: JobStatusInfo: Объект статуса задания
|
|
171
|
+
"""
|
|
172
|
+
return await asyncio.to_thread(
|
|
173
|
+
self._client.get_status,
|
|
174
|
+
job_id=job_id,
|
|
175
|
+
job_type=job_type,
|
|
176
|
+
)
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
from enum import StrEnum
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
class JobType(StrEnum):
|
|
5
|
+
"""Тип сущности в AWX."""
|
|
6
|
+
JOB = "job"
|
|
7
|
+
WORKFLOW = "workflow"
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class JobState(StrEnum):
|
|
11
|
+
"""Возможные статусы выполнения задачи в AWX."""
|
|
12
|
+
NEW = "new"
|
|
13
|
+
PENDING = "pending"
|
|
14
|
+
WAITING = "waiting"
|
|
15
|
+
RUNNING = "running"
|
|
16
|
+
SUCCESSFUL = "successful"
|
|
17
|
+
FAILED = "failed"
|
|
18
|
+
ERROR = "error"
|
|
19
|
+
CANCELED = "canceled"
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
from dataclasses import dataclass
|
|
2
|
+
from typing import Optional
|
|
3
|
+
|
|
4
|
+
from awxkit_async.enums import JobState, JobType
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
@dataclass(frozen=True)
|
|
8
|
+
class JobStatusInfo:
|
|
9
|
+
"""Объект с подробной информацией о статусе запущенного Job или Workflow."""
|
|
10
|
+
id: int
|
|
11
|
+
name: str
|
|
12
|
+
job_type: JobType
|
|
13
|
+
status: str
|
|
14
|
+
failed: bool
|
|
15
|
+
started: Optional[str] = None
|
|
16
|
+
finished: Optional[str] = None
|
|
17
|
+
elapsed: float = 0.0
|
|
18
|
+
explanation: str = ""
|
|
19
|
+
web_url: str = ""
|
|
20
|
+
|
|
21
|
+
@property
|
|
22
|
+
def is_finished(self) -> bool:
|
|
23
|
+
"""Возвращает True, если задача достигла финального состояния."""
|
|
24
|
+
return self.status in {
|
|
25
|
+
JobState.SUCCESSFUL,
|
|
26
|
+
JobState.FAILED,
|
|
27
|
+
JobState.ERROR,
|
|
28
|
+
JobState.CANCELED,
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
@property
|
|
32
|
+
def is_successful(self) -> bool:
|
|
33
|
+
"""Возвращает True, если задача завершилась успешно."""
|
|
34
|
+
return self.status == JobState.SUCCESSFUL
|
|
File without changes
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "awxkit-async"
|
|
3
|
+
version = "1.0"
|
|
4
|
+
description = "Библиотека для взаимодействия с awx посредством родительской библотеки awxkit"
|
|
5
|
+
authors = [
|
|
6
|
+
{name = "Gluschenko Daniil",email = "gluschenkodm@sovcombank.group"}
|
|
7
|
+
]
|
|
8
|
+
license = {text = "SCB"}
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.12"
|
|
11
|
+
dependencies = [
|
|
12
|
+
"awxkit (>=24.6.1,<25.0.0)"
|
|
13
|
+
]
|
|
14
|
+
|
|
15
|
+
[tool.poetry]
|
|
16
|
+
include = ["awxkit_async/py.typed"]
|
|
17
|
+
|
|
18
|
+
[[tool.poetry.source]]
|
|
19
|
+
name = "nexus"
|
|
20
|
+
url = "https://nexus.sovcombank.group/repository/pypi-proxy/simple/"
|
|
21
|
+
priority = "primary"
|
|
22
|
+
|
|
23
|
+
[build-system]
|
|
24
|
+
requires = ["poetry-core>=2.0.0,<3.0.0"]
|
|
25
|
+
build-backend = "poetry.core.masonry.api"
|