Release 10.0 (#997)

* Updated og image from Claire

* Version bump in packages

* Update after testing install

* Standardize single/multi node terminology in urls

* Updated name of docker instance

* Better docker commands

* Reflect latest extensions on Cloud

admin_guide/upgrading_citus.rst

@@ -15,21 +15,21 @@ Upgrading the Citus version requires first obtaining the new Citus extension and
 Patch Version Upgrade
 ---------------------
 
-To upgrade a Citus version to its latest patch, issue a standard upgrade command for your package manager. Assuming version 9.5 is currently installed on Postgres 13:
+To upgrade a Citus version to its latest patch, issue a standard upgrade command for your package manager. Assuming version 10.0 is currently installed on Postgres 13:
 
 **Ubuntu or Debian**
 
 .. code-block:: bash
 
   sudo apt-get update
-  sudo apt-get install --only-upgrade postgresql-13-citus-9.5
+  sudo apt-get install --only-upgrade postgresql-13-citus-10.0
   sudo service postgresql restart
 
 **Fedora, CentOS, or Red Hat**
 
 .. code-block:: bash
 
-  sudo yum update citus95_13
+  sudo yum update citus100_13
   sudo service postgresql-13 restart
 
 .. _major_minor_upgrade:
@@ -48,23 +48,23 @@ Each major and minor version of Citus is published as a package with a separate
 Step 1. Update Citus Package
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-If upgrading both Citus and Postgres, always be sure to upgrade the Citus extension first, and the PostgreSQL version second (see :ref:`upgrading_postgres`). Here is how to do a Citus upgrade from 8.3 to 9.5
+If upgrading both Citus and Postgres, always be sure to upgrade the Citus extension first, and the PostgreSQL version second (see :ref:`upgrading_postgres`). Here is how to do a Citus upgrade from 9.5 to 10.0
 
 **Ubuntu or Debian**
 
 .. code-block:: bash
 
   sudo apt-get update
-  sudo apt-get install postgresql-11-citus-9.5
+  sudo apt-get install postgresql-12-citus-10.0
   sudo service postgresql restart
 
 **Fedora, CentOS, or Red Hat**
 
 .. code-block:: bash
 
   # Fedora, CentOS, or Red Hat
-  sudo yum swap citus83_11 citus95_11
-  sudo service postgresql-11 restart
+  sudo yum swap citus95_12 citus100_12
+  sudo service postgresql-12 restart
 
 Step 2. Apply Update in DB
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -94,7 +94,7 @@ After installing the new package and restarting the database, run the extension
 
 .. _upgrading_postgres:
 
-Upgrading PostgreSQL version from 11 to 12
+Upgrading PostgreSQL version from 12 to 13
 ##########################################
 
 .. note::
@@ -104,16 +104,16 @@ Upgrading PostgreSQL version from 11 to 12
 Record the following paths before you start (your actual paths may be different than those below):
 
 Existing data directory (e.g. /opt/pgsql/10/data)
-  :code:`export OLD_PG_DATA=/opt/pgsql/11/data`
+  :code:`export OLD_PG_DATA=/opt/pgsql/12/data`
 
 Existing PostgreSQL installation path (e.g. /usr/pgsql-10)
-  :code:`export OLD_PG_PATH=/usr/pgsql-11`
+  :code:`export OLD_PG_PATH=/usr/pgsql-12`
 
 New data directory after upgrade
-  :code:`export NEW_PG_DATA=/opt/pgsql/12/data`
+  :code:`export NEW_PG_DATA=/opt/pgsql/13/data`
 
 New PostgreSQL installation path
-  :code:`export NEW_PG_PATH=/usr/pgsql-12`
+  :code:`export NEW_PG_PATH=/usr/pgsql-13`
 
 For Every Node
 --------------

cloud/additional_extensions.rst

@@ -18,7 +18,7 @@ Generally there is no need to install extensions, however, because every Cloud c
 +--------------------+---------+------------+--------------------------------------------------------------------+
 | citext             | 1.6     | public     | data type for case-insensitive character strings                   |
 +--------------------+---------+------------+--------------------------------------------------------------------+
-| citus              | 9.4-1   | pg_catalog | Citus distributed database                                         |
+| citus              | 9.5-1   | pg_catalog | Citus distributed database                                         |
 +--------------------+---------+------------+--------------------------------------------------------------------+
 | cube               | 1.4     | public     | data type for multidimensional cubes                               |
 +--------------------+---------+------------+--------------------------------------------------------------------+
@@ -28,27 +28,27 @@ Generally there is no need to install extensions, however, because every Cloud c
 +--------------------+---------+------------+--------------------------------------------------------------------+
 | fuzzystrmatch      | 1.1     | public     | determine similarities and distance between strings                |
 +--------------------+---------+------------+--------------------------------------------------------------------+
-| hll                | 2.14    | public     | type for storing hyperloglog data                                  |
+| hll                | 2.15    | public     | type for storing hyperloglog data                                  |
 +--------------------+---------+------------+--------------------------------------------------------------------+
-| hstore             | 1.6     | public     | data type for storing sets of (key, value) pairs                   |
+| hstore             | 1.7     | public     | data type for storing sets of (key, value) pairs                   |
 +--------------------+---------+------------+--------------------------------------------------------------------+
-| intarray           | 1.2     | public     | functions, operators, and index support for 1-D arrays of integers |
+| intarray           | 1.3     | public     | functions, operators, and index support for 1-D arrays of integers |
 +--------------------+---------+------------+--------------------------------------------------------------------+
-| ltree              | 1.1     | public     | data type for hierarchical tree-like structures                    |
+| ltree              | 1.2     | public     | data type for hierarchical tree-like structures                    |
 +--------------------+---------+------------+--------------------------------------------------------------------+
 | pg_buffercache     | 1.3     | public     | examine the shared buffer cache                                    |
 +--------------------+---------+------------+--------------------------------------------------------------------+
-| pg_cron            | 1.2     | public     | Job scheduler for PostgreSQL                                       |
+| pg_cron            | 1.3     | public     | Job scheduler for PostgreSQL                                       |
 +--------------------+---------+------------+--------------------------------------------------------------------+
 | pg_freespacemap    | 1.2     | public     | examine the free space map (FSM)                                   |
 +--------------------+---------+------------+--------------------------------------------------------------------+
-| pg_partman         | 4.4.0   | partman    | Extension to manage partitioned tables by time or ID               |
+| pg_partman         | 4.4.1   | partman    | Extension to manage partitioned tables by time or ID               |
 +--------------------+---------+------------+--------------------------------------------------------------------+
 | pg_prewarm         | 1.2     | public     | prewarm relation data                                              |
 +--------------------+---------+------------+--------------------------------------------------------------------+
-| pg_stat_statements | 1.7     | public     | track execution statistics of all SQL statements executed          |
+| pg_stat_statements | 1.8     | public     | track execution statistics of all SQL statements executed          |
 +--------------------+---------+------------+--------------------------------------------------------------------+
-| pg_trgm            | 1.4     | public     | text similarity measurement and index searching based on trigrams  |
+| pg_trgm            | 1.5     | public     | text similarity measurement and index searching based on trigrams  |
 +--------------------+---------+------------+--------------------------------------------------------------------+
 | pgcrypto           | 1.3     | public     | cryptographic functions                                            |
 +--------------------+---------+------------+--------------------------------------------------------------------+
@@ -64,7 +64,7 @@ Generally there is no need to install extensions, however, because every Cloud c
 +--------------------+---------+------------+--------------------------------------------------------------------+
 | tablefunc          | 1.0     | public     | functions that manipulate whole tables, including crosstab         |
 +--------------------+---------+------------+--------------------------------------------------------------------+
-| topn               | 2.3.0   | public     | type for top-n JSONB                                               |
+| topn               | 2.3.1   | public     | type for top-n JSONB                                               |
 +--------------------+---------+------------+--------------------------------------------------------------------+
 | unaccent           | 1.1     | public     | text search dictionary that removes accents                        |
 +--------------------+---------+------------+--------------------------------------------------------------------+

conf.py

@@ -58,9 +58,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '9.5'
+version = '10.0'
 # The full version, including alpha/beta/rc tags.
-release = '9.5'
+release = '10.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

extra/enterprise-ms-sku.rst

@@ -141,9 +141,9 @@ Debian/Ubuntu
 .. code:: bash
 
     sudo apt-get update
-    # Change to postgresql-11-citus-enterprise-9.5 if you want to install Citus for
+    # Change to postgresql-11-citus-enterprise-10.0 if you want to install Citus for
     # PostgreSQL 11
-    sudo apt-get install -y postgresql-12-citus-enterprise-9.5
+    sudo apt-get install -y postgresql-12-citus-enterprise-10.0
 
 Redhat/CentOS
 ~~~~~~~~~~~~~
@@ -153,8 +153,8 @@ remove the old package
 
 .. code:: bash
 
-    # Change to citus-enterprise95_11 for PostgreSQL 11)
-    sudo yum install -y citus-enterprise95_12
+    # Change to citus-enterprise10_11 for PostgreSQL 11)
+    sudo yum install -y citus-enterprise10_12
 
 .. _sku_setup:
 

extra/enterprise.rst

@@ -25,7 +25,7 @@ Ubuntu or Debian with Internet Access
       sudo CITUS_REPO_TOKEN=XYZ bash
 
     # install the server and initialize db
-    sudo apt-get install -y postgresql-12-citus-enterprise-9.5
+    sudo apt-get install -y postgresql-12-citus-enterprise-10.0
 
     # preload citus extension
     sudo pg_conftool 12 main set shared_preload_libraries citus
@@ -46,7 +46,7 @@ Ubuntu or Debian without Internet Access
       sudo CITUS_REPO_TOKEN=XYZ bash
 
     sudo apt-get clean
-    sudo apt-get install -y --download-only postgresql-12-citus-enterprise-9.5
+    sudo apt-get install -y --download-only postgresql-12-citus-enterprise-10.0
 
     # go to package downloads
     cd /var/cache/apt
@@ -88,7 +88,7 @@ Fedora, CentOS, or Red Hat with Internet Access
       sudo CITUS_REPO_TOKEN=XYZ bash
 
     # install PostgreSQL with Citus extension
-    sudo yum install -y citus-enterprise95_12
+    sudo yum install -y citus-enterprise10_12
 
     # initialize system database (using RHEL 6 vs 7 method as necessary)
     sudo service postgresql-12 initdb || \
@@ -113,7 +113,7 @@ Fedora, CentOS, or Red Hat without Internet Access
       sudo CITUS_REPO_TOKEN=XYZ bash
 
     # get package
-    sudo yum install --downloadonly --downloaddir=. citus-enterprise95_12
+    sudo yum install --downloadonly --downloaddir=. citus-enterprise10_12
 
     # put them into a tarball
     tar czf ~/citus-enterprise.tar.gz *.rpm

get_started/tutorial_multi_tenant.rst

@@ -31,9 +31,9 @@ We will use three Postgres tables to represent this data. To get started, you wi
 
 .. code-block:: bash
 
-    docker cp companies.csv citus_master:.
-    docker cp campaigns.csv citus_master:.
-    docker cp ads.csv citus_master:.
+    docker cp companies.csv citus:.
+    docker cp campaigns.csv citus:.
+    docker cp ads.csv citus:.
 
 Creating tables
 ---------------

get_started/tutorial_realtime_analytics.rst

@@ -27,8 +27,8 @@ We will use two Postgres tables to represent this data. To get started, you will
 
 .. code-block:: bash
 
-    docker cp users.csv citus_master:.
-    docker cp events.csv citus_master:.
+    docker cp users.csv citus:.
+    docker cp events.csv citus:.
 
 Creating tables
 ---------------

index.rst

@@ -78,8 +78,8 @@ single-node.
    :caption: Install
    :hidden:
 
-   installation/single_machine.rst
-   installation/multi_machine.rst
+   installation/single_node.rst
+   installation/multi_node.rst
    installation/citus_cloud.rst
 
 .. toctree::

installation/citus_cloud.rst

@@ -1,4 +1,4 @@
-.. _multi_machine_cloud:
+.. _multi_node_cloud:
 
 Managed Deployment
 ==================

installation/multi_machine.rst → installation/multi_node.rst

@@ -9,5 +9,5 @@ use the guide below.
 
 .. toctree::
 
-   multi_machine_debian.rst
-   multi_machine_rhel.rst
+   multi_node_debian.rst
+   multi_node_rhel.rst

installation/multi_machine_aws.rst → installation/multi_node_aws.rst

@@ -1,6 +1,6 @@
 :orphan:
 
-.. _multi_machine_aws:
+.. _multi_node_aws:
 
 AWS CloudFormation
 ##################
@@ -9,4 +9,4 @@ AWS CloudFormation
 
    CloudFormation is deprecated, and can deploy only Citus versions 8.0 and
    below.  See the `Citus 8.0 documentation
-   </en/v8.0/installation/multi_machine_aws.html>`_ for more information.
+   </en/v8.0/installation/multi_node_aws.html>`_ for more information.

installation/multi_machine_debian.rst → installation/multi_node_debian.rst

@@ -26,7 +26,7 @@ Steps to be executed on all nodes
 ::
 
   # install the server and initialize db
-  sudo apt-get -y install postgresql-13-citus-9.5
+  sudo apt-get -y install postgresql-13-citus-10.0
 
   # preload citus extension
   sudo pg_conftool 13 main set shared_preload_libraries citus

installation/multi_machine_rhel.rst → installation/multi_node_rhel.rst

@@ -26,7 +26,7 @@ Steps to be executed on all nodes
 ::
 
   # install PostgreSQL with Citus extension
-  sudo yum install -y citus95_13
+  sudo yum install -y citus100_13
   # initialize system database (using RHEL 6 vs 7 method as necessary)
   sudo service postgresql-13 initdb || sudo /usr/pgsql-13/bin/postgresql-13-setup initdb
   # preload citus extension

installation/single_machine.rst → installation/single_node.rst

@@ -10,6 +10,6 @@ production and get ready for future scale and growth.
 
 .. toctree::
 
-   single_machine_docker.rst
-   single_machine_debian.rst
-   single_machine_rhel.rst
+   single_node_docker.rst
+   single_node_debian.rst
+   single_node_rhel.rst

installation/single_machine_debian.rst → installation/single_node_debian.rst

@@ -1,6 +1,6 @@
 .. highlight:: bash
 
-.. _single_machine_deb:
+.. _single_node_deb:
 
 Ubuntu or Debian
 ================
@@ -15,7 +15,7 @@ This section describes the steps needed to set up a single-node Citus cluster on
   curl https://install.citusdata.com/community/deb.sh | sudo bash
 
   # install the server and initialize db
-  sudo apt-get -y install postgresql-13-citus-9.5
+  sudo apt-get -y install postgresql-13-citus-10.0
 
 
 .. _post_install:
@@ -48,21 +48,21 @@ Finally, we'll start an instance of PostgreSQL for the new directory:
 
 .. code-block:: sh
 
-  pg_ctl -D citus -l citus_logfile start
+  pg_ctl -D citus -o "-p 9700" -l citus_logfile start
 
 Above you added Citus to ``shared_preload_libraries``. That lets it hook into some deep parts of Postgres, swapping out the query planner and executor.  Here, we load the user-facing side of Citus (such as the functions you'll soon call):
 
 .. code-block:: sh
 
-  psql -c "CREATE EXTENSION citus;"
+  psql -p 9700 -c "CREATE EXTENSION citus;"
 
 **4. Verify that installation has succeeded**
 
 To verify that the installation has succeeded, and Citus is installed:
 
 .. code-block:: sh
 
-  psql -c "select citus_version();"
+  psql -p 9700 -c "select citus_version();"
 
 You should see details of the Citus extension.
 

installation/single_machine_docker.rst → installation/single_node_docker.rst

@@ -1,4 +1,4 @@
-.. _single_machine_docker:
+.. _single_node_docker:
 
 Docker (Mac or Linux)
 =====================
@@ -13,10 +13,10 @@ You can start Citus in Docker with one command:
 .. code-block:: bash
 
   # start the image
-  docker run -d --name citus -p 5432:5432 -e POSTGRES_PASSWORD=foo citusdata/citus
+  docker run -d --name citus -p 5432:5432 -e POSTGRES_PASSWORD=mypass citusdata/citus
 
   # verify it's running, and that Citus is installed:
-  psql -U postgres -d postgres -c "SELECT * FROM citus_version();"
+  psql -U postgres -h localhost -d postgres -c "SELECT * FROM citus_version();"
 
 You should see the latest version of Citus.