Skip to content

Commit

Permalink
Rename CrateDB Edge to CrateDB Cloud on Kubernetes
Browse files Browse the repository at this point in the history
  • Loading branch information
proddata committed Feb 22, 2024
1 parent 126bbad commit 6d8469d
Show file tree
Hide file tree
Showing 14 changed files with 80 additions and 80 deletions.
2 changes: 1 addition & 1 deletion docs/_extra/cratedb-edge-cluster-dashboard.json
Original file line number Diff line number Diff line change
Expand Up @@ -859,7 +859,7 @@
},
"timepicker": {},
"timezone": "",
"title": "CrateDB Edge Cluster Monitoring",
"title": "CrateDB Cloud on Kubernetes Cluster Monitoring",
"uid": "UYJt9qn4k",
"version": 5
}
2 changes: 1 addition & 1 deletion docs/_extra/cratedb-edge-logs-dashboard.json
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@
},
"timepicker": {},
"timezone": "",
"title": "CrateDB Edge Logs Monitoring",
"title": "CrateDB Cloud on Kubernetes Logs Monitoring",
"uid": "wvqz_CnVz",
"version": 3
}
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/reference/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ clusters can only be deployed within the Console.
Edge
----

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
Expand Down Expand Up @@ -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.

Expand Down
8 changes: 4 additions & 4 deletions docs/reference/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -168,8 +168,8 @@ In this tab, you will see the available :ref:`regions <gloss-region>` 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 <gloss-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 <gloss-edge>` clusters in a :ref:`custom region
<gloss-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:

Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/subscription-plans.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/deploy/marketplace/subscribe-aws.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <edge>`. To pay directly for a hosted cluster
the :ref:`CrateDB Cloud on Kubernetes tutorial <edge>`. To pay directly for a hosted cluster
by credit card, see the tutorial for :ref:`direct cluster deployment
<cluster-deployment-stripe>`.

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/deploy/marketplace/subscribe-azure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <edge>`. To pay directly for a hosted cluster
the :ref:`CrateDB Cloud on Kubernetes tutorial <edge>`. To pay directly for a hosted cluster
by credit card, see the tutorial for :ref:`direct cluster deployment
<cluster-deployment-stripe>`.

Expand Down
6 changes: 3 additions & 3 deletions docs/tutorials/edge/custom-backup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
<edge-self-hosted>`, or the :ref:`Managed Edge <edge-providers>` tutorials.

Expand Down
10 changes: 5 additions & 5 deletions docs/tutorials/edge/index.rst
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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
Expand All @@ -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
Expand Down
38 changes: 19 additions & 19 deletions docs/tutorials/edge/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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)
Expand All @@ -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 <edge-providers>` 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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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/
Expand Down
Loading

0 comments on commit 6d8469d

Please sign in to comment.