From 8e876bd9c6b9a2759ddfbd3c01d373aa21669db5 Mon Sep 17 00:00:00 2001 From: Joe Nelson Date: Tue, 28 Feb 2017 17:14:59 -0800 Subject: [PATCH 1/7] Native docker on mac, plus smoother instructions --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d12f9875f..b295d510f 100644 --- a/README.md +++ b/README.md @@ -46,12 +46,20 @@ Citus Cloud runs on top of AWS as a fully managed database as a service and has If you're looking to get started locally, you can follow the following steps to get up and running. -* Install docker-compose: [Mac][mac_install] | [Linux][linux_install] -* (Mac only) connect to Docker VM - ```bash - eval $(docker-machine env default) - ``` +* Install Docker Engine and docker-compose + * Mac: + 1. Install the [Docker Platform](https://www.docker.com/products/overview#/install_the_platform). + 2. Start Docker by clicking on the application’s icon. + * Linux: + ```bash + curl -sSL https://get.docker.com/ | sudo bash + sudo usermod -aG docker $USER && newgrp docker + sudo systemctl start docker + sudo curl -L https://github.com/docker/compose/releases/download/1.11.1/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose + sudo chmod +x /usr/local/bin/docker-compose + ``` + (This docker-compose version is fine for running Citus, or you can install the [latest version](https://github.com/docker/compose/releases/latest).) * Pull and start the docker images ```bash wget https://raw.githubusercontent.com/citusdata/docker/master/docker-compose.yml @@ -60,7 +68,7 @@ If you're looking to get started locally, you can follow the following steps to * Connect to the master database ```bash - docker exec -it citus_master psql -U postgres -d postgres + docker exec -it citus_master psql -U postgres ``` * Follow the [first tutorial][tutorial] instructions @@ -142,6 +150,4 @@ ___ Copyright © 2012–2017 Citus Data, Inc. [faq]: https://www.citusdata.com/frequently-asked-questions -[linux_install]: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-compose-on-ubuntu-14-04 -[mac_install]: https://www.docker.com/products/docker-toolbox [tutorial]: https://docs.citusdata.com/en/v6.1/tutorials/tut-hash-distribution.html From 02129b186048fa83fe54b8f7e038a8b9fa2fcccd Mon Sep 17 00:00:00 2001 From: Joe Nelson Date: Tue, 28 Feb 2017 17:21:31 -0800 Subject: [PATCH 2/7] Link to the new tutorial as well --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b295d510f..0cb7b8f05 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,7 @@ If you're looking to get started locally, you can follow the following steps to Documentation Try the Citus + href="https://docs.citusdata.com/en/stable/tutorials/multi-tenant-tutorial.html">Citus tutorial for a hands-on introduction or
the documentation for a more comprehensive reference. @@ -150,4 +150,4 @@ ___ Copyright © 2012–2017 Citus Data, Inc. [faq]: https://www.citusdata.com/frequently-asked-questions -[tutorial]: https://docs.citusdata.com/en/v6.1/tutorials/tut-hash-distribution.html +[tutorial]: https://docs.citusdata.com/en/stable/tutorials/multi-tenant-tutorial.html From e8ef19ed30ea5ea674457d129adc739f72630d01 Mon Sep 17 00:00:00 2001 From: Joe Nelson Date: Thu, 2 Mar 2017 13:37:09 -0800 Subject: [PATCH 3/7] Docker download url has changed --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0cb7b8f05..4d2ca5cb1 100644 --- a/README.md +++ b/README.md @@ -46,9 +46,9 @@ Citus Cloud runs on top of AWS as a fully managed database as a service and has If you're looking to get started locally, you can follow the following steps to get up and running. -* Install Docker Engine and docker-compose +* Install Docker Community Edition and docker-compose * Mac: - 1. Install the [Docker Platform](https://www.docker.com/products/overview#/install_the_platform). + 1. [Download](https://www.docker.com/community-edition#/download) and install Docker. 2. Start Docker by clicking on the application’s icon. * Linux: ```bash From a86398fbe3a6d708285626e25b7057bbeec0f421 Mon Sep 17 00:00:00 2001 From: Joe Nelson Date: Tue, 7 Mar 2017 11:57:04 -0800 Subject: [PATCH 4/7] Make outermost list ordered to emphasize the sequence --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4d2ca5cb1..c9efce344 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ Citus Cloud runs on top of AWS as a fully managed database as a service and has If you're looking to get started locally, you can follow the following steps to get up and running. -* Install Docker Community Edition and docker-compose +1. Install Docker Community Edition and docker-compose * Mac: 1. [Download](https://www.docker.com/community-edition#/download) and install Docker. 2. Start Docker by clicking on the application’s icon. @@ -60,19 +60,19 @@ If you're looking to get started locally, you can follow the following steps to sudo chmod +x /usr/local/bin/docker-compose ``` (This docker-compose version is fine for running Citus, or you can install the [latest version](https://github.com/docker/compose/releases/latest).) -* Pull and start the docker images +1. Pull and start the docker images ```bash wget https://raw.githubusercontent.com/citusdata/docker/master/docker-compose.yml docker-compose -p citus up -d ``` -* Connect to the master database +1. Connect to the master database ```bash docker exec -it citus_master psql -U postgres ``` -* Follow the [first tutorial][tutorial] instructions -* To shut the cluster down, run +1. Follow the [first tutorial][tutorial] instructions +1. To shut the cluster down, run ```bash docker-compose -p citus down From f5ce760ad327f8f5d7c04596e3f7877599ba6e64 Mon Sep 17 00:00:00 2001 From: Joe Nelson Date: Tue, 7 Mar 2017 11:57:33 -0800 Subject: [PATCH 5/7] Link to (for now) newest docker-compose binary --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c9efce344..044b7b1a6 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,7 @@ If you're looking to get started locally, you can follow the following steps to sudo usermod -aG docker $USER && newgrp docker sudo systemctl start docker - sudo curl -L https://github.com/docker/compose/releases/download/1.11.1/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose + sudo curl -L https://github.com/docker/compose/releases/download/1.11.2/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose sudo chmod +x /usr/local/bin/docker-compose ``` (This docker-compose version is fine for running Citus, or you can install the [latest version](https://github.com/docker/compose/releases/latest).) From 0aec20c8b3144e0e6bb622b1cca5385dc1cf5528 Mon Sep 17 00:00:00 2001 From: Joe Nelson Date: Tue, 7 Mar 2017 17:01:44 -0800 Subject: [PATCH 6/7] More consistent references to Docker products --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 044b7b1a6..9c86e09bc 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ Citus Cloud runs on top of AWS as a fully managed database as a service and has If you're looking to get started locally, you can follow the following steps to get up and running. -1. Install Docker Community Edition and docker-compose +1. Install Docker Community Edition and Docker Compose * Mac: 1. [Download](https://www.docker.com/community-edition#/download) and install Docker. 2. Start Docker by clicking on the application’s icon. @@ -59,8 +59,9 @@ If you're looking to get started locally, you can follow the following steps to sudo curl -L https://github.com/docker/compose/releases/download/1.11.2/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose sudo chmod +x /usr/local/bin/docker-compose ``` - (This docker-compose version is fine for running Citus, or you can install the [latest version](https://github.com/docker/compose/releases/latest).) -1. Pull and start the docker images + The above version of Docker Compose is sufficient for running Citus, or you can install the [latest version](https://github.com/docker/compose/releases/latest). + +1. Pull and start the Docker images ```bash wget https://raw.githubusercontent.com/citusdata/docker/master/docker-compose.yml docker-compose -p citus up -d From b2dd568dba0862ea35e483f94d6a8c2adb8cde5b Mon Sep 17 00:00:00 2001 From: Joe Nelson Date: Tue, 7 Mar 2017 17:02:10 -0800 Subject: [PATCH 7/7] Use curl everywhere and prevent nested shell session --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9c86e09bc..387650e52 100644 --- a/README.md +++ b/README.md @@ -52,18 +52,18 @@ If you're looking to get started locally, you can follow the following steps to 2. Start Docker by clicking on the application’s icon. * Linux: ```bash - curl -sSL https://get.docker.com/ | sudo bash - sudo usermod -aG docker $USER && newgrp docker + curl -sSL https://get.docker.com/ | sh + sudo usermod -aG docker $USER && exec sg docker newgrp `id -gn` sudo systemctl start docker - sudo curl -L https://github.com/docker/compose/releases/download/1.11.2/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose + sudo curl -sSL https://github.com/docker/compose/releases/download/1.11.2/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose sudo chmod +x /usr/local/bin/docker-compose ``` The above version of Docker Compose is sufficient for running Citus, or you can install the [latest version](https://github.com/docker/compose/releases/latest). 1. Pull and start the Docker images ```bash - wget https://raw.githubusercontent.com/citusdata/docker/master/docker-compose.yml + curl -sSLO https://raw.githubusercontent.com/citusdata/docker/master/docker-compose.yml docker-compose -p citus up -d ```