Settings Clusters Configuration Drafts APIs
The Drafts service provides operations to manage cluster configuration drafts.
Operations
POST
Apply Cluster Draft
Commit this draft and make it the new desired configuration for the cluster. The draft must be in the VALID state for this method to succeed. A successful commit will result in the draft being deleted. If the cluster is not empty, the Apply API will be called with the new desired state. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.Remediate. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Remediate.
POST
Check Compliance Cluster Draft Async
Check all the hosts in the cluster for compliance with the configuration specified in the draft.
POST
Create Cluster Configuration Drafts
Create a new draft with the given values. If a configuration is supplied in the spec, it will be used as the initial value. Otherwise, the current desired configuration will be used as the initial value. The Drafts.Metadata.owner field will be set to the caller's user ID and the Drafts.Metadata.parent-id will be set to the current commit ID for the cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.Modify. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Modify.
GET
List Cluster Configuration Drafts
Get the active drafts for this cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.View. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.View.
DELETE
Delete Cluster Draft Configuration
Delete this draft. Any changes will be abandoned. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.Modify. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Modify.
GET
Get Cluster Draft Configuration
Get the cluster configuration and related metadata from this draft. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.Modify. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Modify.
POST
Export Config Cluster Draft
This API will export the draft configuration associated with the cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.Export. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Export.
POST
Import From Host Cluster Draft Async
The API imports the desired configuration from a reference host in the cluster. The API also adds host-specific and host-overrides from the other hosts in the cluster. Import API does not validate the configuration against the schema. The result will specify if the configuration was imported successfully. The result will provide localized error message if the import operation failed.
POST
Precheck Cluster Draft Async
This API will perform impact analysis of the configuration specified in the draft on each of the hosts in the cluster. The API will check against the desired image schema whether the desired configuration has added any requirements for the host to be put in maintenance mode or to be rebooted. The API will also invoke plugins which will validate the configuration on each hosts in the cluster. If the configuration is valid the API will also detect if the host needs to be maintenance mode or to be rebooted. If the hosts requires maintenance mode or reboot, then the API will run health checks to see the hosts can be put into the maintenance mode based on their current state. If any host cannot be put into maintenance mode due to health errors, then those errors will be reported in the result. The result will also list the configurations that will change on applying the configuration in the draft.
GET
Get Cluster Draft
Get the differences between this draft and the current desired state for the cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.Modify. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Modify.
POST
Update Cluster Draft
Replace the current configuration in this draft with the supplied one. If the supplied configuration is different from the current value, the Drafts.Metadata.precheck-task fields will be cleared. If an expected revision number is provided, it must match the current revision of this draft or a ConcurrentChange exception will be raised. If no expected revision number is provided, this check will be skipped and the update will go through. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.Modify. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Modify.