Skip to content

Commit

Permalink
Update to Citus description, and link to managed service
Browse files Browse the repository at this point in the history
  • Loading branch information
clairegiordano authored and jonels-msft committed Oct 19, 2022
1 parent f555162 commit d0f5944
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 29 deletions.
2 changes: 1 addition & 1 deletion _templates/page.html
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
{# Open Graph metadata #}
<meta property="og:image" content="https://docs.citusdata.com/en/stable/_images/citus-docs-og-logo.png" />
<meta property="og:title" content="{{ title }} - {{ docstitle }}" />
<meta property="og:description" content="Docs for the Citus extension to Postgres. Citus distributes your data &amp; queries across multiple nodes in a cluster, so your database can scale and your queries are fast." />
<meta property="og:description" content="Docs for the Citus open source extension to Postgres. Citus gives you Postgres at any scale—from a single node to a large distributed database cluster. Available as 100% open source &amp; as a managed service with Azure Cosmos DB for PostgreSQL." />
{% endblock %}

{% block header %}
Expand Down
6 changes: 3 additions & 3 deletions faq/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ Currently Citus imposes primary key constraint only if the distribution column i
How do I add nodes to an existing Citus cluster?
------------------------------------------------

On Azure Database for PostgreSQL - Hyperscale (Citus) it's as easy as dragging a slider in the user interface. In Citus Community edition you can add nodes manually by calling the :ref:`citus_add_node` UDF with the hostname (or IP address) and port number of the new node.
On the Citus managed service with Azure Cosmos DB for PostgreSQL (formerly known as Hyperscale (Citus)), adding nodes is quite easy: all it takes is a few clicks in the Azure portal. With Citus open source, you can add nodes manually by calling the :ref:`citus_add_node` UDF with the hostname (or IP address) and port number of the new node.

Either way, after adding a node to an existing cluster it will not contain any data (shards). Citus will start assigning any newly created shards to this node. To rebalance existing shards from the older nodes to the new node, Citus provides a shard rebalancer utility. You can find more information in the :ref:`shard_rebalancing` section.
Either way, after adding a node to an existing cluster, the new node will not contain any data (shards). Citus will start assigning any newly created shards to this node. To rebalance existing shards from the older nodes to the new node, Citus provides an open source shard rebalancer utility. You can find more information in the :ref:`shard_rebalancing` section.

How does Citus handle failure of a worker node?
-----------------------------------------------
Expand Down Expand Up @@ -166,7 +166,7 @@ As the error message suggests, you can (cautiously) increase this limit by alter
Can I run Citus on Microsoft Azure?
-----------------------------------

Yes, Citus is a deployment option of `Azure Database for PostgreSQL <https://docs.microsoft.com/azure/postgresql/hyperscale/>`_ called **Hyperscale**. It is a fully managed database-as-a-service.
Yes, Citus is available as a managed service with `Azure Cosmos DB for PostgreSQL <https://learn.microsoft.com/azure/cosmos-db/postgresql/introduction/>`_, formerly known as Hyperscale (Citus) in Azure Database for PostgreSQL.

Can I shard by schema on Citus for multi-tenant applications?
-------------------------------------------------------------
Expand Down
23 changes: 7 additions & 16 deletions installation/citus_cloud.rst
Original file line number Diff line number Diff line change
@@ -1,23 +1,14 @@
.. _multi_node_cloud:

Managed Deployment
Managed Service
==================

One of the easiest ways to get started with Citus is to spin up a cluster in
the cloud on Azure. Citus is available as a built-in deployment option in the
`Azure Database for PostgreSQL - Hyperscale (Citus)
<https://docs.microsoft.com/azure/postgresql/hyperscale/>`_ managed
service.
the cloud on Azure. The Citus managed service is available as
`Azure Cosmos DB for PostgreSQL
<https://learn.microsoft.com/azure/cosmos-db/postgresql/introduction/>`_, formerly known as Hyperscale (Citus) in Azure Database for PostgreSQL.

To get started, you can take advantage of our Hyperscale (Citus) `quickstart
documentation
<https://docs.microsoft.com/azure/postgresql/quickstart-create-hyperscale-portal>`_,
or go straight to the `Azure Portal
<https://portal.azure.com/#create/Microsoft.PostgreSQLServer>`_ to provision a
Postgres server. (And if you don’t yet have an Azure subscription, just `create
a free Azure account <https://azure.microsoft.com/free/>`_ first.)
To get started with Citus on Azure, you can take advantage of our `quickstart for Azure Cosmos DB for PostgreSQL
<https://learn.microsoft.com/azure/cosmos-db/postgresql/quickstart-create-portal>`_ in the Azure docs,
or go straight to the `free trial <https://cosmos.azure.com/try/>`_ on Azure.)

.. NOTE::

We are no longer onboarding new users to our previous managed service, Citus
Cloud on AWS.
6 changes: 3 additions & 3 deletions installation/multi_node.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
Multi-Node Citus
----------------

The :ref:`development` section has instructions on installing a Citus cluster on
one machine. If you are looking to deploy Citus across multiple nodes, you can
use the guide below.
The :ref:`development` section has instructions for installing Citus open source packages on
a single node. If you are looking to deploy the Citus database across multiple
nodes (along with Postgres packages, too) you can use the guide below.

.. toctree::

Expand Down
9 changes: 5 additions & 4 deletions installation/single_node.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@
Single-Node Citus
-----------------

To install Citus open source packages on a single node, the installation
instructions below will help you get started quickly. Single-node Citus is
useful for initial development and testing, as well as a way to start small in
production and get ready for future scale and growth.
The installation instructions below will guide you to install Citus open
source packages (along with Postgres packages) on a single node.
Single-node Citus gives you an easy way to start small in production, while
being ready for future scale and growth. Single-node Citus is also useful
for early development and testing.

.. toctree::

Expand Down
4 changes: 2 additions & 2 deletions use_cases/multi_tenant.rst
Original file line number Diff line number Diff line change
Expand Up @@ -429,7 +429,7 @@ Being able to rebalance data in the Citus cluster allows you to grow your data s

Also, if data increases for only a few large tenants, then you can isolate those particular tenants to separate nodes for better performance.

To scale out your Citus cluster, first add a new worker node to it. On Azure Database for PostgreSQL - Hyperscale (Citus), you can use the Azure Portal to add the required number of nodes. Alternatively, if you run your own Citus installation, you can add nodes manually with the :ref:`citus_add_node` UDF.
To scale out your Citus cluster, first add a new worker node to it. On Azure Cosmos DB for PostgreSQL (formerly known as Hyperscale (Citus) in Azure Database for PostgreSQL), you can use the Azure Portal to add the required number of nodes. Alternatively, if you run your own Citus installation, you can add nodes manually with the :ref:`citus_add_node` UDF.

Once you add the node it will be available in the system. However, at this point no tenants are stored on it and Citus will not yet run any queries there. To move your existing data, you can ask Citus to rebalance the data. This operation moves bundles of rows called shards between the currently active nodes to attempt to equalize the amount of data on each node.

Expand Down Expand Up @@ -508,4 +508,4 @@ Where to Go From Here

With this, you now know how to use Citus to power your multi-tenant application for scalability. If you have an existing schema and want to migrate it for Citus, see :ref:`Multi-Tenant Transitioning <transitioning_mt>`.

To adjust a front-end application, specifically Ruby on Rails or Django, read :ref:`rails_migration` or :ref:`django_migration`. Finally, try `Azure Database for PostgreSQL - Hyperscale (Citus) <https://docs.microsoft.com/azure/postgresql/quickstart-create-hyperscale-portal>`_, the easiest way to manage a Citus cluster.
To adjust a front-end application, specifically Ruby on Rails or Django, read :ref:`rails_migration` or :ref:`django_migration`. Finally, try `Azure Cosmos DB for PostgreSQL <https://learn.microsoft.com/azure/cosmos-db/postgresql/introduction>`_, the easiest way to manage a Citus cluster.

0 comments on commit d0f5944

Please sign in to comment.