Configure zone deployment
Configures and starts zone services, such as database, cluster manager and cluster worker. This request can be executed by unauthorized users as long as there are no admin users in the system.
Request body
The zone configuration description.
cluster The zone cluster configuration.
The zone cluster configuration.
Hostname suffix common for all services in the cluster. Together with a node hostname constitutes a fully qualified domain name (FQDN) of the node. May be skipped to allow unrelated hostnames for each node.
The collection of nodes aliases associated with nodes properties.
databases required The cluster database service configuration.
The cluster database service configuration.
The list of aliases of cluster database nodes.
The server quota is the RAM memory in MiB that is allocated to the server when Couchbase Server is first installed. This sets the limit of RAM allocated by Couchbase for caching data for all buckets on each of the nodes. Optional, defaults to 4096 (4 GiB).
The bucket quota is the amount of RAM memory in MiB allocated to each individual bucket for caching data. Optional, defaults to 4096 (4 GiB). Optimally, should be set to the same value as serverQuota.
managers required The cluster manager service configuration.
The cluster manager service configuration.
The alias of the main cluster manager node.
The list of aliases of cluster manager nodes.
workers required The cluster worker service configuration.
The cluster worker service configuration.
The list of aliases of cluster worker nodes.
onezone The Onezone custom configuration.
The Onezone custom configuration.
The domain of Onezone cluster.
The Onezone cluster name.
If enabled the zone will use Let's Encrypt service to obtain SSL certificates. Otherwise certificates must be manually provided. By enabling this option you agree to the Let's Encrypt Subscriber Agreement.
If true, DNS check will verify that control of DNS zone for Onezone's domain was delegated to the DNS server built into Onezone service.
policies State of Onezone operation policies.
State of Onezone operation policies.
Indicates policy enforced during provider registration. Possible options are: open - anyone can acquire a registration token and register a new Oneprovider restricted - requires an administrative privilege 'oz_providers_invite' to generate a Oneprovider registration token. The token can be issued for someone else.
If true, Oneproviders are allowed to request subdomains of the Onezone domain for use as their domains.
When this value is true, GUI packages uploaded by services operating under Onezone or by harvester admins are checked against known SHA-256 checksums using the compatibility registry. Setting this value to false disables the verification. WARNING: disabling GUI package verification poses a severe security threat, allowing Oneprovider owners to upload arbitrary GUI to Onezone (which is then hosted in Onezone's domain).
This policy can be used to disable GUI package verification for harvester plugins only. See "guiPackageVerification" for detailed description. This setting has no effect if "guiPackageVerification" is set to false.
users List of Onezone user specifications.
List of Onezone user specifications.
User's human-readable identifier, unique across the system. Makes it easier to identify the user and can be used for signing in with password.
User's password (in plaintext).
User's full name (given names + surname).
Ids of Onezone groups to which the user should be added. The groups must already exist.
onepanel The panel configuration.
The panel configuration.
Indicates that interactive deployment is being performed. If false, users entering GUI will not be asked to complete the configuration. In that case default values will be used, available for change later via appropriate Onepanel GUI pages or REST.
When true, all GUIs hosted in this cluster will print debug logs to browser console.
Request Examples
{
"cluster": {
"domainName": "onezone.onedata.example.com",
"nodes": {
"node1": {
"hostname": "node1"
}
},
"manager": {
"mainNode": "node1",
"nodes": [
"node1"
]
},
"worker": {
"nodes": [
"node1"
]
},
"database": {
"nodes": [
"node1"
]
}
},
"onezone": {
"domainName": "example.com",
"name": "example",
"letsEncryptEnabled": true,
"users": [
{
"username": "ozadmin",
"password": "somepassword",
"groups": [
"admins"
]
}
]
}
}Responses
Invalid request - cluster already deployed.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Forbidden request.
Internal server error.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}