Patent Application
20220237000
A typical software stack for configuration management of a system includes an application programming interface (API) layer, which provides an endpoint to configure and monitor the system, a business logic layer, which contains the API implementation, and a persistence layer, which persists any configuration or state changes in the system onto a disk. In the typical system, configuration actions performed by an end user are not persisted while the system is live. It is thus impossible to determine the configuration tasks previously performed by the user, especially after a long period of time has passed since boot-up of the system. Rather, only the resulting state of those tasks is persisted. The system can thus only report the current configuration state, and it is impossible to revert to a certain configuration state. In fact, it is difficult to even revert to the initial default configuration state.
The inability to determine the configuration tasks previously performed is especially problematic if the user must manage the system at a large scale. As the number of configurations that must be set and monitored increases, the complexity of managing the system grows. Only ad hoc solutions are available, and such solutions only provide configuration and compliance support for a limited set of configurations.
As disclosed in U.S. patent application Ser. No. 16/837,676, filed Apr. 1, 2020, the entire contents of which are incorporated by reference herein, a system may be implemented that defines which properties need to be persisted upfront in a configuration schema. The configuration schema may define such properties as either configurations or states. A configuration is data that the user provides as part of a configuration action. A state is data that the system generates internally, the state being further classified as either vital or cached. The system persists configurations and vital states across reboots but does not persist cached states.
By defining properties using configuration schemas, configuration actions can be tracked by storing updates to configurations in a database. As a result, configuration changes can be easily detected while the system is live. However, the system may include many services, including network time protocol (NTP) service, secure shell (SSH) service, authentication service, firewall service, network service, storage service, keyboard service, etc. It is still burdensome for the user to manage the configurations for all these different services separately.
Accordingly, one or more embodiments provide a method of managing configurations of a plurality of system services, including a first system service and a second system service, in each of a plurality of hosts, wherein each of the hosts is configured with a virtualization software for supporting execution of virtual machines therein. The method includes the steps of: upon receiving an application programming interface (API) call to apply configurations of the system services defined in a desired configuration file to the system services, parsing the desired configuration file to identify a first configuration for the first system service and a second configuration for the second system service, and storing the first and second configurations in accordance with a configuration schema defined for the first and second system services, wherein the first system service executes with the stored first configuration applied thereto and the second system service executes with the stored second configuration applied thereto.
Further embodiments include a non-transitory computer-readable storage medium comprising instructions that cause a computer system to carry out the above method, as well as a computer system configured to carry out the above method.
In computing system 300, configurations for system services are defined in schemas. Software publishers of system services define the schemas in schema definition files, e.g., VMware Managed Object Design Language 2 (VMODL2) files 302. Each VMODL2 file 302 corresponds to a system service (i.e., system services 1 through n).
Schema engine 310 is a physical or virtual server that processes VMODL2 files 302 and generates schemas from the VMODL2 files. In the embodiments illustrated herein, the schemas are in the format of JavaScript Object Notation (JSON) files 304. For each VMODL2 file 302, schema engine 310 generates an individual JSON file, e.g., SS1.schema.json, referred to herein as a “configuration schema.” Additionally, for each VMODL2 file 302 that contains a definition for a default configuration, schema engine 310 generates a default JSON file, e.g., SS1.default.json, referred to herein as a “default schema.” A default schema for a system service contains the initial configurations for the system service, and a host 340 may revert to these initial configurations as described in U.S. patent application Ser. No. 16/837,760, filed Apr. 1, 2020, the entire contents of which are incorporated by reference herein. In the example given in
Image depot 320 is a storage service that stores software installation bundles (SIBs) for system services executed on hosts 340, i.e., “SS1 SIB,” “SS2 SIB,” and “SSn SIB.” Each SIB contains the binaries for executing a system service on a host 340. Additionally, each SIB embeds JSON files generated by schema engine 310 in its metadata. For example, SS1 SIB contains the binaries for executing system service 1 and also embeds SS1.schema.json and SS1.default.json in its metadata.
Hosts 340 are servers that may be constructed on server grade hardware platforms such as x86 architecture platforms. Each host 340 contains a virtualization software layer (not shown) supporting a VM execution space for concurrently instantiating and executing VMs. Hosts 340 run system services based on configurations stored in key-value stores 360, which are persisted in local storage units 350.
Local storage units 350 are provisioned in shared storage that may comprise, e.g., magnetic disks or flash memory in a storage area network (SAN), and a separate local storage unit 350 is provisioned for each host 340. Each host 340 maintains its own key-value store 360 in local storage unit 350. In addition, each host 340 maintains a separate copy of master schema JSON file 352 and default JSON files 354.
Master schema JSON file 352 is the master configuration schema of all system services running in hosts 340. Each default JSON file 354 is the default configuration schema for one of the system services and contains the default configuration for that system service.
Each key-value store 360 is a database in which a “key” corresponds to a system service, and a corresponding “value” for the key stores one or more configuration properties and one or more internal states for that system service. The current configuration state of the system services running in each host 340 is maintained in key-value store 360 corresponding to that host 340. “Drift” occurs when the actual configuration state, as persisted in key-value store 360, deviates from the desired configuration state, as defined in a desired configuration JSON file 336 of a local storage unit 334 accessible by VM management server 330. The user defines the desired configuration state in desired configuration JSON file 336 using APIs 306 as described below.
VM management server 330 is a physical or virtual server that manages the lifecycle of VMs running in hosts 340. VM management server 330 also manages installation and configuration of system services in hosts 340. During installation of system services, hosts 340 retrieve binaries of the system services from image depot 320 and load them into memory for execution therein, and configuration manager 332 extracts the configuration schemas and any default schemas embedded in the metadata of these system services. Configuration manager 332 generates master schema JSON file 352 from the configuration schemas of these system services and stores master schema JSON file 352 in local storage units 350. In addition, configuration manager 332 stores any default schemas in local storage units 350.
Each host 340 contains a host configuration manager 342 for accessing key-value store 360 in response to an “apply” API call received from configuration manager 332. To make the apply API call, configuration manager 332 accesses desired configuration JSON file 336 from local storage unit 334 and transmits desired configuration JSON file 336 to host configuration manager 342 along with the apply API call. In response to the apply API call, host configuration manager 342 checks for drift by comparing the desired configuration state expressed in desired configuration JSON file 336 with the actual configuration state, as persisted in key-value store 360. If there is drift in any of the configuration objects, plug-ins (not shown) in host 340 update key-value store 360 to apply all the configurations that are in drift.
To configure system services running in hosts 340, an end user operates a UI (not shown) on VM management server 330 to make configuration API calls 306, which are exposed by configuration manager 332. Configuration API calls 306 include “set,” “update,” “delete,” and “get” API calls. In response, configuration manager 332 updates desired configuration JSON file 336 and makes an apply API call to host configuration managers 342 running in hosts 340 to apply the configurations defined in the updated desired configuration JSON file 336, as illustrated in
A set API call 306 creates or overwrites a configuration object in desired configuration JSON file 336 corresponding to the system service identified in the API call, as illustrated in
At step 410, configuration manager 332 initializes a master schema JSON file 352 without any configuration schemas. At step 412, configuration manager 332 retrieves all the SIBs from image depot 320, each SIB containing a configuration schema for a system service embedded in its metadata.
At step 414, configuration manager 332 selects a SIB, e.g., SS1 SIB. At step 416, configuration manager 332 extracts the configuration schema embedded in the selected SIB, e.g., SS1.schema.json. At step 418, configuration manager 332 adds the extracted configuration schema to the master schema JSON file 352 initialized at step 410.
At step 420, configuration manager 332 determines if there is a SIB for another system service to extract a configuration schema from. If there is, then method 400 moves back to step 414. Otherwise, method 400 ends.
At step 510, schema engine 310 reads VMODL2 files 302 that have been generated by software vendors of the system services. At step 512, schema engine 310 generates configuration schemas and default schemas from VMDOL2 files 302. For example, for the VMODL2 file 302 for system service 1, schema engine 310 generates SS1.schema.json and SS1.default.json.
At step 514, schema engine 310 embeds the configuration schemas and default schemas in the metadata of the SIBs of image depot 320. For example, schema engine 310 embeds copies of SS1.schema.json and SS1.default.json in the metadata of SS1 SIB.
At step 516, schema engine 310 filters out internal states defined in separate copies of the configuration schemas, thus leaving only configuration properties for the associated system services. At step 518, schema engine 310 generates a VMODL2 file from each filtered configuration schema. At step 520, schema engine 310 generates API documentation from the generated VMODL2 files. Specifically, schema engine 310 generates API documentation for set, update, delete, and get API calls for each system service.
At step 522, schema engine 310 transmits a notification to configuration manager 332 that the SIBs of image depot 320 are ready for retrieval of the schemas.
At step 524, configuration manager 332 retrieves the SIBs from image depot 320. At step 526, configuration manager 332 extracts the configuration schemas and default schemas from the retrieved SIBs. At step 528, configuration manager 332 generates master schema JSON file 352 from the configuration schemas extracted at step 526 according to the method of
At step 530, configuration manager 332 stores master schema JSON file 352 and the default JSON files in local storage units 350. After step 530, method 500 ends.
At step 610, configuration manager 332 determines if a condition for issuing an apply API call is satisfied for host 340. The condition for issuing an apply API call may be drift or an update to desired configuration JSON file 336 (e.g., when a user makes one of configuration API calls 306). Configuration manager 332 may periodically transmit a request to a host 340 to check for drift or may transmit a request in response to a user command.
At step 612, if the condition is not satisfied, configuration manager 332 returns to step 610 to check again if the condition for issuing an apply API call is satisfied. If the condition is satisfied, configuration manager 332 at step 614 transmits an apply API call to host 340 along with desired configuration JSON file 336.
At step 616, host configuration manager 342 parses desired configuration JSON file 336 for configuration objects. At step 618, host configuration manager 342 determines if any of the configuration objects are in drift, i.e., the actual state does not match the desired state. If not, method 600 ends. If so, host configuration manager 342 at step 620 executes plug-ins associated with the configuration objects in drift to apply the desired state and update the configuration objects in key-value store 360 in accordance with master schema JSON file 352.
If any updates to the configuration objects in key-value store 360 are not in accordance with master schema JSON file 352, host configuration manager 342 returns an error message to configuration manager 332, and method 600 ends.
The updates may include a creation of a key-value entry, an update to an existing key-value entry, or a deletion of an existing key-value entry. To create a key-value entry, a plug-in issues a “set” API command to key-value store 360. To update an existing key-value entry, the plug-in issues an “update” API command to key-value store 360. To delete an existing key-value entry, the plug-in issues a “delete” API command to key-value store 360.
After step 620, method 600 ends, and host 340 runs system services with the updated configurations specified in key-value store 360.
Lines 710 create the NTP configuration object. As shown in lines 712, the NTP configuration object contains a “server” configuration property, and the value for the server configuration property is “time.vmware.com.” Additionally, as shown in lines 714, the NTP configuration object contains a “drift” vital internal state that may be set with a value of type “double.”
Lines 716 create the keyboard configuration object. As shown in lines 718, no values have been set for the keyboard configuration object. However, the keyboard configuration object contains a “layout” configuration property that may be set with a value of type “string.” Additionally, the keyboard configuration object may contain one or more internal states (not shown).
Key-value store 360 contains an entry for an NTP configuration object. The NTP configuration object contains the value “time.vmware.com” for the server configuration property and a value for the drift internal state. There is no entry for a keyboard configuration object because no values have been set for the keyboard configuration object in desired configuration JSON file 336.
After the layout configuration property is set in desired configuration JSON file 336, configuration manager 332 issues an apply API call with desired configuration JSON file 336 to host 340 to match the actual configuration state with the desired configuration state. In response, host configuration manager 342 detects that the system service “keyboard” is in drift, and issues a second set API call, represented as lines 722, to update key-value store 360 to contain an entry for a keyboard configuration object. As in desired configuration JSON file 336, the keyboard configuration object contains the value “US Default” for the layout configuration property.
After the layout configuration property is updated in desired configuration JSON file 336, configuration manager 332 issues an apply API call with desired configuration JSON file 336 to host 340 to match the actual configuration state with the desired configuration state. In response, host configuration manager 342 detects that the system service “keyboard” is in drift, and issues a second update API call, represented as lines 732, to update key-value store 360. The layout configuration property in key-value store 360 is then updated from “US Default” to “Korean.”
After the layout configuration property is deleted from desired configuration JSON file 336, configuration manager 332 issues an apply API call with desired configuration JSON file 336 to host 340 to match the actual configuration state with the desired configuration state. In response, host configuration manager 342 detects that the system service “keyboard” is in drift, and issues a second delete API call, represented as lines 742, to key-value store 360. The layout configuration property in key-value store 360 is then deleted along with the keyboard configuration object.
The embodiments described herein may employ various computer-implemented operations involving data stored in computer systems. For example, these operations may require physical manipulation of physical quantities. Usually, though not necessarily, these quantities are electrical or magnetic signals that can be stored, transferred, combined, compared, or otherwise manipulated. Such manipulations are often referred to in terms such as producing, identifying, determining, or comparing. Any operations described herein that form part of one or more embodiments may be useful machine operations.
One or more embodiments of the invention also relate to a device or an apparatus for performing these operations. The apparatus may be specially constructed for required purposes, or the apparatus may be a general-purpose computer selectively activated or configured by a computer program stored in the computer. Various general-purpose machines may be used with computer programs written in accordance with the teachings herein, or it may be more convenient to construct a more specialized apparatus to perform the required operations.
The embodiments described herein may be practiced with other computer system configurations including hand-held devices, microprocessor systems, microprocessor-based or programmable consumer electronics, minicomputers, mainframe computers, etc.
One or more embodiments of the present invention may be implemented as one or more computer programs or as one or more computer program modules embodied in computer readable media. The term computer readable medium refers to any data storage device that can store data that can thereafter be input into a computer system. Computer readable media may be based on any existing or subsequently developed technology that embodies computer programs in a manner that enables a computer to read the programs. Examples of computer readable media are hard disk drives (HDDs), solid-state drives (SSDs), network-attached storage (NAS) systems, read-only memory (ROM), random-access memory (RAM), compact disks (CDs), digital versatile disks (DVDs), magnetic tapes, and other optical and non-optical data storage devices. A computer readable medium can also be distributed over a network-coupled computer system so that computer-readable code is stored and executed in a distributed fashion.
Although one or more embodiments of the present invention have been described in some detail for clarity of understanding, certain changes may be made within the scope of the claims. Accordingly, the described embodiments are to be considered as illustrative and not restrictive, and the scope of the claims is not to be limited to details given herein but may be modified within the scope and equivalents of the claims. In the claims, elements and steps do not imply any particular order of operation unless explicitly stated in the claims.
Virtualized systems in accordance with the various embodiments may be implemented as hosted embodiments, non-hosted embodiments, or as embodiments that blur distinctions between the two. Furthermore, various virtualization operations may be wholly or partially implemented in hardware. For example, a hardware implementation may employ a look-up table for modification of storage access requests to secure non-disk data.
Many variations, additions, and improvements are possible, regardless of the degree of virtualization. The virtualization software can therefore include components of a host, console, or guest operating system (OS) that perform virtualization functions.
Boundaries between components, operations, and local storage units are somewhat arbitrary, and particular operations are illustrated in the context of specific illustrative configurations. Other allocations of functionality are envisioned and may fall within the scope of the invention. In general, structures and functionalities presented as separate components in exemplary configurations may be implemented as a combined component. Similarly, structures and functionalities presented as a single component may be implemented as separate components. These and other variations, additions, and improvements may fall within the scope of the appended claims.
