diff --git a/docs/howtos/create-org.md b/docs/howtos/create-org.md index 44f5108..6621cb0 100644 --- a/docs/howtos/create-org.md +++ b/docs/howtos/create-org.md @@ -2,10 +2,9 @@ # Create Organization This is a guide on how to create a new organization in the CrateDB Cloud -Console. If you follow the [cluster deployment -tutorial](https://crate.io/docs/cloud/tutorials/en/latest/cluster-deployment/stripe.html), -your first organization will be automatically created for you. However, -there are scenarios where you may want to create a new organization. +Console. When you first signup in [CrateDB Cloud], your first organization will +be automatically created for you. However, there are scenarios where you may +want to create a new organization. If you arrive at the Console for the first time, or if you have deleted your last organization, you will have to create an organization to use @@ -16,7 +15,7 @@ of one, the process is slightly different. This guide will outline both methods. (create-org-new)= -## Create first organization +## Create first organization When you first access the CrateDB Cloud Console after signing up, you will arrive at the Cluster overview page. You will also be informed, @@ -26,7 +25,7 @@ for you. ![Cloud Console org overview without organization](../_assets/img/new-account-arrival.png) (create-org-multiple)= -## Create multiple organizations +## Create multiple organizations If you are already in an organization and want to create another one, go to the Account tab. Here you will see a list of all your organizations @@ -51,3 +50,5 @@ To switch the active organization, click on the organization name in the list. All organization and cluster management options displayed in the CrateDB Cloud Console will then refer to that organization until you switch organizations again. + +[CrateDB Cloud]: https://console.cratedb.cloud/ diff --git a/docs/howtos/suspend-cluster.md b/docs/howtos/suspend-cluster.md index 894dac2..57960a9 100644 --- a/docs/howtos/suspend-cluster.md +++ b/docs/howtos/suspend-cluster.md @@ -4,8 +4,7 @@ This guide will provide a quick overview of how to suspend your cluster using the CrateDB Cloud Console. For the purposes of this guide, it is assumed that you have a cluster up and running and can access the -Console. If not, please refer to the tutorial on how -to {ref}`deploy a cluster for the first time. ` +Console. (what-is-suspension)= ## What is cluster suspension @@ -18,7 +17,7 @@ The benefit here is that while the cluster is suspended, you are only charged for the storage. (cluster-suspend-steps)= -## Steps to suspending the cluster +## Steps to suspending the cluster To suspend your cluster, navigate to the Clusters page in the left-hand menu. Here you can see a list of all your clusters. Click *View* on the @@ -34,7 +33,7 @@ Once here, you can suspend your cluster. Simply click the *Suspend cluster* in the top-right. (how-to-resume-a-cluster)= -## Resume a cluster +## Resume a cluster To resume your cluster, simply click the *Resume cluster* button in the top-right while in the Overview page of your cluster. @@ -42,7 +41,7 @@ top-right while in the Overview page of your cluster. ![Cloud Console resume cluster](../_assets/img/cluster-resume.png) (additional-info)= -## Important things to know +## Important things to know - To suspend a cluster, you must be an organization Admin. - You can suspend and resume clusters at any time. @@ -50,4 +49,4 @@ top-right while in the Overview page of your cluster. storage and the billing cycle is unaffected. - Cluster backups do not expire while a cluster is suspended. - The Admin UI of a cluster is unavailable while the cluster is - suspended. \ No newline at end of file + suspended. diff --git a/docs/reference/glossary.md b/docs/reference/glossary.md index cb663ef..52791e4 100644 --- a/docs/reference/glossary.md +++ b/docs/reference/glossary.md @@ -7,7 +7,7 @@ to CrateDB Cloud. The items are presented in alphabetical order. :::{note} While learning about CrateDB Cloud, please also visit the {ref}`CrateDB -glossary `. It describes +glossary `. It describes all terms related to the CrateDB database in general. ::: @@ -36,18 +36,18 @@ all terms related to the CrateDB database in general. - [Versions](#gloss-version) (gloss-audit-log)= -## Audit log +## Audit log The Audit Log registers and displays all operations associated with a -particular {ref}`organization `. This includes operations -on {ref}`users `, on {ref}`clusters `, and -on {ref}`consumers `. The Audit Log can be found -in the rightmost tab of the Organization overview page in the CrateDB -Cloud {ref}`Console `. Only an *organization admin* has +particular {ref}`organization `. This includes operations +on {ref}`users `, on {ref}`clusters `, and +on {ref}`consumers `. The Audit Log can be found +in the rightmost tab of the Organization overview page in the CrateDB +Cloud {ref}`Console `. Only an *organization admin* has access to the Audit Log. (gloss-azure-ad)= -## Azure AD +## Azure AD Azure AD (Active Directory) is Microsoft's authentication and sign-in service for accessing Microsoft hosted services. CrateDB Cloud uses @@ -57,27 +57,25 @@ documentation on Azure](https://docs.microsoft.com/en-us/azure/active-directory/fundamentals/active-directory-whatis). (gloss-cluster)= -## Cluster +## Cluster -Within each {ref}`organization `, an administrator can +Within each {ref}`organization `, an administrator can deploy any number of {ref}`products `. The main service is the deployment of clusters, which can be done through the CrateDB Cloud Console. A cluster is a set of at least one instance (referred to as node) which forms a database. It is also possible (and recommended) to deploy multi-node clusters. Then the the database is truly distributed. Depending on the user's {ref}`subscription -plan ` and scaling, each cluster will have a -certain storage capacity and can process a certain amount of ingests +plan ` and scaling, each cluster will have a +certain storage capacity and can process a certain amount of ingests and queries per second. Only actual cluster usage is billed. A cluster has a name, a unique ID, as well as a storage and processing capacity and a number of nodes. Note that clusters are also versioned. -For information on how to deploy a cluster, please see the [tutorial for -deploying a CrateDB Cloud cluster from -scratch](https://cratedb.com/docs/cloud/en/latest/tutorials/quick-start.html). +You can deploy a free cluster in [CrateDB Cloud](https://console.cratedb.cloud). (gloss-console)= -## Console +## Console The CrateDB Cloud Console is the hosted user interface for CrateDB Cloud. It is a fully supported, easy-to-use UI which allows customers to @@ -88,7 +86,7 @@ use of the Console by default. Only the Console allows deployment of a {ref}`cluster `. (gloss-consumer)= -## Consumer +## Consumer A consumer in the sense used for CrateDB Cloud architecture and documentation is an entity that reads event data from an IoT hub. It is @@ -101,16 +99,16 @@ Operations on consumers are registered in the (gloss-croud)= -## Croud +## Croud Croud is the name of the CrateDB Cloud Command-Line Interface (CLI). You -can use Croud to interact with the {ref}`organization ` and +can use Croud to interact with the {ref}`organization ` and {ref}`products ` you have access to. Croud is intended for customers who prefer a CLI to the use of a hosted web interface such as the CrateDB Cloud -{ref}`Console `. Note however that the Console -is the default way to interact with CrateDB Cloud, and currently +{ref}`Console `. Note however that the Console +is the default way to interact with CrateDB Cloud, and currently clusters can only be deployed within the Console. :::{note} @@ -118,29 +116,29 @@ See also: Croud CLI {ref}`documentation `. ::: (gloss-cloud-on-kubernetes)= -## CrateDB Cloud on Kubernetes +## CrateDB Cloud on Kubernetes CrateDB Cloud on Kubernetes is a hybrid cloud database solution presented by [CrateDB](https://cratedb.com/). It allows customers to deploy a Kubernetes cluster either on -their own cloud provider or their own local servers, using the database -software and maintenance support that CrateDB Cloud offers. It can be +their own cloud provider or their own local servers, using the database +software and maintenance support that CrateDB Cloud offers. It can be accessed through the {ref}`CrateDB Cloud Console `. (gloss-endpoint)= -## Endpoint +## Endpoint An endpoint is the end or goal of a communication channel. A user or client communicates with an endpoint via a defined method, which returns a defined set of data. In CrateDB Cloud, different -{ref}`profiles ` can be used to configure their own -associated endpoints, which a user connects to via the -{ref}`Croud ` CLI. For information on how +{ref}`profiles ` can be used to configure their own +associated endpoints, which a user connects to via the +{ref}`Croud ` CLI. For information on how to do this, see the {ref}`Croud configuration `. (gloss-offer)= -## Offer +## Offer -An offer or subscription offer is a Software-as-a-Service +An offer or subscription offer is a Software-as-a-Service {ref}`(SaaS) ` product prepared for consumer purchase on a subscription basis. CrateDB Cloud has an offer on the [Microsoft Azure @@ -149,11 +147,11 @@ and on the [AWS Marketplace](https://aws.amazon.com/marketplace/pp/B089M4B1ND). (gloss-org)= -## Organization +## Organization Organizations represent the larger structure - for example a company - -within which CrateDB Cloud {ref}`products ` are deployed. -At the organization level there is always at least one organization +within which CrateDB Cloud {ref}`products ` are deployed. +At the organization level there is always at least one organization administrator, who can in turn add organization members. Such organization admins and members have access to the clusters run by the organization. One account can be a member or admin @@ -169,27 +167,27 @@ email address. For information on how to create an organization, please refer to the guide about {ref}`creating organization `. (gloss-product)= -## Product +## Product A product in the sense used in CrateDB Cloud is something that uses the -Cloud service for the storage of data. It consists of either a -{ref}`consumer ` or a {ref}`cluster ` and +Cloud service for the storage of data. It consists of either a +{ref}`consumer ` or a {ref}`cluster ` and is run within an {ref}`organization `. (gloss-profile)= -## Profile +## Profile -In CrateDB Cloud's CLI, {ref}`Croud `, profiles are sets -of configuration options. They define API {ref}`endpoints ` +In CrateDB Cloud's CLI, {ref}`Croud `, profiles are sets +of configuration options. They define API {ref}`endpoints ` and the desired output format of interaction with those endpoints. A Croud user can create multiple profiles and switch between them as desired. (gloss-region)= -## Region +## Region A region in the sense used for CrateDB Cloud is a set of data centers (servers) grouped together on a geographic basis so as to not exceed a -certain latency. CrateDB Cloud on Kubernetes also permits the creation of +certain latency. CrateDB Cloud on Kubernetes also permits the creation of custom regions. These regions are designed to correspond to servers used by CrateDB Cloud on Kubernetes customers locally, on which they can deploy CrateDB Cloud clusters for use in plants and other production facilities. @@ -210,9 +208,9 @@ and the [AWS Marketplace](https://aws.amazon.com/marketplace/pp/B089M4B1ND). ## Scale unit The CrateDB Cloud -{ref}`subscription plans ` each come with a number -of different scale units. Each scale unit represents an (additional) -unit multiplying the specific combination of hardware capacity +{ref}`subscription plans ` each come with a number +of different scale units. Each scale unit represents an (additional) +unit multiplying the specific combination of hardware capacity that applies to that plan. :::{note} @@ -225,8 +223,7 @@ cluster guide](https://crate.io/docs/cloud/howtos/en/latest/reconfigure-cluster. A subscription is - for the purposes of CrateDB Cloud - a container in which the CrateDB Cloud service is created and managed. You can purchase -a CrateDB Cloud subscription by following the steps in the -[tutorial](https://crate.io/docs/cloud/tutorials/en/latest/cluster-deployment/index.html). +a CrateDB Cloud subscription by signing up at [CrateDB Cloud]. In the case of using a {ref}`SaaS ` {ref}`offers ` on the cloud provider marketplaces, customers subscribe to CrateDB Cloud through that particular cloud provider. @@ -238,8 +235,7 @@ wants to separate different instances of using the CrateDB Cloud service into different billing accounts. :::{note} -[Subscribe to CrateDB -Cloud](https://crate.io/docs/cloud/tutorials/en/latest/cluster-deployment/stripe.html) +[Subscribe to CrateDB Cloud](https://console.cratedb.cloud) [Subscribe via AWS Marketplace](https://crate.io/docs/cloud/tutorials/en/latest/cluster-deployment/deploy-to-cluster-marketplace/deploy-to-cluster-aws/subscribe-aws.html) @@ -247,7 +243,7 @@ Marketplace](https://crate.io/docs/cloud/tutorials/en/latest/cluster-deployment/ [Subscribe via Azure Marketplace](https://crate.io/docs/cloud/tutorials/en/latest/cluster-deployment/deploy-to-cluster-marketplace/deploy-to-cluster-azure/subscribe-azure.html) -{ref}`Services ` +{ref}`Services ` ::: (gloss-subscription-plan)= @@ -259,16 +255,15 @@ towards particular customer use cases: from trial and development plans to high-end production clusters. They can also be further adjusted for different {ref}`scale units ` per plan. -Currently, there are multiple subscription plans available for {ref}`direct -deployment `, and also multiple plans and a separate contract option -through the Marketplace {ref}`offers `. For more information, -refer to the documentation on {ref}` services we offer `. +There are multiple subscription plans available for direct +deployment, and also multiple plans and a separate contract option +through the Marketplace {ref}`offers `. For more information, +refer to the documentation on {ref}`services we offer `. :::{note} See also: -[Subscribe to CrateDB -Cloud](https://crate.io/docs/cloud/tutorials/en/latest/cluster-deployment/stripe.html) +[Subscribe to CrateDB Cloud](https://console.cratedb.cloud) [Subscribe via AWS Marketplace](https://crate.io/docs/cloud/tutorials/en/latest/cluster-deployment/deploy-to-cluster-marketplace/deploy-to-cluster-aws/subscribe-aws.html) @@ -276,7 +271,6 @@ Marketplace](https://crate.io/docs/cloud/tutorials/en/latest/cluster-deployment/ [Subscribe via Azure Marketplace](https://crate.io/docs/cloud/tutorials/en/latest/cluster-deployment/deploy-to-cluster-marketplace/deploy-to-cluster-azure/subscribe-azure.html) -{ref}`Deployment ` ::: (gloss-system-user)= @@ -298,10 +292,10 @@ In CrateDB Cloud, there are two distinct system ## Tier In the CrateDB Cloud -{ref}`services ` for SaaS Marketplace -subscriptions, tiers offer different magnitudes of the hardware -composition of a given plan. For a given ratio of storage capacity, -memory, and CPUs, going up in tier allows youto multiply +{ref}`services ` for SaaS Marketplace +subscriptions, tiers offer different magnitudes of the hardware +composition of a given plan. For a given ratio of storage capacity, +memory, and CPUs, going up in tier allows youto multiply the hardware values for your cluster deployment without changing the hardware ratio. @@ -309,7 +303,7 @@ changing the hardware ratio. ## User A user in CrateDB Cloud is any individual account authorized to interact -with some part of an {ref}`organization's ` assets. Each user has +with some part of an {ref}`organization's ` assets. Each user has a defined role within the organization (see documentation on {ref}`user roles `) and is associated with a specific email address. @@ -341,7 +335,7 @@ the versioning sequence, e.g. the 3 in 'version 5.3.4'. A patch version of CrateDB is a release that includes bug fixes and smaller quality of life improvements compared to the previous such version. It is indicated by the third numeral in the versioning -sequence, e.g. the 4 in 'version 5.3.4'. +sequence, e.g. the 4 in 'version 5.3.4'. :::{note} See also: {ref}`CrateDB Release Notes ` diff --git a/docs/tutorials/deploy/croud.md b/docs/tutorials/deploy/croud.md index e414bb5..ebcaa77 100644 --- a/docs/tutorials/deploy/croud.md +++ b/docs/tutorials/deploy/croud.md @@ -3,8 +3,8 @@ This tutorial will outline a step-by-step guide to deploying a cluster using the Cloud CLI application from scratch. The walkthrough assumes -you have completed the {ref}`signup process ` successfully, -and that the `croud` program {ref}`is installed ` +you have completed the [signup process](https://console.cratedb.cloud) +successfully, and that the `croud` program {ref}`is installed ` on your system. ::::{grid} 1 1 1 1 @@ -240,8 +240,8 @@ Required arguments: * `--unit 0` means **1 node** * `--unit 1` means **2 nodes** - * `--unit 2` means **3 nodes** etc. - + * `--unit 2` means **3 nodes** etc. + This allows you to scale the performance of your cluster up or down. diff --git a/docs/tutorials/deploy/index.md b/docs/tutorials/deploy/index.md deleted file mode 100644 index 2b2a883..0000000 --- a/docs/tutorials/deploy/index.md +++ /dev/null @@ -1,68 +0,0 @@ -:orphan: -(cluster-deployment)= - -# Deploy cluster - -This set of tutorials explains how to subscribe and deploy your cluster on -CrateDB Cloud. The first step is always to {ref}`sign up `. - -After you have signed up successfully, CrateDB Cloud offers two different -methods to subscribe and get started with deploying a cluster. - -Quick start. - -:::{card} {octicon}`table;2em` CrateDB Cloud Console -:link: https://console.cratedb.cloud/ -:link-type: url - -Directly navigate to the CrateDB Cloud Console. -https://console.cratedb.cloud/ -::: - - -## Direct deployment - -The easiest and recommended way to sign up for CrateDB Cloud is by using a -credit card. Payment processing for your credit card is fully PCI-compliant, -powered by [Stripe]. - -:::{card} Web-based deployment tutorial -:link: cluster-deployment-stripe -:link-type: ref - -Deploy a CrateDB cluster using the CrateDB Cloud Web Console. -::: - -:::{card} CLI deployment tutorial -:link: cluster-deployment-croud -:link-type: ref - -Deploy a CrateDB cluster using the Croud command-line program. -::: - - -## Marketplace deployment - -CrateDB Cloud also supports subscribing via Software as -a Service (SaaS) offerings on two cloud provider marketplaces, -Microsoft's Azure Marketplace and Amazon's AWS Marketplace. - -:::{card} Marketplace deployment tutorials -:link: cluster-deployment-marketplace -:link-type: ref - -Tutorials about the signup and deployment process for running -CrateDB clusters on Cloud provider marketplaces. -::: - - -[Stripe]: https://stripe.com - - -```{toctree} -:maxdepth: 1 -:hidden: - -stripe -marketplace/index -``` diff --git a/docs/tutorials/deploy/marketplace/index.rst b/docs/tutorials/deploy/marketplace/index.rst index e4f0735..c6bf739 100644 --- a/docs/tutorials/deploy/marketplace/index.rst +++ b/docs/tutorials/deploy/marketplace/index.rst @@ -1,10 +1,12 @@ +:orphan: + .. _cluster-deployment-marketplace: ======================================== Deploy cluster via Marketplace offerings ======================================== -Here you can find the tutorials for subscribing to CrateDB Cloud via one of the +Here you can find the guides for subscribing to CrateDB Cloud via one of the two supported Marketplace SaaS offers. The process is very straightforward, you only need to subscribe to the CrateDB diff --git a/docs/tutorials/deploy/marketplace/subscribe-aws.rst b/docs/tutorials/deploy/marketplace/subscribe-aws.rst index 9f83304..c040c5d 100644 --- a/docs/tutorials/deploy/marketplace/subscribe-aws.rst +++ b/docs/tutorials/deploy/marketplace/subscribe-aws.rst @@ -6,19 +6,13 @@ Subscribe to CrateDB Cloud via the AWS Marketplace One way to deploy a cluster on CrateDB Cloud is to sign up via AWS Marketplace. You will need an AWS Marketplace account to proceed, which for the -purposes of this tutorial we will assume you have. (If not, you can sign up on the `Marketplace page`_.) By using CrateDB Cloud's service on AWS +purposes of this tutorial we will assume you have. (If not, you can sign up on +the `Marketplace page`_.) By using CrateDB Cloud's service on AWS Marketplace, your hourly usage is billed directly by Amazon, not by Crate.io. As a SaaS service, the subscription payment is arranged through AWS. The cluster will be hosted in the region you select as part of the configuration -process. To pay directly for a hosted cluster by credit card, see the tutorial for -:ref:`direct cluster deployment `. - -.. rubric:: Table of contents - -.. contents:: - :local: - +process. .. _signup-aws-to-cluster-offer: @@ -53,10 +47,9 @@ configuration on the CrateDB Cloud end. .. image:: ../../../_assets/img/aws-subscribe-confirm.png :alt: CrateDB Cloud on AWS subscription confirmation -After clicking the *Set Up Your Account*, you will be redirected to the CrateDB -Cloud console. From here, you can follow the :ref:`usual deployment procedure -` use your new AWS subscription for the billing in -the CrateDB Cloud console. +After clicking the *Set Up Your Account*, you will be redirected to the `CrateDB +Cloud Console`_. From here, you can follow the usual deployment procedure and use +your new AWS subscription for the billing. .. NOTE:: @@ -87,3 +80,4 @@ large volumes, please contact `Sales`_ first to negotiate a private offer. .. _Marketplace page: https://portal.aws.amazon.com/billing/signup .. _Sales: sales@crate.io .. _the AWS offer: https://aws.amazon.com/marketplace/pp/B089M4B1ND +.. _CrateDB Cloud Console: https://console.cratedb.cloud/ diff --git a/docs/tutorials/deploy/marketplace/subscribe-azure.rst b/docs/tutorials/deploy/marketplace/subscribe-azure.rst index 9daf785..2658c5e 100644 --- a/docs/tutorials/deploy/marketplace/subscribe-azure.rst +++ b/docs/tutorials/deploy/marketplace/subscribe-azure.rst @@ -5,22 +5,14 @@ Subscribe to CrateDB Cloud via the Azure Marketplace ==================================================== Another way to deploy a CrateDB cluster on CrateDB Cloud is via the Microsoft -Azure Marketplace. You will need a Microsoft Azure account and an Azure +Azure Marketplace. You will need a Microsoft Azure account and an Azure subscription with a credit card linked to it. By using CrateDB Cloud's service on Azure Marketplace, your hourly usage is billed directly by Microsoft, not by Crate.io. As a SaaS service, the subscription payment is arranged through Azure. The cluster will be hosted in the region you select as part of the configuration -process. To pay directly for a hosted cluster by credit card, see the tutorial for -:ref:`direct cluster deployment `. - - -.. rubric:: Table of contents - -.. contents:: - :local: - +process. .. _signup-azure-to-cluster-offer: @@ -29,7 +21,7 @@ Using the CrateDB Cloud offer on Azure Marketplace To subscribe to CrateDB Cloud's offering on Azure Marketplace, find the CrateDB Cloud offer page. You can either search "CrateDB Cloud" in the search bar at -the top of the Azure Marketplace front page or go directly to +the top of the Azure Marketplace front page or go directly to `Azure marketplace`_. The top of the offer page should look as follows: .. image:: ../../../_assets/img/azure-portal-offer.png @@ -66,11 +58,11 @@ After confirming, a screen similar to this should appear in a few moments: :alt: Azure Portal CrateDB Cloud created subscription This means the process is done and the subscription was successfully created. -From here, you can follow the :ref:`usual deployment procedure -` and use your new Azure subscription for the -billing in the CrateDB Cloud console. +From here, you can follow the usual deployment procedure in `CrateDB Cloud +Console`_ and use your new Azure subscription for the billing. .. _Azure documentation on resource groups: https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal .. _Azure documentation on tags: https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/tag-resources .. _Azure Marketplace: https://azuremarketplace.microsoft.com/en-us/marketplace/apps/crate.cratedbcloud?tab=Overview +.. _CrateDB Cloud Console: https://console.cratedb.cloud/ diff --git a/docs/tutorials/deploy/stripe.rst b/docs/tutorials/deploy/stripe.rst deleted file mode 100644 index accedae..0000000 --- a/docs/tutorials/deploy/stripe.rst +++ /dev/null @@ -1,138 +0,0 @@ -.. _cluster-deployment-stripe: - -======================= -Deploy cluster directly -======================= - -In this tutorial, we will provide a step-by-step guide to deploying a cluster -from scratch. It is assumed you have completed the -:ref:`signup process `. If you're a first-time user, a new -organization will have been created for you as a part of the signup process. -If not, you will need to create one manually to proceed. - -The simplest way to deploy a cluster is to subscribe to CrateDB Cloud using your -credit card. The payment processing and billing is powered -by `Stripe`_. It is also possible to use your AWS or Azure subscription as a -payment. - -Quick start. - -.. card:: :octicon:`table;2em` CrateDB Cloud Console - :link: https://console.cratedb.cloud/ - :link-type: url - - Directly navigate to the CrateDB Cloud Console. - https://console.cratedb.cloud/ - - -.. rubric:: Table of contents - -.. contents:: - :local: - -Deploy cluster -============== - -After finishing the signup process, the next step will be to create -a new database cluster. - -.. image:: https://github.com/crate/crate-docs-theme/assets/453543/d5ba8bce-661e-4c78-80ea-003fbfba88f4 - :alt: CrateDB Cloud: Deploy new cluster - :width: 480px - :target: https://console.cratedb.cloud/ - -Selecting the *Deploy cluster* button will invoke the cluster deployment screen. -Here, you can configure the name and region, compute-, and storage-parameters, and -the number of nodes to be deployed. - -.. image:: ../../_assets/img/deployment-config.png - :alt: CrateDB Cloud Console Deployment Configuration - -Region ------- - -First, after naming your cluster, select a `region`_ where your cluster should -be deployed. Currently, we offer AWS and Azure regions. If there is a region -that you would like to see but we don't currently offer, you can let us know -by selecting the "Request new region" button and filling out the form. - -.. image:: ../../_assets/img/deployment-region-request.png - :alt: CrateDB Cloud Console Deployment New Region Request - -Compute -------- - -In the Compute section, you can choose a `subscription plan`_ that suits -your needs and use case. Plans consist of a per-node CPU and RAM allocation. - -Storage -------- - -For the CR1-4 plans, you can choose how much storage space you need for -your cluster. - -.. NOTE:: - The storage capacity of a cluster cannot currently be lowered in the - CrateDB Cloud Console once it has been deployed. - -Number of nodes ---------------- - -The number of nodes represents the horizontal scaling of your CrateDB Cloud -cluster. - -To sum up: the configuration of the cluster consists of the hardware per-node -values (CPU, RAM, storage), and the number of nodes in the cluster. -The hardware values are determined by choice of subscription plan. Each of -these choices will affect the price of the cluster. You can always find the -total price per hour and month on the right side of the deployment screen. - -Provide billing information -=========================== - -On the next screen, you will select the payment method. You can choose -credit card payment, or use an existing AWS or Azure subscription. - -.. image:: ../../_assets/img/payment-method.png - :alt: Payment method screen - -Credit card ------------ - -You can find the credit card types accepted by Crate.io at the bottom right part -of the screen. When you have filled out the necessary information, select *Deploy -Cluster* below it to deploy your cluster. Do not forget to accept the financial -authorization by ticking the box at the bottom. - -.. image:: ../../_assets/img/stripe-billing.png - :alt: Billing information screen - -AWS/Azure ---------- - -The other payment option is to use an AWS or Azure marketplace subscription. -Simply choose the one you'd like to use, and you will see a prompt that -will forward you to the respective marketplace page where you can confirm the -subscription. - -.. image:: ../../_assets/img/payment-method-marketplaces.png - :alt: Billing information screen - - -The payment and billing information you have submitted will be saved in the -Billing and Payment method pages, visible in the menu on the left side of the -console. - -Your current accumulated bill is shown in the billing meter in the bottom left -of the CrateDB Cloud Console screen. - -Finish -====== - -Your cluster should now be ready to use! - -.. _Admin UI: https://crate.io/docs/crate/admin-ui/en/latest/console.html -.. _Cloud Console: https://console.cratedb.cloud/ -.. _region: https://crate.io/docs/cloud/reference/en/latest/glossary.html#region -.. _Stripe: https://stripe.com -.. _subscription plan: https://cratedb.com/docs/cloud/en/latest/reference/services.html