Skip to content

Commit de92720

Browse files
authored
Deployer3 variables (#4)
* Removed References to IAP, changed variable names to match deployer * Got rid of default port * Cleaned up login and added a debug * Added documentation to the login module util * Changed references to "Platform" in the documentation to "Itential Platform" for clarity. * Missed a few "Platforms" * Fixed error in documentation. * Previous commit broke coverage report.
1 parent 32faf3a commit de92720

27 files changed

Lines changed: 129 additions & 114 deletions

README.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -32,75 +32,75 @@ export OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES
3232
## Available Modules
3333

3434
### Job Worker Management
35-
- **activate_job_worker**: Activate the job worker for an IAP system
35+
- **activate_job_worker**: Activate the job worker for an Itential Platform system
3636
```yaml
37-
- name: Activate IAP job worker
37+
- name: Activate Itential Platform job worker
3838
itential.platform.activate_job_worker:
3939
```
4040
41-
- **deactivate_job_worker**: Deactivate the job worker for an IAP system
41+
- **deactivate_job_worker**: Deactivate the job worker for an Itential Platform system
4242
```yaml
43-
- name: Deactivate IAP job worker
43+
- name: Deactivate Itential Platform job worker
4444
itential.platform.deactivate_job_worker:
4545
```
4646
4747
### Task Worker Management
48-
- **activate_task_worker**: Activate the task worker for an IAP system
48+
- **activate_task_worker**: Activate the task worker for an Itential Platform system
4949
```yaml
50-
- name: Activate IAP task worker
50+
- name: Activate Itential Platform task worker
5151
itential.platform.activate_task_worker:
5252
```
5353
54-
- **deactivate_task_worker**: Deactivate the task worker for an IAP system
54+
- **deactivate_task_worker**: Deactivate the task worker for an Itential Platform system
5555
```yaml
56-
- name: Deactivate IAP task worker
56+
- name: Deactivate Itential Platform task worker
5757
itential.platform.deactivate_task_worker:
5858
```
5959
6060
### System Information
61-
- **get_system_health**: Retrieve the health status of an IAP system
61+
- **get_system_health**: Retrieve the health status of an Itential Platform system
6262
```yaml
63-
- name: Get IAP system health
63+
- name: Get Itential Platform system health
6464
itential.platform.get_system_health:
6565
```
6666
67-
- **get_worker_status**: Get the current status of IAP workers
67+
- **get_worker_status**: Get the current status of Itential Platform workers
6868
```yaml
69-
- name: Get IAP worker status
69+
- name: Get Itential Platform worker status
7070
itential.platform.get_worker_status:
7171
```
7272
7373
### Job and Task Management
74-
- **get_jobs**: Retrieve a list of jobs from an IAP system
74+
- **get_jobs**: Retrieve a list of jobs from an Itential Platform system
7575
```yaml
76-
- name: Get IAP jobs
76+
- name: Get Itential Platform jobs
7777
itential.platform.get_jobs:
7878
```
7979
80-
- **get_tasks**: Retrieve a list of tasks from an IAP system
80+
- **get_tasks**: Retrieve a list of tasks from an Itential Platform system
8181
```yaml
82-
- name: Get IAP tasks
82+
- name: Get Itential Platform tasks
8383
itential.platform.get_tasks:
8484
```
8585
8686
### System Administration
87-
- **restart_adapter**: Restart a specific adapter in the IAP system
87+
- **restart_adapter**: Restart a specific adapter in the Itential Platform system
8888
```yaml
89-
- name: Restart IAP adapter
89+
- name: Restart Itential Platform adapter
9090
itential.platform.restart_adapter:
9191
adapter_name: "my-adapter"
9292
```
9393
94-
- **restart_application**: Restart the IAP application
94+
- **restart_application**: Restart the Itential Platform application
9595
```yaml
96-
- name: Restart IAP application
96+
- name: Restart Itential Platform application
9797
itential.platform.restart_application:
9898
```
9999
100100
### Connection Parameters
101101
Each module requires the following connection parameters which can be defined in your Ansible environment:
102-
- `host`: The hostname or IP of the IAP instance
103-
- `port`: The port number for the IAP API
102+
- `host`: The hostname or IP of the Itential Platform instance
103+
- `port`: The port number for the Itential Platform API
104104
- `use_tls`: Whether to use HTTPS (default: true)
105105
- `verify`: Whether to verify SSL certificates (default: true)
106106
- `disable_warnings`: Whether to disable SSL warning messages (default: false)

plugins/action/activate_job_worker.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
44
# SPDX-License-Identifier: GPL-3.0-or-later
55

6-
# Activates the IAP job worker. No parameters required.
6+
# Activates the Itential Platform job worker. No parameters required.
77
# Example:
88
# - name: Activate job worker
99
# itential.platform.activate_job_worker:

plugins/action/activate_task_worker.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
44
# SPDX-License-Identifier: GPL-3.0-or-later
55

6-
# Activates the IAP task worker. No parameters required.
6+
# Activates the Itential Platform task worker. No parameters required.
77
# Example:
88
# - name: Activate task worker
99
# itential.platform.activate_task_worker:

plugins/action/deactivate_job_worker.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
44
# SPDX-License-Identifier: GPL-3.0-or-later
55

6-
# Deactivates the IAP job worker. No parameters required.
6+
# Deactivates the Itential Platform job worker. No parameters required.
77
# Example:
88
# - name: Deactivate job worker
99
# itential.platform.deactivate_job_worker:

plugins/action/deactivate_task_worker.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
44
# SPDX-License-Identifier: GPL-3.0-or-later
55

6-
# Deactivates the IAP task worker. No parameters required.
6+
# Deactivates the Itential Platform task worker. No parameters required.
77
# Example:
88
# - name: Deactivate task worker
99
# itential.platform.deactivate_task_worker:

plugins/action/get_jobs.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
44
# SPDX-License-Identifier: GPL-3.0-or-later
55

6-
# Retrieves list of jobs from IAP. No parameters required.
6+
# Retrieves list of jobs from Itential Platform. No parameters required.
77
# Returns: List of job objects with their status and details.
88
# Example:
99
# - name: Get all jobs

plugins/action/get_system_health.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
44
# SPDX-License-Identifier: GPL-3.0-or-later
55

6-
# Retrieves IAP system health status. No parameters required.
6+
# Retrieves the Itential Platform system health status. No parameters required.
77
# Returns: System health information including component statuses.
88
# Example:
99
# - name: Get system health

plugins/action/get_tasks.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
44
# SPDX-License-Identifier: GPL-3.0-or-later
55

6-
# Retrieves list of tasks from IAP. Supports filtering via parameters.
6+
# Retrieves list of tasks from Itential Platform. Supports filtering via parameters.
77
# Returns: List of task objects with their status and details.
88
# Example:
99
# - name: Get tasks by status

plugins/action/get_worker_status.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
44
# SPDX-License-Identifier: GPL-3.0-or-later
55

6-
# Retrieves status of all IAP workers. No parameters required.
6+
# Retrieves status of all Itential Platform workers. No parameters required.
77
# Returns: Status information for job and task workers.
88
# Example:
99
# - name: Get worker status

plugins/action/restart_adapters.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
44
# SPDX-License-Identifier: GPL-3.0-or-later
55

6-
# Restarts one or more IAP adapters.
6+
# Restarts one or more Itential Platform adapters.
77
# Parameters:
88
# adapter_names: A single adapter name (str) or a list of adapter names (list).
99
#
@@ -34,7 +34,7 @@ class ActionModule(ActionBase):
3434
_requires_connection = False
3535

3636
def run(self, tmp=None, task_vars=None):
37-
"""Restart one or more IAP adapters by making API requests."""
37+
"""Restart one or more Itential Platform adapters by making API requests."""
3838

3939
adapter_names = self._task.args.get("adapter_names")
4040
if not adapter_names:

0 commit comments

Comments
 (0)