CorefinityCorefinityDocs
Open the Control PanelControl Panel
CoreCluster · 6 of 15

corecluster_create

Create a CoreCluster.

Scope writeRuns as a taskNo secrets returnedCoreCluster
On this page

When to use it

Create a CoreCluster in a region on a package, optionally with up to ten first sites. It is charged as the package's price: price it first with corestack_billing_quote_preview.

When another change in the same region is starting at that moment, the create waits for it instead of being refused: it is accepted at once, its operation stays pending with the status_label "Waiting for another change to finish. This carries on by itself." (the words the Control Panel shows), and it carries on by itself within a few minutes. Do not send it again. The task's status reads the same words while it waits.

When the region has no server of the cluster's kind yet, or none with room for it, the cluster waits while one is prepared or added, however long the region takes to make room: it carries on by itself, so there is nothing to retry; do not create it again. A first site whose disk the region has no room for yet waits the same way and carries on by itself. If that server's storage is not ready, the create fails with failure_reason storage_unavailable and the error "Storage in this region is not ready for a new cluster at the moment. Contact support." (corecluster_operation_get, the Control Panel and the REST API say the same). Do not retry: ask Corefinity support.

A CoreCluster that needs a new server in the region while changes to cluster capacity are paused for planned maintenance is not refused: it waits for its server and goes on by itself once the pause ends; there is nothing to retry.

When a step meets a temporary problem (the platform not answering yet, the cluster's SSH address not yet published), the create waits and tries that step again on its own instead of failing: corecluster_progress_get answers retrying with the stage, the attempt and the sentence "Setting up your cluster is taking longer than usual. We are trying again automatically." (or, at the SSH address, "Publishing your cluster's SSH address is taking longer than usual. We are trying again automatically."), and corecluster_operation_get carries the same sentence as the note cluster_create_retrying. Keep polling; do not create the cluster again. If a step fails on a temporary problem after the cluster was saved, the cluster is set up again on its own a few minutes later (up to twice), with the same name and its first sites carried over; retrying says so with "Setting up your cluster is taking longer than usual. We are setting it up again automatically." If a create fails before anything was saved, its name is free again at once, so the same company may create it again under the same name.

A create that was undone before anything was made gives its name back once its clean-up has finished, so the same name can be used again straight away by the same company; a name another company's cluster or a deleted cluster holds stays unavailable.

Ask for it

Prompt
Using the Corefinity MCP server, call corecluster_create with region uk, package cs4, name Staging. (Create a CoreCluster.) Tell me what it returned.

Inputs

compute_familystring

The server type: general (the default) or optimised.

generaloptimised
namestringRequired

The cluster's name, unique in your company. Up to 100 characters.

packagestringRequired

A CoreCluster package key (corestack_packages_list). Up to 64 characters.

regionstringRequired

uk, us, nl or aus — ready for the package (corestack_regions_list). Up to 16 characters.

sitesarray of objects

First sites: each row as corestack_in_corecluster_site_create takes it (corestack_site_provisioning_options lists the values). Up to 10 items.

Fields of each item
acknowledgearray of strings
eol
app_versionstring
contentstringRequired

fresh: install the platform; empty: an empty site to migrate into.

freshempty
domainstringRequired

The site's domain, without www. Up to 253 characters.

editionstring
open_source
freshobject

With content fresh: the first admin and the site's title.

Fields
admin_emailstring

Up to 255 characters.

admin_usernamestring

Up to 32 characters.

localestring

Up to 16 characters.

site_titlestring

Up to 255 characters.

mariadb_versionstring

Up to 8 characters.

node_acknowledgearray of strings

["eol"] once the person knows the chosen Node.js major is end of life (refused with ack_required otherwise). Up to 1 items.

eol
node_majorinteger

The Node.js major (corestack_site_provisioning_options lists each platform's, with its status). Left out, the default for new sites. 10 to 99.

php_versionstring

Up to 8 characters.

platformstringRequired
wordpresslaravelmagento2shopware5
searchboolean

Search (OpenSearch) on or off, on a platform that offers it.

tierstringRequired

A tier the platform and the package offer. Up to 16 characters.

varnishobject
Fields
enabledboolean
versionstring

Example call

tools/call
{
  "name": "corecluster_create",
  "arguments": {
    "region": "uk",
    "package": "cs4",
    "name": "Staging"
  }
}

If it is refused

ReasonWhat to do
invalid_argumentsNaming name with "this cluster name is not available": the name is taken, or the SSH address it would give the cluster (ssh-<company>-<name>.cfstack.io) is already another site's; nothing was created — choose another name.
compute_blockedThe region's servers cannot take a new CoreCluster at the moment (every CoreCluster runs on the region's shared compute servers); nothing was created — try later, or contact support.
ack_requiredThe change needs the person's acknowledgements first; required[] lists them — confirm with the person, then call again with them.
feature_offAn input needs a feature that is switched off (for example apply: "tonight" while the maintenance window queue is switched off); leave that input out.
demo_keep_requiredThe company is on a free demo that is not kept yet, and a new standalone cluster costs money: ask the person to keep the demo first (corestack_demo_keep, or open keep_url); change names it and its monthly price.
rate_limitedThe company has created as many CoreClusters this hour as its limit allows (10 by default, for everyone of the company together, shared with the Control Panel and the API). A create that is refused does not count. retry_after_seconds says when the next one is allowed: wait that long, then call again.
tenant_mismatchThe object does not exist or the token may not see it. Check the id.
scope_requiredThe token lacks a scope this call needs. Open the link in the answer to add it, then call again.
pin_refusedThe grant is limited to chosen clusters, sites or environments, and this call is outside them. Open the link in the answer to widen it.
temporarily_unavailableThe Control Panel could not answer just now. Nothing was started; try again shortly.
internal_errorSomething went wrong on our side. Quote the trace id to support.

What it installs

Each sites[] row is a create of its own (corestack_in_corecluster_site_create's "What it installs"): a default version not yet open to new sites never refuses it, the row installs the newest one that is, and corestack_site_get names the choice in site.create_fallbacks, with now_available on a PHP entry once that version opens to new sites.

A platform with no installer of its own (PHP, while it is offered) starts empty: send content: empty and no fresh, app_version, edition or acknowledge; the site takes the platform's default PHP and MariaDB versions unless you name them. The person then deploys their own code to it, as to any empty site.

The same task elsewhere

Was this helpful?
Open in ClaudeOpen in ChatGPT