Deployment API
Overview
Deployment API performs the following operations:
- Enables the API client communication and exchange of necessary configuration data in the deployment process.
- Supports user with setting up Edge deployment and RabbitMQ user handling, and helps to connect system to target Uyuni server.
- In our Deployment API we defined a set of methods allowing to communicate with Uyuni API and RabbitMQ Management HTTP API.
- Allows API client to obtain a list of the failed system IDs and last check-in information for the given system action IDs.
Uyuni System Configuration is one of the essential steps for successful Edge Deployment.
Features
By using the following API calls, user can easily automate many of the tasks:
- GET/healthCheck - enables to check health of the backend systems.
- POST/saltkeys/search - returns a list of salt keys with the following statuses: accepted, pending, rejected, denied.
- POST/saltkeys/accept - enables to accept the connection key.
- POST/saltkeys/delete - enables to deregister a salt key.
- GET/system/getId - enables to obtain system IDs and last check in information for the given system.
- POST/system/deleteSystem - enables to delete a system.
- POST/system/scheduleApplyHighstate - enables to apply highstate settings to the registered system.
- POST/system/scheduleApplyStates - on successfully registering the system in Uyuni, user can assign states to the given system.
- GET/actions/{id} - returns details of an action based on an action identifier.
- PUT /users/{name} - enables the API client to create a RabbitMQ individual user.
- DELETE /users/bulk-delete - bulk deletes a list of RabbitMQ users.
- PUT /permissions/{vhost}/{user} - assigns user to virtual host and defines user permissions.
- GET /actions/listFailedSystems - allows the API client to obtain a list of the failed system IDs and last check-in information for the given system action IDs.
- GET /actions/listCompletedSystems - allows the API client to obtain a list of the completed system IDs and last check-in information for the given system action IDs.
- DELETE /queues/{vhost}/{name} - enables the API client to delete a RabbitMQ queue.
- DELETE /queues/{vhost}/{name}/contents - enables the API client to delete the contents of a RabbitMQ queue.
- GET /system/getDmi - retrieves the DMI information of a system.
- GET /system/getNetworkDevices - returns the network devices for the given server.
- GET /system/getEventDetails - allows the API client to obtain system IDs and event IDs last check-in information for the specified system name.
- GET /systemgroup/listSystems - retrieves a list of systems associated with the specified system group. The user must have access to that system group.
- POST /system/custominfo/createKey - creates a new system key.
- POST /system/custominfo/deleteKey - deletes an existing system key and all system values for the key.
- POST /system/custominfo/updateKey - updates the description of the system key.
- GET /system/custominfo/listAllKeys - retrieves the list of the system information keys defined for the users organization.
Benefits
Public Deployment API enables to use different deployment management backends.
Uyuni is a systems management solution which uses Salt to provide event-driven configuration and management control. Uyuni allows to maintain a high level of security while effectively managing system life-cycle requirements.
RabbitMQ is a message-queueing software also known as a message broker or queue manager.
Security
The Deployment API supports OAuth 2.0 for authentication purposes.
The supported protocol for the Deployment API is HTTPS.