From d2cd18672d915407e9dd00eb290fba5dccceb55c Mon Sep 17 00:00:00 2001 From: Georg Traar Date: Thu, 22 Feb 2024 13:56:55 +0100 Subject: [PATCH] Rename CrateDB Edge to CrateDB Cloud on Kubernetes --- .../cratedb-edge-cluster-dashboard.json | 2 +- docs/_extra/cratedb-edge-logs-dashboard.json | 2 +- docs/index.md | 2 +- docs/reference/glossary.rst | 10 ++--- docs/reference/overview.rst | 8 ++-- docs/reference/subscription-plans.rst | 6 +-- .../deploy/marketplace/subscribe-aws.rst | 2 +- .../deploy/marketplace/subscribe-azure.rst | 2 +- docs/tutorials/edge/custom-backup.rst | 6 +-- docs/tutorials/edge/index.rst | 14 +++---- docs/tutorials/edge/introduction.rst | 38 +++++++++---------- docs/tutorials/edge/managed-kubernetes.rst | 38 +++++++++---------- docs/tutorials/edge/monitoring.rst | 14 +++---- docs/tutorials/edge/self-hosted-edge.rst | 24 ++++++------ 14 files changed, 84 insertions(+), 84 deletions(-) diff --git a/docs/_extra/cratedb-edge-cluster-dashboard.json b/docs/_extra/cratedb-edge-cluster-dashboard.json index 4218cd8..0abdc0d 100644 --- a/docs/_extra/cratedb-edge-cluster-dashboard.json +++ b/docs/_extra/cratedb-edge-cluster-dashboard.json @@ -859,7 +859,7 @@ }, "timepicker": {}, "timezone": "", - "title": "CrateDB Edge Cluster Monitoring", + "title": "CrateDB Cloud on Kubernetes Cluster Monitoring", "uid": "UYJt9qn4k", "version": 5 } diff --git a/docs/_extra/cratedb-edge-logs-dashboard.json b/docs/_extra/cratedb-edge-logs-dashboard.json index cf27a68..913c208 100644 --- a/docs/_extra/cratedb-edge-logs-dashboard.json +++ b/docs/_extra/cratedb-edge-logs-dashboard.json @@ -107,7 +107,7 @@ }, "timepicker": {}, "timezone": "", - "title": "CrateDB Edge Logs Monitoring", + "title": "CrateDB Cloud on Kubernetes Logs Monitoring", "uid": "wvqz_CnVz", "version": 3 } diff --git a/docs/index.md b/docs/index.md index 7a93ea5..5836544 100644 --- a/docs/index.md +++ b/docs/index.md @@ -61,7 +61,7 @@ A command-line based terminal program to operate your managed clusters. ::: -:::{grid-item-card} {octicon}`container` CrateDB Edge +:::{grid-item-card} {octicon}`container` CrateDB Cloud on Kubernetes :link: edge :link-type: ref diff --git a/docs/reference/glossary.rst b/docs/reference/glossary.rst index cb0c203..73887a1 100644 --- a/docs/reference/glossary.rst +++ b/docs/reference/glossary.rst @@ -145,10 +145,10 @@ clusters can only be deployed within the Console. .. _gloss-edge: -Edge ----- +CrateDB Cloud on Kubernetes +--------------------------- -CrateDB Edge is a hybrid cloud database solution presented by Crate.io. It +CrateDB Cloud on Kubernetes is a hybrid cloud database solution presented by Crate.io. 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 accessed through the @@ -248,8 +248,8 @@ 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 Edge also permits the creation of custom regions. These -regions are designed to correspond to servers used by CrateDB Edge customers +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. diff --git a/docs/reference/overview.rst b/docs/reference/overview.rst index 5690b94..880a534 100644 --- a/docs/reference/overview.rst +++ b/docs/reference/overview.rst @@ -168,8 +168,8 @@ In this tab, you will see the available :ref:`regions ` for cluster deployment. It is possible to deploy clusters on this screen as well, by clicking the *Deploy cluster* button under each respective region field. -For those with access to `CrateDB Edge`_, this tab also allows the deployment -of :ref:`CrateDB Edge ` clusters in a :ref:`custom region +For those with access to `CrateDB Cloud on Kubernetes`_, this tab also allows the deployment +of :ref:`CrateDB Cloud on Kubernetes ` clusters in a :ref:`custom region `. To do so, provide a name for the custom region and click the *Create edge region* button. Once created, the custom region will appear: @@ -725,8 +725,8 @@ about uncertainties or problems you are having when using our products. .. _CrateDB Cloud: https://crate.io/products/cratedb-cloud/ .. _CrateDB Cloud Console: https://console.cratedb.cloud .. _CrateDB Cloud support: support@crate.io -.. _CrateDB Edge: https://crate.io/products/cratedb-edge/ -.. _CrateDB Edge region: https://crate.io/docs/cloud/tutorials/en/latest/edge/index.html +.. _CrateDB Cloud on Kubernetes: https://crate.io/products/cratedb-edge/ +.. _CrateDB Cloud on Kubernetes region: https://crate.io/docs/cloud/tutorials/en/latest/edge/index.html .. _Croud: https://crate.io/docs/cloud/cli/en/latest/ .. _Croud clusters upgrade: https://crate.io/docs/cloud/cli/en/latest/commands/clusters.html#clusters-upgrade .. _deploy a trial cluster on the CrateDB Cloud Console for free: https://crate.io/lp-free-trial diff --git a/docs/reference/subscription-plans.rst b/docs/reference/subscription-plans.rst index 7a3aeeb..0f57af9 100644 --- a/docs/reference/subscription-plans.rst +++ b/docs/reference/subscription-plans.rst @@ -61,9 +61,9 @@ Each product/plan has two dimensions: compute and storage. .. note:: - `CrateDB Edge`_ works differently. Since it allows hosting CrateDB Cloud + `CrateDB Cloud on Kubernetes`_ works differently. Since it allows hosting CrateDB Cloud on your local or self-service Kubernetes stack, there is no need for - different subscription plans. You can combine CrateDB Edge with any + different subscription plans. You can combine CrateDB Cloud on Kubernetes with any suitable hardware configuration that works for your use case. .. _crfree: @@ -177,7 +177,7 @@ cloud providers on the SaaS Marketplaces. For more information, contact the .. _Azure offer page: https://azuremarketplace.microsoft.com/en-us/marketplace/apps/crate.cratedbcloud?tab=Overview .. _contact us: sales@crate.io .. _Contract page on the AWS Marketplace: https://aws.amazon.com/marketplace/pp/B08KHK34RK -.. _CrateDB Edge: https://crate.io/products/cratedb-edge/ +.. _CrateDB Cloud on Kubernetes: https://crate.io/products/cratedb-edge/ .. _deployment tutorial: https://crate.io/docs/cloud/tutorials/en/latest/cluster-deployment/stripe.html .. _pricing page: https://crate.io/pricing .. _Sales department: sales@crate.io diff --git a/docs/tutorials/deploy/marketplace/subscribe-aws.rst b/docs/tutorials/deploy/marketplace/subscribe-aws.rst index eecf2db..45e19c4 100644 --- a/docs/tutorials/deploy/marketplace/subscribe-aws.rst +++ b/docs/tutorials/deploy/marketplace/subscribe-aws.rst @@ -12,7 +12,7 @@ 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. If you are looking for a self-hosted CrateDB Cloud service, check out -the :ref:`CrateDB Edge tutorial `. To pay directly for a hosted cluster +the :ref:`CrateDB Cloud on Kubernetes tutorial `. To pay directly for a hosted cluster by credit card, see the tutorial for :ref:`direct cluster deployment `. diff --git a/docs/tutorials/deploy/marketplace/subscribe-azure.rst b/docs/tutorials/deploy/marketplace/subscribe-azure.rst index 3921cb3..050bdaf 100644 --- a/docs/tutorials/deploy/marketplace/subscribe-azure.rst +++ b/docs/tutorials/deploy/marketplace/subscribe-azure.rst @@ -13,7 +13,7 @@ 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. If you are looking for a self-hosted CrateDB Cloud service, check out -the :ref:`CrateDB Edge tutorial `. To pay directly for a hosted cluster +the :ref:`CrateDB Cloud on Kubernetes tutorial `. To pay directly for a hosted cluster by credit card, see the tutorial for :ref:`direct cluster deployment `. diff --git a/docs/tutorials/edge/custom-backup.rst b/docs/tutorials/edge/custom-backup.rst index f29e8f7..c669298 100644 --- a/docs/tutorials/edge/custom-backup.rst +++ b/docs/tutorials/edge/custom-backup.rst @@ -3,9 +3,9 @@ Custom backup location ====================== -This guide introduces a feature of CrateDB Edge that lets users specify their +This guide introduces a feature of CrateDB Cloud on Kubernetes that lets users specify their backup location. This gives you full ownership and control of your data when -using CrateDB Edge. +using CrateDB Cloud on Kubernetes. .. rubric:: Table of contents @@ -17,7 +17,7 @@ using CrateDB Edge. Prerequisites ------------- -- This guide describes only the final deployment stage of the CrateDB Edge +- This guide describes only the final deployment stage of the CrateDB Cloud on Kubernetes cluster. For the full instructions, see either the :ref:`Self-hosted Edge `, or the :ref:`Managed Edge ` tutorials. diff --git a/docs/tutorials/edge/index.rst b/docs/tutorials/edge/index.rst index 1ae4606..876d3fe 100644 --- a/docs/tutorials/edge/index.rst +++ b/docs/tutorials/edge/index.rst @@ -1,17 +1,17 @@ .. _edge: -============ -CrateDB Edge -============ +=========================== +CrateDB Cloud on Kubernetes +=========================== -**CrateDB Edge** is the hybrid cloud database solution integrating CrateDB clusters +**CrateDB Cloud on Kubernetes** is the hybrid cloud database solution integrating CrateDB clusters and the CrateDB Cloud software stack with on-premise or customer-controlled cloud infrastructure. Introduction ============ -The CrateDB Edge concept is simple. You bring your own Kubernetes +The CrateDB Cloud on Kubernetes concept is simple. You bring your own Kubernetes infrastructure - whether in a production site, office, laboratory, or local setup, or in your existing managed cloud infrastructure on AWS, Azure, or GCP. @@ -23,7 +23,7 @@ seamless scaling and easy cluster management. Details ======= -The process of getting CrateDB Edge running is supported by the CrateDB Cloud +The process of getting CrateDB Cloud on Kubernetes running is supported by the CrateDB Cloud Console. Even so, there are some steps involved, and some requirements have to be met in @@ -41,7 +41,7 @@ for some lightweight Kubernetes distributions, like K3s and Microk8s. Then, we explain how to set up a custom backup location, so you can keep full ownership of your data backups. -We also introduce a way to monitor your CrateDB Edge cluster in the +We also introduce a way to monitor your CrateDB Cloud on Kubernetes cluster in the visualization tool Grafana coupled with Loki and Prometheus. .. rubric:: Table of contents diff --git a/docs/tutorials/edge/introduction.rst b/docs/tutorials/edge/introduction.rst index f9e389c..77d464b 100644 --- a/docs/tutorials/edge/introduction.rst +++ b/docs/tutorials/edge/introduction.rst @@ -6,16 +6,16 @@ Introduction .. NOTE:: You must have `wget`_ and `jq`_ installed for the script to function. - CrateDB Edge is currently in Pre-Release. CrateDB Edge and related services + CrateDB Cloud on Kubernetes is currently in Pre-Release. CrateDB Cloud on Kubernetes and related services are provided on an "as is" basis and may change at any time. Crate.io provides no guarantees or warranty regarding the usability or performance - of CrateDB Edge. The CrateDB Cloud Service Level Agreement (SLA) is - expressly disclaimed for the use of CrateDB Edge and related services until - further notice. By using CrateDB Edge, you agree to these terms and + of CrateDB Cloud on Kubernetes. The CrateDB Cloud Service Level Agreement (SLA) is + expressly disclaimed for the use of CrateDB Cloud on Kubernetes and related services until + further notice. By using CrateDB Cloud on Kubernetes, you agree to these terms and conditions. Should you find any errors, bugs, or functionality problems while using the - CrateDB Edge Pre-Release, please let us know using the `contact page`_ or + CrateDB Cloud on Kubernetes Pre-Release, please let us know using the `contact page`_ or `support email`_. .. rubric:: Table of contents @@ -29,7 +29,7 @@ Prerequisites ------------- Certain hardware and software specifications must be met in order to make use -of CrateDB Edge. The most important of these is that you must provide a working +of CrateDB Cloud on Kubernetes. The most important of these is that you must provide a working Kubernetes cluster, one that meets the following requirements: .. rst-class:: open @@ -41,21 +41,21 @@ Kubernetes cluster, one that meets the following requirements: * Sufficient CPU per node to run the CrateDB Cloud software stack as well as sufficient compute to run the CrateDB instances desired. We recommend the use - of a K8s autoscaler. For reference, the CrateDB Edge stack - without Grafana + of a K8s autoscaler. For reference, the CrateDB Cloud on Kubernetes stack - without Grafana or Loki - requires about 2 CPUs and 2500 Mi of memory. We recommend at least 4 CPUs per node for reliable performance. * A Kubernetes version 1.20, 1.21, or 1.22; * A storage class for persisting your data (SSD recommended). As outlined in - the installation script, CrateDB Edge expects the storage classes + the installation script, CrateDB Cloud on Kubernetes expects the storage classes ``crate-premium`` (SSD) and ``crate-standard`` (SSD or Spindle). Also ensure that you are able to set the field ``allowVolumeExpansion`` to ``true``. * Unless you are experienced with operating Kubernetes clusters, we recommend - to start with a dedicated Kubernetes cluster for CrateDB Edge. If you use an + to start with a dedicated Kubernetes cluster for CrateDB Cloud on Kubernetes. If you use an existing Kubernetes setup, be aware that the following components will be - set up during installation of CrateDB Edge, which may interfere with your + set up during installation of CrateDB Cloud on Kubernetes, which may interfere with your existing configuration: * cert-manager (version 1.6.1) @@ -69,13 +69,13 @@ Console in order to deploy the cluster itself, using the provided script. These steps will be explained below. Some Kubernetes knowledge, especially regarding networking and storage, is -recommended when using CrateDB Edge, especially when using it as-is. If you're -uncertain, you may benefit from using CrateDB Edge in combination with +recommended when using CrateDB Cloud on Kubernetes, especially when using it as-is. If you're +uncertain, you may benefit from using CrateDB Cloud on Kubernetes in combination with :ref:`cloud providers or third-party tools ` as described further down in this tutorial. .. NOTE:: - A special note about bare metal Kubernetes clusters: CrateDB Edge should + A special note about bare metal Kubernetes clusters: CrateDB Cloud on Kubernetes should work on any bare metal cluster, but the CrateDB instances running within require a load balancer for outside access. If you do not have a load balancer (for example `MetalLB`_), you can still access the CrateDB @@ -158,8 +158,8 @@ Manifest and verification ''''''''''''''''''''''''' Once you satisfy the prerequisites, the script will ask for your confirmation -to install CrateDB Edge. Type Y or y to continue. The script will then -download the manifest files for the CrateDB Edge service and apply them. +to install CrateDB Cloud on Kubernetes. Type Y or y to continue. The script will then +download the manifest files for the CrateDB Cloud on Kubernetes service and apply them. In the final stage, the script will loop over the services and check their availability. It continues doing this until all required services have become @@ -236,13 +236,13 @@ cluster configuration. Configure your desired hardware values for CPU, RAM, storage, and number of nodes. .. image:: ../../_assets/img/cloud-edge-config.png - :alt: Cluster configuration panels for CrateDB Edge + :alt: Cluster configuration panels for CrateDB Cloud on Kubernetes On the right the cluster scale overview shows the total hardware values for the cluster. This is simply the number of nodes you have chosen, multiplied by the values per node you have defined. -You can also define the backup location of your CrateDB Edge cluster. You +You can also define the backup location of your CrateDB Cloud on Kubernetes cluster. You have the option of either using the default backup location for CrateDB Cloud, which is managed by us, or use a custom backup location that is convenient to you. This has to be an S3 bucket or a location with an equivalent @@ -301,14 +301,14 @@ region. Deleting a custom region does not delete the resources inside that region. To also delete the resources inside the region, run the script provided in the deletion confirmation screen in your local CLI before confirming the deletion -in the console. This will uninstall CrateDB Edge from your local Kubernetes +in the console. This will uninstall CrateDB Cloud on Kubernetes from your local Kubernetes cluster. To finalize the deletion of the custom region, enter the name of your region into the form. .. image:: ../../_assets/img/cloud-edge-delete.png - :alt: CrateDB Edge deletion confirmation screen + :alt: CrateDB Cloud on Kubernetes deletion confirmation screen .. _Admin UI: https://crate.io/docs/crate/admin-ui/en/latest/console.html .. _Helm: https://helm.sh/docs/intro/quickstart/ diff --git a/docs/tutorials/edge/managed-kubernetes.rst b/docs/tutorials/edge/managed-kubernetes.rst index 556d559..f23e8c1 100644 --- a/docs/tutorials/edge/managed-kubernetes.rst +++ b/docs/tutorials/edge/managed-kubernetes.rst @@ -10,12 +10,12 @@ Ocean`_ and `Google Cloud Platform`_. .. NOTE:: These guides are provided as example scenarios only. Other managed Kubernetes providers or preconfigured Kubernetes distributions may also - work with CrateDB Edge. + work with CrateDB Cloud on Kubernetes. These are third-party tools and Crate.io is not responsible for those tools. That said, we have tested the instructions provided below for functionality. Users less familiar with customizing their Kubernetes stack on their own may -find any of these approaches a practical solution for easier CrateDB Edge +find any of these approaches a practical solution for easier CrateDB Cloud on Kubernetes setup. .. rubric:: Table of contents @@ -30,9 +30,9 @@ Azure AKS --------- Below is a step-by-step guide to using Azure AKS as a managed Kubernetes -provider in combination with CrateDB Edge. The steps are merely examples of a +provider in combination with CrateDB Cloud on Kubernetes. The steps are merely examples of a process validated by us; other methods may work also. We provide this -information for ease of use and to illustrate how to work with CrateDB Edge. +information for ease of use and to illustrate how to work with CrateDB Cloud on Kubernetes. Sign up @@ -63,7 +63,7 @@ a VM size that is at least 4 CPUs and 8GiB of RAM, for example the "D4s_v3" combination. Additionally, we recommend using at least 3 nodes for a production-grade high-availability setup. Other settings may be left on default or adjusted as desired depending on your production requirements. (The default -settings should be fully functional for CrateDB Edge.) Then proceed with +settings should be fully functional for CrateDB Cloud on Kubernetes.) Then proceed with creating the cluster. This process may take some time. If you have `kubectl`_ installed, you can check on the node status once it is @@ -94,12 +94,12 @@ Sign up with, or log into, the `CrateDB Cloud Console`_. Go to the Regions tab in the Subscription overview and create a custom Edge region by clicking on *Create Edge region*. When the region has appeared in the regions list, it will show a script that you can copy into your CLI. Do so and confirm -installation of CrateDB Edge on the correct cluster. The script will prompt you +installation of CrateDB Cloud on Kubernetes on the correct cluster. The script will prompt you for installation of the prerequisite tools as needed. To configure the necessary storage classes, follow the instructions given in the script and then rerun the script command. -The script, once run, will validate the installation of the CrateDB Edge stack. +The script, once run, will validate the installation of the CrateDB Cloud on Kubernetes stack. You can also check that everything is operational by going to your Kubernetes service in the Azure portal and checking the tab Workloads, under Kubernetes Resources. @@ -111,7 +111,7 @@ Deploy Edge cluster Finally, return to the CrateDB Cloud Console and click on *Deploy cluster* in the custom region you have created. Follow the :ref:`steps described above ` to configure your CrateDB Cloud cluster. At the end of the -process, you should have a working CrateDB Edge install on Azure AKS managed +process, you should have a working CrateDB Cloud on Kubernetes install on Azure AKS managed Kubernetes. @@ -122,9 +122,9 @@ Amazon EKS ---------- Below is a step-by-step guide to using Amazon EKS as a managed Kubernetes -provider in combination with CrateDB Edge. The steps are merely examples of a +provider in combination with CrateDB Cloud on Kubernetes. The steps are merely examples of a process validated by us; other methods may work also. We provide this -information for ease of use and to illustrate how to work with CrateDB Edge. +information for ease of use and to illustrate how to work with CrateDB Cloud on Kubernetes. .. NOTE:: Amazon EKS cluster configuration has some complexity relating to the @@ -203,7 +203,7 @@ Sign up with, or log into, the `CrateDB Cloud Console`_. Go to the Regions tab in the Subscription overview and create a custom Edge region by clicking on *Create Edge region*. When the region has appeared in the regions list, it will show a script that you can copy into your CLI. Do so and confirm -installation of CrateDB Edge on the correct cluster. The script will prompt you +installation of CrateDB Cloud on Kubernetes on the correct cluster. The script will prompt you for installation of the prerequisite tools as needed. To configure the necessary storage classes, follow the instructions given in the script and then rerun the script command. @@ -217,7 +217,7 @@ classes`_. You can find the relevant storage class name with kubectl: kubectl get sc -The script, once run, will validate the installation of the CrateDB Edge stack. +The script, once run, will validate the installation of the CrateDB Cloud on Kubernetes stack. You can check everything is running correctly in the EKS cluster interface. @@ -227,7 +227,7 @@ Deploy Edge cluster Finally, return to the CrateDB Cloud Console and click on *Deploy cluster* in the custom region you have created. Follow the :ref:`steps described above ` to configure your CrateDB Cloud cluster. At the end of the -process, you should have a working CrateDB Edge install on AWS EKS managed +process, you should have a working CrateDB Cloud on Kubernetes install on AWS EKS managed Kubernetes. @@ -237,9 +237,9 @@ Digital Ocean ------------- Below is a step-by-step guide to using Digital Ocean as a managed Kubernetes -provider in combination with CrateDB Edge. The steps are merely examples of a +provider in combination with CrateDB Cloud on Kubernetes. The steps are merely examples of a process validated by us; other methods may work also. We provide this -information for ease of use and to illustrate how to work with CrateDB Edge. +information for ease of use and to illustrate how to work with CrateDB Cloud on Kubernetes. Sign up @@ -283,7 +283,7 @@ running as intended: Set up Edge region '''''''''''''''''' -Now, go to the CrateDB Cloud Console and create a custom CrateDB Edge region. +Now, go to the CrateDB Cloud Console and create a custom CrateDB Cloud on Kubernetes region. Follow the steps outlined :ref:`from the CrateDB sign up onwards ` to proceed. Run the script the CrateDB Cloud Console shows in the panel for the custom region you just created and install prerequisites as necessary. @@ -310,15 +310,15 @@ Deploy Edge cluster Finally, return to the CrateDB Cloud Console and click on *Deploy cluster* in the custom region when it is available. Follow the :ref:`steps described above ` to proceed. At the end of the process, you should have a working -CrateDB Edge install on Digital Ocean managed Kubernetes. +CrateDB Cloud on Kubernetes install on Digital Ocean managed Kubernetes. Google Cloud Platform --------------------- -Below is a full walkthrough of how to get CrateDB Edge up and running on +Below is a full walkthrough of how to get CrateDB Cloud on Kubernetes up and running on Google Cloud. The steps are merely examples of a process validated by us; other methods may work also. We provide this information for ease of use and to -illustrate how to work with CrateDB Edge. In this example, we use Google +illustrate how to work with CrateDB Cloud on Kubernetes. In this example, we use Google Cloud's Kubernetes Engine with a standard setup. Sign up diff --git a/docs/tutorials/edge/monitoring.rst b/docs/tutorials/edge/monitoring.rst index 1e4188a..b9638cb 100644 --- a/docs/tutorials/edge/monitoring.rst +++ b/docs/tutorials/edge/monitoring.rst @@ -1,9 +1,9 @@ .. _edge-monitoring: -Monitor CrateDB Edge -==================== +Monitor CrateDB Cloud on Kubernetes +=================================== -This tutorial introduces a way to set up monitoring of your CrateDB Edge cluster. +This tutorial introduces a way to set up monitoring of your CrateDB Cloud on Kubernetes cluster. The visualization tool `Grafana`_ is used together with `Prometheus`_ and `Loki`_ to monitor the cluster performance and browse logs, respectively. @@ -17,7 +17,7 @@ to monitor the cluster performance and browse logs, respectively. Prerequisites ------------- -- The CrateDB Edge installation script requires Helm 3 to be present in the system. +- The CrateDB Cloud on Kubernetes installation script requires Helm 3 to be present in the system. - For a deployment with Grafana, Loki, and Prometheus, we recommend at least 5 CPUs and 5 GiB of memory per CrateDB node for acceptable performance. @@ -31,7 +31,7 @@ yet. After that, you can deploy your cluster. Deployment steps will depend on your :ref:`cloud provider `, or on your local environment, if you choose the :ref:`self-hosted -` variant of CrateDB Edge. +` variant of CrateDB Cloud on Kubernetes. .. _edge-monitoring-grafana-install: @@ -71,7 +71,7 @@ After successful installation, you will get the following output: .. NOTE:: - If you already have a CrateDB Edge cluster deployed and didn't choose to + If you already have a CrateDB Cloud on Kubernetes cluster deployed and didn't choose to install Grafana and Loki initially, you can rerun the install script to get them when needed. @@ -228,7 +228,7 @@ ability to search for strings in the logs. Conclusion ---------- -This tutorial should serve as an introduction to CrateDB Edge monitoring +This tutorial should serve as an introduction to CrateDB Cloud on Kubernetes monitoring using Loki & Prometheus in Grafana. When you complete it, you should have two handy introductory dashboards to monitor your cluster's performance and operations. diff --git a/docs/tutorials/edge/self-hosted-edge.rst b/docs/tutorials/edge/self-hosted-edge.rst index fecbeb9..449b029 100644 --- a/docs/tutorials/edge/self-hosted-edge.rst +++ b/docs/tutorials/edge/self-hosted-edge.rst @@ -9,7 +9,7 @@ third-party tools and Crate.io is not responsible for those tools. That said, we have tested the instructions provided below for functionality. Users less familiar with customizing their Kubernetes stack on their own may find -any of these approaches a practical solution for easier CrateDB Edge setup. +any of these approaches a practical solution for easier CrateDB Cloud on Kubernetes setup. .. rubric:: Table of contents @@ -21,10 +21,10 @@ any of these approaches a practical solution for easier CrateDB Edge setup. MicroK8s -------- -Below is a full walkthrough of how to get CrateDB Edge up and running on +Below is a full walkthrough of how to get CrateDB Cloud on Kubernetes up and running on MicroK8s. The steps are merely examples of a process validated by us; other methods may work also. We provide this information for ease of use and to -illustrate how to work with CrateDB Edge. +illustrate how to work with CrateDB Cloud on Kubernetes. Set up MicroK8s @@ -129,7 +129,7 @@ Edge 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 `. -With this, you should be ready to use CrateDB Edge via Microk8s. +With this, you should be ready to use CrateDB Cloud on Kubernetes via Microk8s. .. _edge-tools-k3s: @@ -137,10 +137,10 @@ With this, you should be ready to use CrateDB Edge via Microk8s. K3S --- -Below is a full walkthrough of how to get CrateDB Edge up and running on K3S. +Below is a full walkthrough of how to get CrateDB Cloud on Kubernetes up and running on K3S. The steps are merely examples of a process validated by us; other methods may work also. We provide this information for ease of use and to illustrate how to -work with CrateDB Edge. +work with CrateDB Cloud on Kubernetes. Set up K3S @@ -197,7 +197,7 @@ If you need to uninstall, run: Use a storage solution '''''''''''''''''''''' -The K3S setup for CrateDB Edge will require a storage solution. In this case, +The K3S setup for CrateDB Cloud on Kubernetes will require a storage solution. In this case, the tutorial shows how to do so using `Longhorn`_, a distributed storage solution for Kubernetes. You can follow the `Longhorn installation instructions`_ as described below. (Other storage solutions for Kubernetes may @@ -249,21 +249,21 @@ Edge 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 `. -With this, you should be ready to use CrateDB Edge via K3S. +With this, you should be ready to use CrateDB Cloud on Kubernetes via K3S. Custom TLS certificates ----------------------- -By default, CrateDB Edge will issue self-signed certificates for CrateDB +By default, CrateDB Cloud on Kubernetes will issue self-signed certificates for CrateDB instances running in your Edge region. It is also possible to use "proper" TLS certificates if required. In the examples below, we will configure -`letsencrypt`_ to issue certificates and use them with CrateDB Edge clusters. +`letsencrypt`_ to issue certificates and use them with CrateDB Cloud on Kubernetes clusters. Create a ``ClusterIssuer`` '''''''''''''''''''''''''' -CrateDB Edge uses an industry standard app called `cert-manager`_ for managing +CrateDB Cloud on Kubernetes uses an industry standard app called `cert-manager`_ for managing TLS certificates. To issue valid certificates, you would need to follow the cert-manager `tutorial for letsencrypt via the DNS solver`_. CrateDB clusters are provisioned behind a Load Balancer, and as such the only way to solve @@ -337,7 +337,7 @@ create the CrateDB Cloud Project in this region. Replace the existing certificate used by your cluster ''''''''''''''''''''''''''''''''''''''''''''''''''''' -As your CrateDB Edge cluster comes with a self-signed certificate, you will +As your CrateDB Cloud on Kubernetes cluster comes with a self-signed certificate, you will need to replace it. Fortunately, this is fairly straightforward, and only requires a quick edit to the CrateDB Cluster's ``StatefulSet``, i.e.: