From 44c956e305bdf2f90e24c0f32c5521e6c3b46ad3 Mon Sep 17 00:00:00 2001 From: Walter Behmann <40459646+WalBeh@users.noreply.github.com> Date: Tue, 13 Aug 2024 16:56:27 +0200 Subject: [PATCH 1/2] Update croud.md --- docs/tutorials/deploy/croud.md | 38 +++++++++++++++++----------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/tutorials/deploy/croud.md b/docs/tutorials/deploy/croud.md index 494ef26..9e2058f 100644 --- a/docs/tutorials/deploy/croud.md +++ b/docs/tutorials/deploy/croud.md @@ -80,16 +80,16 @@ sh$ croud organizations create --name samplecroudorganization This will create an organization called "samplecroudorganization". (croud-create-project) -## Create project +## Create subscription -The next step is to create a project in your organization. To create a -new project execute this command: +The next step is to create a subscription in your organization. To create a +new subscription execute this command: :::{code} console -sh$ croud projects create --name sampleproject +sh$ croud subscriptions create --type contract --org-id ::: -This will create a new project named [sampleproject]{.title-ref}. +This will create a new subscription. (croud-deploy-cluster) ## Deploy cluster @@ -104,9 +104,6 @@ When deploying a cluster, these are the required arguments: : The product tier to use. -`-p, --project-id` - -: The project ID to use. `--cluster-name` @@ -128,6 +125,11 @@ When deploying a cluster, these are the required arguments: : The CrateDB subscription to use. +`--region` + +: The region the cluster will be created in. + + (croud-deploy-example)= ### Example @@ -136,8 +138,8 @@ sh$ croud clusters deploy / --product-name cr1 / --tier default / --cluster-name my-crate-cluster / - --project-id 952cd102-91c1-4837-962a-12ecb71a6ba8 / - --version 4.8.1 / + --region aks1.eastus2 / + --version 5.8.1 / --username admin / --password "as6da9ddasfaad7i902jcv780dmcba" / --subscription-id 782dfc00-7b25-4f48-8381-b1b096dd1619 @@ -146,7 +148,7 @@ sh$ croud clusters deploy / +--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------+ | id | name | numNodes | crateVersion | projectId | username | fqdn | |--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------| -| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-crate-cluster | 1 | 4.8.1 | 952cd102-91c1-4837-962a-12ecb71a6ba8 | admin | my-crate-cluster.eastus.azure.cratedb.net. | +| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-crate-cluster | 1 | 5.8.1 | 952cd102-91c1-4837-962a-12ecb71a6ba8 | admin | my-crate-cluster.eastus2.azure.cratedb.net. | +--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------+ ==> Info: Cluster creation initiated. It may take a few minutes to complete. ==> Info: Status: REGISTERED (Your creation request was received and is pending processing.) @@ -155,7 +157,7 @@ sh$ croud clusters deploy / +--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------+ | id | name | numNodes | crateVersion | projectId | username | fqdn | |--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------| -| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-crate-cluster | 1 | 4.8.1 | 952cd102-91c1-4837-962a-12ecb71a6ba8 | admin | my-crate-cluster.eastus.azure.cratedb.net. | +| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-crate-cluster | 1 | 5.8.1 | 952cd102-91c1-4837-962a-12ecb71a6ba8 | admin | my-crate-cluster.eastus.azure.cratedb.net. | +--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------+ ::: @@ -166,8 +168,7 @@ sh$ croud clusters deploy / The minimum length of a password is 24 characters. * To see all the available products issue: `croud products list`. -* To find out your *project-id* issue: - `croud projects list`. +* To see all regions available issue: `croud regions list`. * To find out your *subscription-id* issue: `croud subscriptions list`. ::: @@ -192,8 +193,8 @@ channels, you must use the `--channel` parameter. sh$ croud clusters deploy --product-name cr1 / --tier default / --cluster-name my-crate-cluster / - --project-id 3ac44505-1d6e-419c-ad23-5d0d572915ba / - --version 5.2.0 / + --region aks1.eastus.azure + --version 5.8.1 / --username admin / --password "as6da9ddasfaad7i902jcv780dmcba" / --subscription-id 3a35974f-5319-47fb-9a1f-ab85dca75c86 / @@ -210,8 +211,8 @@ sh$ croud clusters deploy / --product-name cr1 / --tier default / --cluster-name my-crate-cluster / - --project-id f76d96aa-f1a7-46aa-a89b-8cdd2b3cef15 / - --version 4.8.0 / + --region aks1.eastus.azure + --version 5.8.1 / --username admin / --password "as6da9ddasfaad7i902jcv780dmcba" / --subscription-id 3a35974f-5319-47fb-9a1f-ab85dca75c86 @@ -248,7 +249,6 @@ Example: :::{code} console sh$ croud clusters scale \ - --project-id 952cd102-91c1-4837-962a-12ecb71a6ba8 \ --cluster-id 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 \ --unit 1 From df490420e938eec9c3614cd01d9251b1f1ec1398 Mon Sep 17 00:00:00 2001 From: matkuliak Date: Wed, 14 Aug 2024 15:21:45 +0200 Subject: [PATCH 2/2] Removed old references --- docs/howtos/add-users.md | 4 +- docs/howtos/delete-cluster.md | 6 - docs/howtos/restore-backups.md | 3 - docs/reference/glossary.md | 11 +- docs/tutorials/deploy/croud.md | 644 ++++++++++++------------ docs/tutorials/edge/self-hosted-edge.md | 6 +- 6 files changed, 326 insertions(+), 348 deletions(-) diff --git a/docs/howtos/add-users.md b/docs/howtos/add-users.md index c3d5fb2..0ee11f4 100644 --- a/docs/howtos/add-users.md +++ b/docs/howtos/add-users.md @@ -2,9 +2,7 @@ # Add Users This is a quick guide on how to add users to organizations and how to manage -their privileges. This information can also be found in the CrateDB Cloud -Console {ref}`Overview `, but is presented here separately -for ease of use. +their privileges. In CrateDB Cloud, you can add team members to your organizations. In order to add a user, they must first have signed up for CrateDB Cloud. Once they have diff --git a/docs/howtos/delete-cluster.md b/docs/howtos/delete-cluster.md index 12372fb..b0ed209 100644 --- a/docs/howtos/delete-cluster.md +++ b/docs/howtos/delete-cluster.md @@ -7,12 +7,6 @@ through Microsoft Azure, the other is for a cluster created through AWS. For Azure, there are in turn two methods: via the CrateDB Cloud Console and through the Azure Portal. Each are outlined in the Azure section. -Although the {ref}`general documentation ` -for the CrateDB Cloud Console explains how you can delete a cluster -specifically within the Console, this tutorial provides a step-by-step -guide for *all* methods of deleting a CrateDB Cloud cluster. This is to -make the process more transparent and easier to find and use. - :::{Warning} All cluster data will be lost on deletion. This action cannot be undone. ::: diff --git a/docs/howtos/restore-backups.md b/docs/howtos/restore-backups.md index 0773ead..b3942ae 100644 --- a/docs/howtos/restore-backups.md +++ b/docs/howtos/restore-backups.md @@ -7,9 +7,6 @@ how one can use such snapshots to restore data. A more detailed technical discussion of how CrateDB handles snapshots can be found in the CrateDB documentation about {ref}`snapshots. ` -You may also want to read the full Cloud reference documentation on -{ref}`backups. ` - (snapshot-backup)= ## CrateDB Cloud's backup policy diff --git a/docs/reference/glossary.md b/docs/reference/glossary.md index ba6e894..5df3d2b 100644 --- a/docs/reference/glossary.md +++ b/docs/reference/glossary.md @@ -91,9 +91,6 @@ Cloud also supports a CLI for interacting with the service, we assume use of the Console by default. Only the Console allows deployment of a {ref}`cluster `. -For information on how to use specific elements of the Console, refer to -the {ref}`Console overview `. - (gloss-consumer)= ## Consumer @@ -301,10 +298,6 @@ In CrateDB Cloud, there are two distinct system {ref}`explanation ` in the CrateDB Cloud reference. -:::{note} -See also {ref}`Audit Log ` -::: - (gloss-tier)= ## Tier @@ -352,9 +345,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'. All available upgrades are -visible in the {ref}`Manage Tab ` of the -cluster detailed view. +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 9e2058f..e414bb5 100644 --- a/docs/tutorials/deploy/croud.md +++ b/docs/tutorials/deploy/croud.md @@ -1,322 +1,322 @@ -(cluster-deployment-croud)= -# Deploy cluster with Croud - -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 ` -on your system. - -::::{grid} 1 1 1 1 - -:::{grid-item-card} {octicon}`code` Croud Reference Documentation -:link: https://cratedb.com/docs/cloud/cli/en/latest/ -Visit full reference documentation to learn more about Croud. -::: - -:::: - -Currently, it is not possible to create new subscriptions using Croud, -so you will need to use the CrateDB Cloud Console UI. - -The payment processing and billing is powered by Stripe. It is also -possible to subscribe using Azure and AWS. - -:::{warning} -Because of the current implementation of subscriptions, it is NOT -recommended to deploy your first cluster with Croud. You need to have an -existing subscription to deploy a cluster using Croud. To create a -subscription, [use UI](https://console.cratedb.cloud). -::: - -Deploy a CrateDB cluster using the CrateDB Cloud Web Console. -::: - -(croud-log-in)= -## Log in - -When working with Croud, the first step is always logging into your -account. - -Croud, being a CLI application, is operated using commands. Commands -should be issued using the following format: - -:::{code} -sh$ croud [COMMAND] [OPTIONS] -::: - -To log in execute this command: - -:::{code} -sh$ croud login -::: - -This will open a browser window where you will be prompted for your -credentials. You can also log in using *azuread*, -*github*, or *google* using the `--idp` argument. See full [Authentication -documentation](https://crate.io/docs/cloud/cli/en/latest/commands/authentication.html) -for details. - -![Croud login](../../_assets/img/croud-login.png) - -After successfully logging in, you will see this prompt in your browser: - -:::{code} console -You have successfully logged into CrateDB Cloud! -This window can be closed. -::: - -(croud-create-organization)= -## Create organization - -The first step of deployment is creating an organization which will -contain your cluster. If you've registered recently, or didn't delete -the organization that was created automatically, you can skip this step: - -:::{code} console -sh$ croud organizations create --name samplecroudorganization -::: - -This will create an organization called "samplecroudorganization". - -(croud-create-project) -## Create subscription - -The next step is to create a subscription in your organization. To create a -new subscription execute this command: - -:::{code} console -sh$ croud subscriptions create --type contract --org-id -::: - -This will create a new subscription. - -(croud-deploy-cluster) -## Deploy cluster - -When deploying a cluster, these are the required arguments: - -`--product-name` - -: The product name to use. - -`--tier` - -: The product tier to use. - - -`--cluster-name` - -: The CrateDB cluster name to use. - -`--version` - -: The CrateDB version to use. - -`--username` - -: The CrateDB username to use. - -`--password` - -: The CrateDB password to use. - -`--subscription-id` - -: The CrateDB subscription to use. - -`--region` - -: The region the cluster will be created in. - - -(croud-deploy-example)= -### Example - -:::{code} console -sh$ croud clusters deploy / - --product-name cr1 / - --tier default / - --cluster-name my-crate-cluster / - --region aks1.eastus2 / - --version 5.8.1 / - --username admin / - --password "as6da9ddasfaad7i902jcv780dmcba" / - --subscription-id 782dfc00-7b25-4f48-8381-b1b096dd1619 - - -+--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------+ -| id | name | numNodes | crateVersion | projectId | username | fqdn | -|--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------| -| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-crate-cluster | 1 | 5.8.1 | 952cd102-91c1-4837-962a-12ecb71a6ba8 | admin | my-crate-cluster.eastus2.azure.cratedb.net. | -+--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------+ -==> Info: Cluster creation initiated. It may take a few minutes to complete. -==> Info: Status: REGISTERED (Your creation request was received and is pending processing.) -==> Info: Status: IN_PROGRESS (Cluster creation started. Waiting for the node(s) to be created and creating other required resources.) -==> Success: Operation completed. -+--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------+ -| id | name | numNodes | crateVersion | projectId | username | fqdn | -|--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------| -| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-crate-cluster | 1 | 5.8.1 | 952cd102-91c1-4837-962a-12ecb71a6ba8 | admin | my-crate-cluster.eastus.azure.cratedb.net. | -+--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------+ -::: - -:::{note} - -**Parameters tips:** - -The minimum length of a password is 24 characters. - -* To see all the available products issue: `croud products list`. -* To see all regions available issue: `croud regions list`. -* To find out your *subscription-id* issue: - `croud subscriptions list`. -::: - -:::{note} -Complete documentation on clusters in Croud, including all the -deployment arguments, can be found -[here](https://crate.io/docs/cloud/cli/en/latest/commands/clusters.html). -::: - -(croud-deploy-specific-version)= -### Deploying a cluster with a specific version - -You may want to deploy a cluster with a version other than the latest. -You can do this using the `--version` parameter. Historical -[Stable](https://hub.docker.com/_/crate/tags) and -[Testing](https://hub.docker.com/r/crate/crate/tags) or Nightly builds -are all public and available to any user. To use the Nightly/Testing -channels, you must use the `--channel` parameter. - -:::{code} -sh$ croud clusters deploy --product-name cr1 / - --tier default / - --cluster-name my-crate-cluster / - --region aks1.eastus.azure - --version 5.8.1 / - --username admin / - --password "as6da9ddasfaad7i902jcv780dmcba" / - --subscription-id 3a35974f-5319-47fb-9a1f-ab85dca75c86 / - --channel testing -::: - -This command deploys a *5.2.0* version cluster. - -Alternatively, you can deploy a cluster with an older version, like -this: - -:::{code} -sh$ croud clusters deploy / - --product-name cr1 / - --tier default / - --cluster-name my-crate-cluster / - --region aks1.eastus.azure - --version 5.8.1 / - --username admin / - --password "as6da9ddasfaad7i902jcv780dmcba" / - --subscription-id 3a35974f-5319-47fb-9a1f-ab85dca75c86 -::: - -(croud-scale-cluster)= -## Scale cluster - -Clusters can be scaled at any time, this allows you to add more nodes or -more storage to your cluster. - -(croud-scaling)= -### Scaling - -Required arguments: - -`--cluster-id` - -: The CrateDB cluster ID to use. - -`--unit` - -: The product scale unit to use. This parameter SETS the amount of - nodes. I.e. - - * `--unit 0` means **1 node** - * `--unit 1` means **2 nodes** - * `--unit 2` means **3 nodes** etc. - - This allows you to scale the performance of your cluster up or - down. - -Example: - -:::{code} console -sh$ croud clusters scale \ - --cluster-id 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 \ - --unit 1 - -+--------------------------------------+------------------------+----------+ -| id | name | numNodes | -|--------------------------------------+------------------------+----------| -| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-crate-cluster | 1 | -+--------------------------------------+------------------------+----------+ -==> Info: Cluster scaling initiated. It may take a few minutes to complete the changes. -==> Info: Status: SENT (Your scaling request was sent to the region.) -==> Info: Status: IN_PROGRESS (Scaling up from 1 to 2 nodes. Waiting for new -node(s) to be present.) -==> Success: Operation completed. -+--------------------------------------+------------------------+----------+ -| id | name | numNodes | -|--------------------------------------+------------------------+----------| -| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-crate-cluster | 2 | -+--------------------------------------+------------------------+----------+ -::: - -(croud-scaling-expansion)= -### Storage expansion - -Required arguments: - -`--cluster-id` - -: The CrateDB cluster ID to use. - -`--disk-size-gb` - -: New size of attached disks (in GiB). This parameter sets the storage - to the size specified in parameter. **It is not possible to reduce - storage.** - -Example: - -:::{code} console -sh$ croud clusters expand-storage \ - --cluster-id 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 \ - --disk-size-gb 512 -+--------------------------------------+------------------------+------------------------------------+ -| id | name | hardware_specs | -|--------------------------------------+------------------------+------------------------------------| -| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-crate-cluster | Disk size: 256.0 GiB | -+--------------------------------------+------------------------+------------------------------------+ -==> Info: Cluster storage expansion initiated. It may take a few minutes to complete the changes. -==> Info: Status: REGISTERED (Your storage expansion request was received and is pending processing.) -==> Info: Status: SENT (Your storage expansion request was sent to the region.) -==> Info: Status: IN_PROGRESS (Suspending cluster and waiting for Persistent Volume Claim(s) to be resized.) -==> Info: Status: IN_PROGRESS (Starting cluster. Scaling back up to 3 nodes. Waiting for node(s) to be present.) -==> Success: Operation completed. -+--------------------------------------+------------------------+------------------------------------+ -| id | name | hardware_specs | -|--------------------------------------+------------------------+------------------------------------| -| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-crate-cluster | Disk size: 512.0 GiB | -+--------------------------------------+------------------------+------------------------------------+ -::: - -:::{warning} -When increasing storage size of a cluster, it is temporarily stopped, -while the operation finishes. -::: - -:::{note} -For all available arguments for the scaling command, see the [cluster -scale](https://crate.io/docs/cloud/cli/en/latest/commands/clusters.html#clusters-scale) -and [cluster storage -expansion](https://crate.io/docs/cloud/cli/en/latest/commands/clusters.html#clusters-expand-storage) -documentation. -::: +(cluster-deployment-croud)= +# Deploy cluster with Croud + +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 ` +on your system. + +::::{grid} 1 1 1 1 + +:::{grid-item-card} {octicon}`code` Croud Reference Documentation +:link: https://cratedb.com/docs/cloud/cli/en/latest/ +Visit full reference documentation to learn more about Croud. +::: + +:::: + +Currently, it is not possible to create new subscriptions using Croud, +so you will need to use the CrateDB Cloud Console UI. + +The payment processing and billing is powered by Stripe. It is also +possible to subscribe using Azure and AWS. + +:::{warning} +Because of the current implementation of subscriptions, it is NOT +recommended to deploy your first cluster with Croud. You need to have an +existing subscription to deploy a cluster using Croud. To create a +subscription, [use UI](https://console.cratedb.cloud). +::: + +Deploy a CrateDB cluster using the CrateDB Cloud Web Console. +::: + +(croud-log-in)= +## Log in + +When working with Croud, the first step is always logging into your +account. + +Croud, being a CLI application, is operated using commands. Commands +should be issued using the following format: + +:::{code} +sh$ croud [COMMAND] [OPTIONS] +::: + +To log in execute this command: + +:::{code} +sh$ croud login +::: + +This will open a browser window where you will be prompted for your +credentials. You can also log in using *azuread*, +*github*, or *google* using the `--idp` argument. See full [Authentication +documentation](https://crate.io/docs/cloud/cli/en/latest/commands/authentication.html) +for details. + +![Croud login](../../_assets/img/croud-login.png) + +After successfully logging in, you will see this prompt in your browser: + +:::{code} console +You have successfully logged into CrateDB Cloud! +This window can be closed. +::: + +(croud-create-organization)= +## Create organization + +The first step of deployment is creating an organization which will +contain your cluster. If you've registered recently, or didn't delete +the organization that was created automatically, you can skip this step: + +:::{code} console +sh$ croud organizations create --name samplecroudorganization +::: + +This will create an organization called "samplecroudorganization". + +(croud-create-project) +## Create subscription + +The next step is to create a subscription in your organization. To create a +new subscription execute this command: + +:::{code} console +sh$ croud subscriptions create --type contract --org-id +::: + +This will create a new subscription. + +(croud-deploy-cluster) +## Deploy cluster + +When deploying a cluster, these are the required arguments: + +`--product-name` + +: The product name to use. + +`--tier` + +: The product tier to use. + + +`--cluster-name` + +: The CrateDB cluster name to use. + +`--version` + +: The CrateDB version to use. + +`--username` + +: The CrateDB username to use. + +`--password` + +: The CrateDB password to use. + +`--subscription-id` + +: The CrateDB subscription to use. + +`--region` + +: The region the cluster will be created in. + + +(croud-deploy-example)= +### Example + +:::{code} console +sh$ croud clusters deploy / + --product-name cr1 / + --tier default / + --cluster-name my-crate-cluster / + --region aks1.eastus2 / + --version 5.8.1 / + --username admin / + --password "as6da9ddasfaad7i902jcv780dmcba" / + --subscription-id 782dfc00-7b25-4f48-8381-b1b096dd1619 + + ++--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------+ +| id | name | numNodes | crateVersion | projectId | username | fqdn | +|--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------| +| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-crate-cluster | 1 | 5.8.1 | 952cd102-91c1-4837-962a-12ecb71a6ba8 | admin | my-crate-cluster.eastus2.azure.cratedb.net. | ++--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------+ +==> Info: Cluster creation initiated. It may take a few minutes to complete. +==> Info: Status: REGISTERED (Your creation request was received and is pending processing.) +==> Info: Status: IN_PROGRESS (Cluster creation started. Waiting for the node(s) to be created and creating other required resources.) +==> Success: Operation completed. ++--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------+ +| id | name | numNodes | crateVersion | projectId | username | fqdn | +|--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------| +| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-crate-cluster | 1 | 5.8.1 | 952cd102-91c1-4837-962a-12ecb71a6ba8 | admin | my-crate-cluster.eastus.azure.cratedb.net. | ++--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------+ +::: + +:::{note} + +**Parameters tips:** + +The minimum length of a password is 24 characters. + +* To see all the available products issue: `croud products list`. +* To see all regions available issue: `croud regions list`. +* To find out your *subscription-id* issue: + `croud subscriptions list`. +::: + +:::{note} +Complete documentation on clusters in Croud, including all the +deployment arguments, can be found +[here](https://crate.io/docs/cloud/cli/en/latest/commands/clusters.html). +::: + +(croud-deploy-specific-version)= +### Deploying a cluster with a specific version + +You may want to deploy a cluster with a version other than the latest. +You can do this using the `--version` parameter. Historical +[Stable](https://hub.docker.com/_/crate/tags) and +[Testing](https://hub.docker.com/r/crate/crate/tags) or Nightly builds +are all public and available to any user. To use the Nightly/Testing +channels, you must use the `--channel` parameter. + +:::{code} +sh$ croud clusters deploy --product-name cr1 / + --tier default / + --cluster-name my-crate-cluster / + --region aks1.eastus.azure + --version 5.8.1 / + --username admin / + --password "as6da9ddasfaad7i902jcv780dmcba" / + --subscription-id 3a35974f-5319-47fb-9a1f-ab85dca75c86 / + --channel testing +::: + +This command deploys a *5.2.0* version cluster. + +Alternatively, you can deploy a cluster with an older version, like +this: + +:::{code} +sh$ croud clusters deploy / + --product-name cr1 / + --tier default / + --cluster-name my-crate-cluster / + --region aks1.eastus.azure + --version 5.8.1 / + --username admin / + --password "as6da9ddasfaad7i902jcv780dmcba" / + --subscription-id 3a35974f-5319-47fb-9a1f-ab85dca75c86 +::: + +(croud-scale-cluster)= +## Scale cluster + +Clusters can be scaled at any time, this allows you to add more nodes or +more storage to your cluster. + +(croud-scaling)= +### Scaling + +Required arguments: + +`--cluster-id` + +: The CrateDB cluster ID to use. + +`--unit` + +: The product scale unit to use. This parameter SETS the amount of + nodes. I.e. + + * `--unit 0` means **1 node** + * `--unit 1` means **2 nodes** + * `--unit 2` means **3 nodes** etc. + + This allows you to scale the performance of your cluster up or + down. + +Example: + +:::{code} console +sh$ croud clusters scale \ + --cluster-id 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 \ + --unit 1 + ++--------------------------------------+------------------------+----------+ +| id | name | numNodes | +|--------------------------------------+------------------------+----------| +| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-crate-cluster | 1 | ++--------------------------------------+------------------------+----------+ +==> Info: Cluster scaling initiated. It may take a few minutes to complete the changes. +==> Info: Status: SENT (Your scaling request was sent to the region.) +==> Info: Status: IN_PROGRESS (Scaling up from 1 to 2 nodes. Waiting for new +node(s) to be present.) +==> Success: Operation completed. ++--------------------------------------+------------------------+----------+ +| id | name | numNodes | +|--------------------------------------+------------------------+----------| +| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-crate-cluster | 2 | ++--------------------------------------+------------------------+----------+ +::: + +(croud-scaling-expansion)= +### Storage expansion + +Required arguments: + +`--cluster-id` + +: The CrateDB cluster ID to use. + +`--disk-size-gb` + +: New size of attached disks (in GiB). This parameter sets the storage + to the size specified in parameter. **It is not possible to reduce + storage.** + +Example: + +:::{code} console +sh$ croud clusters expand-storage \ + --cluster-id 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 \ + --disk-size-gb 512 ++--------------------------------------+------------------------+------------------------------------+ +| id | name | hardware_specs | +|--------------------------------------+------------------------+------------------------------------| +| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-crate-cluster | Disk size: 256.0 GiB | ++--------------------------------------+------------------------+------------------------------------+ +==> Info: Cluster storage expansion initiated. It may take a few minutes to complete the changes. +==> Info: Status: REGISTERED (Your storage expansion request was received and is pending processing.) +==> Info: Status: SENT (Your storage expansion request was sent to the region.) +==> Info: Status: IN_PROGRESS (Suspending cluster and waiting for Persistent Volume Claim(s) to be resized.) +==> Info: Status: IN_PROGRESS (Starting cluster. Scaling back up to 3 nodes. Waiting for node(s) to be present.) +==> Success: Operation completed. ++--------------------------------------+------------------------+------------------------------------+ +| id | name | hardware_specs | +|--------------------------------------+------------------------+------------------------------------| +| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-crate-cluster | Disk size: 512.0 GiB | ++--------------------------------------+------------------------+------------------------------------+ +::: + +:::{warning} +When increasing storage size of a cluster, it is temporarily stopped, +while the operation finishes. +::: + +:::{note} +For all available arguments for the scaling command, see the [cluster +scale](https://crate.io/docs/cloud/cli/en/latest/commands/clusters.html#clusters-scale) +and [cluster storage +expansion](https://crate.io/docs/cloud/cli/en/latest/commands/clusters.html#clusters-expand-storage) +documentation. +::: diff --git a/docs/tutorials/edge/self-hosted-edge.md b/docs/tutorials/edge/self-hosted-edge.md index a7bc5f2..96b95f8 100644 --- a/docs/tutorials/edge/self-hosted-edge.md +++ b/docs/tutorials/edge/self-hosted-edge.md @@ -119,8 +119,7 @@ before the full install. The `` in question is the token you receive from the CrateDB Console Cloud on Kubernetes region field in the Regions tab of the Organization -Overview. For more information on this section of the CrateDB Console, -refer to the {ref}`CrateDB Cloud Console overview `. +Overview. With this, you should be ready to use CrateDB Cloud on Kubernetes via Microk8s. @@ -236,8 +235,7 @@ before the full install. The `` in question is the token you receive from the CrateDB Console Cloud on Kubernetes region field in the Regions tab of the Organization -Overview. For more information on this section of the CrateDB Console, -refer to the {ref}`CrateDB Cloud Console overview `. +Overview. With this, you should be ready to use CrateDB Cloud on Kubernetes via K3S.