vRealize Automation Component Registry API
Component Registry Service API Specification
What is the Component Registry Service?
The component registry service is one of the key services in the vRealize Automation distributed architecture. It manages all services (including out-of-the-box services and services from third party solution providers) and serves as the central view for all service lookups. Clients of the component registry service interact with it to obtain service information and related endpoint data.
The component registry service provides:
- A central location for services to publish their service information and endpoints (for both out-of-the-box services and third party services).
- A central location for clients to query services information and endpoints.
- An endpoint configuration capability for services not directly integrated in the application. The external services are treated in the same way as out-of-the-box services.
A service provides a set of related functionalities/features. A service may use functions (i.e., endpoints) provided by other services. For example, the shell-ui-app service uses some features of the catalog service. Most of the services use the SSO service for authentication.
A service endpoint provides a specific function or subfeature of a service. A service generally has many endpoints.
A provider of services via endpoints. For example, the catalog service provides catalog features for the shell-ui-app service to consume.
A service that uses functions provided by other services. For example, a pure service consumer such as the vRA UI (shell-ui-app) only consumes services without providing services of its own. But a mixed service consumer such as the event log service provides its own services as well as consuming other services.
How the Component Registry Service Works
Understanding the Relationships
The component registry stores details on all services and their associated endpoints. Before interacting with the component registry, it's helpful to grasp the relationships that come into play.
- A service type identifies a deployable product or common service that can be connected to the application; for example, "catalog service," "composition service," or "software service."
- A service identifies a deployed instance of that product or common service; for example, the instance of "composition service" installed on machine X. In most cases, there is a single service instance for a given service type.
- A service can have multiple endpoints, but can have only one endpoint instance per endpoint type. Each endpoint points to a URL that provides a specific API to that service.
- The exact API provided by an endpoint is identified by an endpoint type. Endpoint types enable consumers of a service to obtain the endpoint corresponding to the interface they require.
Here's a hypothetical example that hopefully makes things a little clearer:
Suppose there is a monitoring service (MS) to report on and remediate issues with the health of services in the application. This might require each compliant service in the product to register an endpoint that exposes an API for the MS to periodically query the health of that service.
In this scenario, the MS would define an endpoint type "Service Health" associated with a published API standard. Each compliant service would register an endpoint referencing that endpoint type and implementing that standard. To survey the health of components in the application, the MS iterates through the services, looks up the "Service Health" endpoint for each service, and then queries that endpoint to retrieve the health status.
Here is a programming analogy:
- An endpoint type is like an "interface" defining a set of methods that can be invoked.
- An endpoint is an actual "object" that implements that interface.
Important Note: A service endpoint lets a service consumer know where to access the endpoint. However, the endpoint does not provide automatic service binding. The service consumer needs to know how to use the API provided by the service provider endpoint without any assistance from the component registry.
Viewing Services and Their Endpoints
All GET methods are available to any authenticated user. Below are some quick examples of common component-registry HTTP GET commands:
- View all service types:
- View all services:
- View all endpoints associated to a specific service:
- View all endpoints:
- View all endpoint types:
Drill down into the documentation to find more information on how to query the component registry.
Registering New Services to the Component Registry
Most write operations in the component registry are only available to solution users (users registered to the SSO server). To register a new solution user to the SSO server, one must use the vRA SDK or the SSO API/SDK. A non-solution user can use the
/component-registry/registration API to do this. Below are some quick examples of component registry HTTP commands that manage the component registry:
- Add/Register a new service as a solution user:
- Register a new solution user and a new service (performed as a non-solution user):
- Unregister a service:
- Register endpoint:
Drill down into the documentation to find more detailed information on how register services with the component registry.
Other Resources Provided by the Component Registry
The component registry also provides helpful REST resources such as
Related Sample Code
- vRealize Automation - Component RegistryvRealize Automation - Component Registry Component Registry manages all services (including out-of-the-box services and services from third party solution providers) and serves as the central view for ...api_vra_component_registry vRealize Automation POSTMAN Collection
- vRealize Automation API Samples for PostmanvRealize Automation API Samples for Postman Overview The vRealize Automation REST API provides consumers and administrators access to all services in its service catalog that support the vRealize Auto ...vRealize Automation POSTMAN CollectionDownload
Updated 1 month
- vRealize Automation - Catalog ServicevRealize Automation - Catalog Service The catalog service REST API is designed to be used by the consumers of the service catalog; for example, an end user who wants to request a catalog item would be ...api_vra_catalog vRealize Automation api_vra_composition POSTMAN CollectionDownload
Updated 4 months
- vRealize Automation - NSX IntegrationvRealize Automation - NSX Integration NSX integration in vRealize Automation can help creating and configuring existing networks, on-demand NAT networks and on-demand routed networks, creating load ba ...vRealize Automation api_vra_network POSTMAN Collection
- vRealize Automation - Composition ServicevRealize Automation - Composition Service The composition service allows vRA services to register application components, which the composition service manages so that they can be used in composite bl ...vRealize Automation api_vra_composition POSTMAN Collection
- vRealize Automation - Identity ServicevRealize Automation - Identity Service Identity service manages tenants, business groups (formerly named subtenants), groups (both Single-Sign-On and Custom groups), users and identity stores. It also ...vRealize Automation api_vra_identity POSTMAN Collection
- VMware vRealize Automation PluginJenkins vRealize Automation Plugin The vRealize Automation Jenkins plugin enables Jenkins to provision vRealize Automation 7 Blueprints. Requirements Jenkins 1.58+ Java 8 to compile plugin or Java 7 ...vRealize Automation JavaDownload
Updated 8 months
- vRealize Automation - Management Service APIvRealize Automation - Management Service API You can use the reclamation service to query the VMs in an installation for non-usage and, if they are not in use, mark them as eligible for reclamation. ...vRealize Automation api_vra_management POSTMAN Collection
- vRealize Automation - Content Management ServicevRealize Automation - Content Management Service You can use the content management service REST API to import and export content, such as blueprints, software components, and other artifacts, from vR ...vRealize Automation api_vra_content_management api_vra_composition POSTMAN Collection
- vRealize Automation - Event BrokervRealize Automation - Event Broker The event broker provides features for managing subscriptions, event topics, events, and messages. Available Use Case Get event topics Registers or updates an Even ...vRealize Automation api_vra_event_broker POSTMAN Collection
- Extend Disk vRealize Automation WorkflowThis VMware Orchestrator workflow package will extend the C drive of a virtual disk in vRealize Automation from a vCenter (vSphere) machine template blueprint. The workflow receives a payload of prope ...vRealize Orchestrator Plug-in SDK vRealize Automation vRO PackageDownload
Updated 1 year
- vRealize Automation - BrandingvRealize Automation - Branding The Branding service enables the user to customize the VRA UI header and footer. The configurable properties include logo image, company name, product name, background c ...api_vra_branding vRealize Automation POSTMAN Collection
- vRealize Automation - Properties ServicevRealize Automation - Properties Service The property service provides APIs to manage property definitions and property groups. Available Use Cases Manage property definitions Manage property groups ...api_vra_properties vRealize Automation POSTMAN Collection
- vRealize Automation - Approval ServicevRealize Automation - Approval Service The approval service provides features for managing and tracking the human approval tasks associated with a service process/artifact in a provider realm. It also ...api_vra_approval vRealize Automation POSTMAN Collection
- vRealize Automation - WorkItem ServicevRealize Automation - WorkItem Service The work item service provides a standard way for services to present work items to users. It manages the life-cycle of a work item and passes events back to the ...api_vra_approval api_vra_workitem vRealize Automation POSTMAN Collection
Updated 1 year
- vRA 7 and above prepare_vra_template.ps1Powershell script designed to deploy the needed agents on your windows template. This mimics the prepare_vra_template.sh file for linux and will deploy java, bootstrap and gugent agents from the vRA a ...vRealize Automation PowerShellDownload
Updated 1 year
- chef-client example of a bootstrap install on Ubuntu 16.04A basic example to install the chef-client via the install.sh from Chef Software. This should be noted that this only requires wget and bash, so this can work for CentOS, RHEL, debian, Ubuntu, and the ...vRealize Automation vRA BlueprintDownload
Updated 2 years