Skip to content

Commit 9155f3f

Browse files
craigkerstiensbegriffs
authored andcommitted
updating cloud docs for more detailed info (citusdata#158)
* updating cloud docs for more detailed info * Light edits
1 parent 98075a9 commit 9155f3f

File tree

3 files changed

+34
-23
lines changed

3 files changed

+34
-23
lines changed

cloud/features.rst

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,29 @@ Citus Cloud runs with a different replication from that outlined in the Citus do
99
Continuous protection
1010
---------------------
1111

12-
Citus Cloud continuously protects cluster data against hardware failure. To do this we perform backups of your data every 24 hours, then stream the write-ahead log (WAL) from Postgres to S3 every 16 MB or 60 seconds, whichever is less. Even without high availability enabled you won't lose any data. In the event of a complete infrastructure failure we'll restore your back-up and replace the WAL to the exact moment before your system crashed.
12+
Citus Cloud continuously protects the cluster data against hardware failure. To do this we perform backups every twenty-four hours, then stream the write-ahead log (WAL) from PostgreSQL to S3 every 16 MB or 60 seconds, whichever is less. Even without high availability enabled you won't lose any data. In the event of a complete infrastructure failure we'll restore your back-up and replay the WAL to the exact moment before your system crashed.
1313

1414
High Availability
1515
-----------------
1616

17-
In addition to continuous protection which is explained above, high availability is available if your application requires less exposure to downtime. If at provisioning you select high availability we provision stand-bys. This can be for your primary node, or for your distributed nodes.
17+
In addition to continuous protection which is explained above, high availability is available if your application requires less exposure to downtime. We provision stand-bys if you select high availability at provisioning time. This can be for your primary node, or for your distributed nodes.
18+
19+
Security
20+
--------
21+
22+
Encryption
23+
~~~~~~~~~~
24+
25+
All data within Citus Cloud is encrypted at rest, including data on the instance as well as all backups for disaster recovery. We also require that you connect to your database with TLS.
26+
27+
Two-Factor Authentication
28+
~~~~~~~~~~~~~~~~~~~~~~~~~
29+
30+
We support two factor authentication for all Citus accounts. You can enable it from within your Citus Cloud account. We support Google Authenticator and Authy as two primary apps for setting up your two factor authentication.
31+
1832

1933
.. raw:: html
2034

2135
<script type="text/javascript">
2236
Intercom('trackEvent', 'docs-cloud-pageview');
23-
</script>
37+
</script>

cloud/index.rst

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,33 +6,27 @@ Citus Cloud is a fully managed hosted version of Citus Enterprise edition on top
66
Provisioning
77
############
88

9-
Once you've created your account at https://console.citusdata.com you can provision your Citus cluster. When you login you'll be at the home of the dashboard, and from here you can click New Formation to begin your formation creation.
9+
Once you've created your account at `https://console.citusdata.com <https://console.citusdata.com>`_ you can provision your Citus cluster. When you login you'll be at the home of the dashboard, and from here you can click New Formation to begin your formation creation.
1010

1111
.. image:: ../images/cloud_provisioning.png
1212

13-
Pre-configured plans
14-
--------------------
13+
Configuring Your Plan
14+
---------------------
1515

16-
To make it simpler for you to get up and running we've preconfigured a number of Citus Cloud plans. All Citus plans come with:
16+
Citus Cloud plans vary based on the size of your primary node, size of your distributed nodes, number of distributed nodes and whether you have high availability or not. From within the Citus console you can configure your plan or you can preview what it might look like within the `pricing calculator <https://console.citusdata.com/pricing>`_.
1717

18-
1. A primary instance which you will connect to and is suitable for storing your smaller tables (under 1 million rows) on.
19-
2. A set of distributed nodes which your distributed tables will be sharded across
20-
3. High availability, meaning we will be running standbys should you need to fail over.
18+
The key items you'll care about for each node:
2119

22-
If you do not need high availability or want a different number or size of nodes than you see available you can create your own custom plan.
20+
- Storage - All nodes come with 512 GB of storage
21+
- Memory - The memory on each node varies based on the size of node you select
22+
- Cores - The cores on each node varies based on the size of node you select
2323

24-
Custom plans
25-
------------
24+
High Availability
25+
~~~~~~~~~~~~~~~~~
2626

27-
Each custom plan allows you to configure the size of your primary instance, the number and size of distributed nodes, and whether the primary instance and nodes have HA enabled. Discounts are available for longer-term commitments on custom plans which make them comparable in price to the preconfigured plans.
27+
The high availability option on a cluster automatically provisions instance stand-bys. These stand-bys receive streaming updates directly from each of the leader nodes. We continuously monitor the leader nodes to ensure they're available and healthy. In the event of a failure we automatically switch to the stand-bys.
2828

29-
30-
Sizing your Citus Cluster
31-
-------------------------
32-
33-
All nodes within a Citus cluster come with 512 GB of storage. The number of nodes and size of the nodes you need will vary based on your data volume and performance requirements. We encourage you to focus on the number of logical shards and right distribution key first before focusing on overall size of your cluster.
34-
35-
Citus will use only as many physical cores to process a query as there are logical shards in your cluster. Thus we recommend creating sufficient shards to give your cluster room to grow. A good estimate is 4-8x the number of cores you currently use in your cluster. For instance choosing 128 logical shards is quite reasonable when you create your distributed tables.
29+
Note that your data is replicated to S3 with and without enabling high availability. This allows disaster recovery and reduces the risk of data loss. Although the data is safe either way, we suggest enabling high availability if you cannot tolerate up to one hour of downtime in the rare occurrence of an instance failure. We do not offer a SLA on uptime.
3630

3731
.. raw:: html
3832

cloud/support.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,14 @@ Email and web based support is available on all Citus Cloud plans. You can open
1111
Billing and pricing
1212
-------------------
1313

14-
Citus Cloud bills on a per minute basis. We bill for a minimum of 1 hour of usage across all plans. Pricing varies based on the size and configuration of the cluster. The a few factors that determine your price are:
14+
Citus Cloud bills on a per minute basis. We bill for a minimum of one hour of usage across all plans. Pricing varies based on the size and configuration of the cluster. A few factors that determine your price are:
1515

16-
- Size of your primary node
1716
- Size of your distributed nodes
17+
- Number of distributed nodes
1818
- Whether you have high availability enabled, both on the primary node and on distributed nodes
19+
- Size of your primary node
20+
21+
You can see pricing of various configurations directly within our `pricing calculator <https://console.citusdata.com/pricing>`_.
1922

2023
.. raw:: html
2124

0 commit comments

Comments
 (0)