Minor fixes in docs.
Change-Id: Ida11f4aec9811e0f4a8c397413d254b06dd82efd
Reviewed-on: https://asterix-gerrit.ics.uci.edu/1634
Reviewed-by: Michael Blow <mblow@apache.org>
Sonar-Qube: Jenkins <jenkins@fulliautomatix.ics.uci.edu>
Integration-Tests: Jenkins <jenkins@fulliautomatix.ics.uci.edu>
Tested-by: Jenkins <jenkins@fulliautomatix.ics.uci.edu>
diff --git a/asterixdb/asterix-doc/src/main/markdown/sqlpp/0_toc.md b/asterixdb/asterix-doc/src/main/markdown/sqlpp/0_toc.md
index 49bb96e..134ce95 100644
--- a/asterixdb/asterix-doc/src/main/markdown/sqlpp/0_toc.md
+++ b/asterixdb/asterix-doc/src/main/markdown/sqlpp/0_toc.md
@@ -73,7 +73,7 @@
* [SQL++ Vs. SQL-92](#Vs_SQL-92)
* [4. Errors](#Errors)
* [Syntax Errors](#Syntax_errors)
- * [Identifier Resolution Errors](#Parsing_errors)
+ * [Identifier Resolution Errors](#Identifier_resolution_errors)
* [Type Errors](#Type_errors)
* [Resource Errors](#Resource_errors)
* [5. DDL and DML Statements](#DDL_and_DML_statements)
diff --git a/asterixdb/asterix-doc/src/main/markdown/sqlpp/4_error.md b/asterixdb/asterix-doc/src/main/markdown/sqlpp/4_error.md
index 0f81d5e..e043fc2 100644
--- a/asterixdb/asterix-doc/src/main/markdown/sqlpp/4_error.md
+++ b/asterixdb/asterix-doc/src/main/markdown/sqlpp/4_error.md
@@ -35,13 +35,12 @@
##### Example
SELECT *
- FROM GleambookUsers user
+ GleambookUsers user
-Since the ending semi-colon is mandatory for any SQL++ query,
+Since the query misses a `FROM` keyword before the dataset `GleambookUsers`,
we will get a syntax error as follows:
- Error: Syntax error: In line 2 >>FROM GleambookUsers user<< Encountered <EOF> at column 24.
- ==> FROM GleambookUsers user
+ Syntax error: In line 2 >>GleambookUsers user;<< Encountered <IDENTIFIER> \"GleambookUsers\" at column 1.
##### Example
@@ -49,7 +48,7 @@
FROM GleambookUsers user
WHERE type="advertiser";
-Since "type" a [reserved keyword](#Reserved_keywords) in the SQL++ parser,
+Since "type" is a reserved keyword in the SQL++ parser,
we will get a syntax error as follows:
Error: Syntax error: In line 3 >>WHERE type="advertiser";<< Encountered 'type' "type" at column 7.
diff --git a/asterixdb/asterix-doc/src/site/markdown/ansible.md b/asterixdb/asterix-doc/src/site/markdown/ansible.md
index 01a8302..fa3f483 100644
--- a/asterixdb/asterix-doc/src/site/markdown/ansible.md
+++ b/asterixdb/asterix-doc/src/site/markdown/ansible.md
@@ -33,15 +33,15 @@
* Install pip on your client machine:
- CentOS: sudo yum install python-pip
- Ubuntu: sudo apt-get install python-pip
- MacOS: brew install pip
+ CentOS: sudo yum install python-pip
+ Ubuntu: sudo apt-get install python-pip
+ MacOS: brew install pip
* Install Ansible, boto, and boto3 on your client machine:
- pip install ansible
- pip install boto
- pip install boto3
+ pip install ansible
+ pip install boto
+ pip install boto3
**Make sure that the version of Ansible is no less than 2.2.1.0.**
@@ -68,13 +68,13 @@
You can add/update whatever parameters in the **[common]** and **[nc]** sections (except IPs and ports).
For example:
- [common]
- log.level=INFO
+ [common]
+ log.level=INFO
- [nc]
- txn.log.dir=txnlog
- iodevices=iodevice
- command=asterixnc
+ [nc]
+ txn.log.dir=txnlog
+ iodevices=iodevice
+ command=asterixnc
More parameters and their usage can be found [here](ncservice.html#Parameters).
Note that with this installation option, all parameters in the **[cc]** and **[ncservice]**
@@ -87,20 +87,20 @@
The following example configures a cluster with two slave nodes (172.0.1.11 and 172.0.1.12) and
one master node (172.0.1.10).
- [cc]
- 172.0.1.10
+ [cc]
+ 172.0.1.10
- [ncs]
- 172.0.1.11
- 172.0.1.12
+ [ncs]
+ 172.0.1.11
+ 172.0.1.12
**Configure passwordless ssh from your current client that runs the scripts to all nodes listed
in `conf/inventory`.**
If the ssh user account for target machines is different from your current username, please uncomment
and edit the following two lines:
- ;[all:vars]
- ;ansible_ssh_user=<fill with your ssh account username>
+ ;[all:vars]
+ ;ansible_ssh_user=<fill with your ssh account username>
If you want to specify advanced Ansible builtin variables, please refer to the
[Ansible documentation](http://docs.ansible.com/ansible/intro_inventory.html).
@@ -109,11 +109,11 @@
when necessary. By default, the binary directory will be under the home directory (as the value of
Ansible builtin variable ansible_env.HOME) of the ssh user account on each node.
- # The parent directory for the working directory.
- basedir: "{{ ansible_env.HOME }}"
+ # The parent directory for the working directory.
+ basedir: "{{ ansible_env.HOME }}"
- # The working directory.
- binarydir: "{{ basedir }}/{{ product }}"
+ # The working directory.
+ binarydir: "{{ basedir }}/{{ product }}"
## <a id="lifecycle">Manage the lifecycle of your instance</a>
diff --git a/asterixdb/asterix-doc/src/site/markdown/aws.md b/asterixdb/asterix-doc/src/site/markdown/aws.md
index 8c554b4..272beb0 100644
--- a/asterixdb/asterix-doc/src/site/markdown/aws.md
+++ b/asterixdb/asterix-doc/src/site/markdown/aws.md
@@ -37,15 +37,15 @@
* Install pip on your client machine:
- CentOS: sudo yum install python-pip
- Ubuntu: sudo apt-get install python-pip
- MacOS: brew install pip
+ CentOS: sudo yum install python-pip
+ Ubuntu: sudo apt-get install python-pip
+ MacOS: brew install pip
* Install Ansible, boto, and boto3 on your client machine:
- pip install ansible
- pip install boto
- pip install boto3
+ pip install ansible
+ pip install boto
+ pip install boto3
**Make sure that the version of Ansible is no less than 2.2.1.0.**
@@ -56,11 +56,11 @@
* In the extracted directory from the `simple server package`, navigate to `opt/aws/`
- $cd opt/aws
+ $cd opt/aws
The following files and directories are in the directory `opt/aws`:
- README bin conf yaml
+ README bin conf yaml
`bin` contains scripts that start and terminate an AWS-based cluster instance, according to the configuration
specified in files under `conf/`. `yaml` contains internal Ansible scripts that the shell scripts in `bin` use.
@@ -82,87 +82,87 @@
* Configure your ssh setting by editing `~/.ssh/config` and adding the following entry:
- Host *.amazonaws.com
- IdentityFile <path_of_private_key>
+ Host *.amazonaws.com
+ IdentityFile <path_of_private_key>
Note that \<path_of_private_key\> should be replaced by the path to the file that stores the private key for the
key pair that you uploaded to AWS and used in `conf/aws_settings`. For example:
- Host *.amazonaws.com
- IdentityFile ~/.ssh/id_rsa
+ Host *.amazonaws.com
+ IdentityFile ~/.ssh/id_rsa
### <a id="config">Configuration</a>
* **AWS settings**. Edit conf/instance_settings.yml. The meaning of each parameter is listed as follows:
- # The OS image id for ec2 instances.
- image: ami-76fa4116
+ # The OS image id for ec2 instances.
+ image: ami-76fa4116
- # The data center region for ec2 instances.
- region: us-west-2
+ # The data center region for ec2 instances.
+ region: us-west-2
- # The tag for each ec2 machine.
- tag: scale_test
+ # The tag for each ec2 machine.
+ tag: scale_test
- # The name of a security group that appears in your AWS console.
- group: default
+ # The name of a security group that appears in your AWS console.
+ group: default
- # The name of a key pair that appears in your AWS console.
- keypair: <to be filled>
+ # The name of a key pair that appears in your AWS console.
+ keypair: <to be filled>
- # The AWS access key id for your IAM user.
- access_key_id: <to be filled>
+ # The AWS access key id for your IAM user.
+ access_key_id: <to be filled>
- # The AWS secrety key for your IAM user.
- secret_access_key: <to be filled>
+ # The AWS secrety key for your IAM user.
+ secret_access_key: <to be filled>
- # The AWS instance type. A full list of available types are listed at:
- # https://aws.amazon.com/ec2/instance-types/
- instance_type: t2.micro
+ # The AWS instance type. A full list of available types are listed at:
+ # https://aws.amazon.com/ec2/instance-types/
+ instance_type: t2.micro
- # The number of ec2 instances that construct a cluster.
- count: 3
+ # The number of ec2 instances that construct a cluster.
+ count: 3
- # The user name.
- user: ec2-user
+ # The user name.
+ user: ec2-user
- # Whether to reuse one nc machine to host cc.
- cc_on_nc: false
+ # Whether to reuse one nc machine to host cc.
+ cc_on_nc: false
**As described in [prerequisites](#Prerequisites), the following parameters must be customized:**
- # The name of a security group that appears in your AWS console.
- group: default
+ # The name of a security group that appears in your AWS console.
+ group: default
- # The name of a key pair that appears in your AWS console.
- keypair: <to be filled>
+ # The name of a key pair that appears in your AWS console.
+ keypair: <to be filled>
- # The AWS access key id for your IAM user.
- access_key_id: <to be filled>
+ # The AWS access key id for your IAM user.
+ access_key_id: <to be filled>
- # The AWS secrety key for your IAM user.
- secret_access_key: <to be filled>
+ # The AWS secrety key for your IAM user.
+ secret_access_key: <to be filled>
* **Remote working directories**. Edit conf/instance_settings.yml to change the instance binary directories
when necessary. By default, the binary directory will be under the home directory (as the value of
Ansible builtin variable ansible_env.HOME) of the ssh user account on each node.
- # The parent directory for the working directory.
- basedir: "{{ ansible_env.HOME }}"
+ # The parent directory for the working directory.
+ basedir: "{{ ansible_env.HOME }}"
- # The working directory.
- binarydir: "{{ basedir }}/{{ product }}"
+ # The working directory.
+ binarydir: "{{ basedir }}/{{ product }}"
### <a id="lifecycle">Manage the lifecycle of your instance</a>
- * Start an AWS-based AsterixDB cluster:
+ * Start an AWS-based AsterixDB cluster:
- bin/start.sh
+ bin/start.sh
Now you can use the cluster instance through the public IP or DNS name of the master node.
* If you want to terminate the AsterixDB instance, run the following script:
- bin/stop.sh
+ bin/stop.sh
**Note that it will destroy everything in the AsterixDB instance you installed and terminate all AWS nodes
for the cluster.**