Merge pull request #7070 from mihaelablendea/patch-56

Updates to deployment quickstart

Author: rothja

docs/aris/quickstart-sql-server-aris-deploy.md

@@ -11,25 +11,16 @@ ms.prod: sql
 
 # Quickstart: Deploy SQL Server Aris on Kubernetes
 
-In this quickstart, you will install SQL Server Aris on Kubernetes.
+In this quickstart, you will install SQL Server Aris on Kubernetes in a default configuration suitable for dev/test environments. Here is the list of environment variables and their default values you can update to customize your cluster configuration:
+TBD
+
 
 ## Prerequisites
 
 This quickstart requires that you have already configured a Kubernetes cluster. For more information, see the Kubernetes section in the deployment guide:
 
 - [Configure a Kubernetes cluster](sql-server-aris-deployment-guidance.md#kubernetes).
 
-## Clone the deployment project
-
-1. If not already installed, install git locally on [Windows](https://git-for-windows.github.io/), [Linux, or Mac](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
-
-1. First, in PowerShell, cmd, or a terminal window, navigate to the directory that you want to contain the deployment project files.
-
-1. Then, run the following command to clone the files from GitHub to your machine:
-
-   ```bash
-   git clone https://github.com/Microsoft/sqlservervnext.git
-   ```
 
 ## Verify kubernetes configuration
 
@@ -39,11 +30,13 @@ Execute the below kubectl command to view the cluster configuration. Ensure that
 kubectl config view
 ```
 
-## Define environment variables
+## Install mssqlctl CLI management tool for Aris
 
-The deployment commands for SQL Server vNext are slightly different depending on whether you are using Windows or Linux.  Choose the steps below depending on which operating system you are using.
+TBD
 
-Initialize the following environment variables first. Enter the Docker username and password that have been provided to you.
+## Define environment variables
+
+Setting the environment variables required for deploying Aris cluster differs depending on whether you are using Windows or Linux client.  Choose the steps below depending on which operating system you are using.
 
 > [!IMPORTANT]
 > Make sure you wrap the passwords in double quotes if it contains any special characters.
@@ -53,72 +46,57 @@ Initialize the following environment variables first. Enter the Docker username
 > [!NOTE]
 > For the CTP 2.0 release do not change the default ports.
 
+Initialize the following environment variables, they are required for deploying the Aris cluster:
+
 ### Windows
 
-Using a CMD window (not PowerShell), navigate to the **CTP1.8\kube\deployment\mssql-data-pool folder**. Configure the following environment variables:
+Using a CMD window (not PowerShell), configure the following environment variables:
 
 ```cmd
-SET CLUSTER_PLATFORM=minikube or acs (or aks in future, but not this release)
+SET CLUSTER_PLATFORM=<minikube or acs or aks>
 SET CLUSTER_NODE_REPLICAS=<number_of_nodes_excluding_master>
 
 SET CONTROLLER_USERNAME=<controller_admin_name – can be anything>
-SET CONTROLLER_PASSWORD=<controller_admin_password – can be anything>
+SET CONTROLLER_PASSWORD=<controller_admin_password – can be anything, password complexity compliant>
 
 SET DOCKER_REGISTRY=private-repo.microsoft.com
 SET DOCKER_REPOSITORY=mssql-private-preview
-SET DOCKER_USERNAME=<your_user_name>
-SET DOCKER_PASSWORD=<your_password>
-SET DOCKER_EMAIL=<your_email>
-SET DOCKER_PRIVATE_REGISTRY="1"
-
-SET HADOOP_IMAGE=<mssql-hadoop (Default, Apache Spark) or mssql-hadoop-dbr (Databricks)>
 
-SET MSSQL_SA_PASSWORD=<sa_password_of_sql_instances>
-SET MSSQL_SECURITY_SA_PASSWORD=<sa_password_of_internal_sql_instance>
-SET MSSQL_IMPORT_PASSWORD=<import_account_password_of_sql_instances>
-SET MSSQL_EXTERNAL_PASSWORD=<external_account_password_of_sql_instances>
+SET MSSQL_SA_PASSWORD=<sa_password_of_master_sql_instances>
 
 SET MASTER_SQL_PORT=31433
 SET KNOX_PORT=30443
 SET RANGER_PORT=30680
 ```
 
-If you are using ACS, then set the following environment variable also:
+If you are using ACS or AKS, then set the following environment variable also:
 
 ```cmd
 SET DOCKER_IMAGE_POLICY=IfNotPresent
 ```
 
 ### Linux
 
-Navigate to the **CTP1.8/kube/deployment/mssql-data-pool** folder. Initialize the following environment variables:
+Initialize the following environment variables:
 
 ```bash
-export CLUSTER_PLATFORM=minikube or acs (or aks in future, but not this release)
+export CLUSTER_PLATFORM=<minikube or acs or aks>
 export CLUSTER_NODE_REPLICAS=<number_of_nodes_excluding_master>
 
 export CONTROLLER_USERNAME=<controller_admin_name – can be anything>
-export CONTROLLER_PASSWORD=<controller_admin_password – can be anything>
+export CONTROLLER_PASSWORD=<controller_admin_password – can be anything, password complexity compliant>
 
 export DOCKER_REGISTRY=private-repo.microsoft.com
 export DOCKER_REPOSITORY=mssql-private-preview
-export DOCKER_USERNAME=<your_user_name>
-export DOCKER_PASSWORD=<your_password>
-export DOCKER_EMAIL=<your_email>
-export DOCKER_PRIVATE_REGISTRY="1"
 
-export HADOOP_IMAGE=<mssql-hadoop (Default) or mssql-hadoop-dbr (Databricks)>
-export MSSQL_SA_PASSWORD=<sa_password_of_sql_instances>
-export MSSQL_SECURITY_SA_PASSWORD=<sa_password_of_internal_sql_instance>
-export MSSQL_IMPORT_PASSWORD=<import_account_password_of_sql_instances>
-export MSSQL_EXTERNAL_PASSWORD=<external_account_password_of_sql_instances>
+export MSSQL_SA_PASSWORD=<sa_password_of_master_sql_instances>
 
 export MASTER_SQL_PORT=31433
 export KNOX_PORT=30443
 export RANGER_PORT=30680
 ```
 
-If you are using ACS, then set the following environment variable also:
+If you are using ACS or AKS, then set the following environment variable also:
 
 ```bash
 export DOCKER_IMAGE_POLICY=IfNotPresent
@@ -133,36 +111,42 @@ python mssqlctl.py create cluster <name of your cluster>
 ```
 
 > [!NOTE]
-> The name of your cluster needs to be only lower case alpha-numeric characters, no spaces.
+> The name of your cluster needs to be only lower case alpha-numeric characters, no spaces. All Kubernetes artifacts for the Aris cluster will be created in a namespace with same name as the cluster name specified.
 
-You can ignore the initial error messages about various resources not being found. This step can take several minutes to run.
 
-While the command window is showing the status, you can check the deployment status by running these commands in a different cmd window:
+The command window will ouput the deployment status. You can also check the deployment status by running these commands in a different cmd window:
+
+```bash
+kubectl get all -n <name of your cluster>
+kubectl get pods -n <name of your cluster>
+kubectl get svc -n <name of your cluster>
+```
 
+You can see a more granular status and configuration for each pod by runnnig:
 ```bash
-kubectl describe pod mssql-data-pool-master-0 -n <name of your cluster>
-kubectl describe pod mssql-data-pool-node-0 -n <name of your cluster
+kubectl describe pod <pod name> -n <name of your cluster>
 ```
 
-There will probably be multiple data pool pods number 0-n.  You can run the above command to see the status of each of them as they are deploying by changing the number at the end.
+Once the Controller pod is running, you can use the Cluster Administration Portal to monitor the deployment. The portal will be launched automatically. 
 
 ## <a id="masterip"></a> Get the master instance IP address
 
-After the deployment script has completed successfully, you can obtain the IP address of the SQL Server master instance using the steps outlined below. You will use this IP address and port number 31433 to connect to the SQL Server master instance (for example: **\<ip-address\>,31433**).
+After the deployment script has completed successfully, you can obtain the IP address of the SQL Server master instance using the steps outlined below. You will use this IP address and port number 31433 to connect to the SQL Server master instance (for example: **\<ip-address\>,31433**). Similarly, for the Knox Gateway endpoint. All cluster endpoints are outlined in the Service Endpoints tab in the Cluster Admin Portal as well.
 
-### ACS
+### ACS/AKS
 
-If you are using ACS, Azure provides the Azure LoadBalancer service to ACS. Run following command:
+If you are using ACS/AKS, Azure provides the Azure LoadBalancer service to ACS. Run following command:
 
 ```bash
 kubectl get svc service-master-lb -n <name of your cluster>
+kubectl get svc service-security-lb -n <name of your cluster>
 ```
 
-Look for the **External-IP** value that is assigned to the service. Then, connect to the SQL Server master instance using the IP address at port 31433 (Ex: **\<ip-address\>,31433**).
+Look for the **External-IP** value that is assigned to the service. Then, connect to the SQL Server master instance using the IP address at port 31433 (Ex: **\<ip-address\>,31433**) and to Knox Gateway endpoint using the external-IP for `service-security-lb` service. 
 
 ### Minikube
 
-If you are using Minikube, you need to run the following command to get the IP address you need to connect to.
+If you are using Minikube, you need to run the following command to get the IP address you need to connect to. In addition to the IP, specify the port for the endpoint you need to connect to.
 
 ```bash
 minikube ip
@@ -173,4 +157,4 @@ minikube ip
 Now that SQL Server Aris is deployed, try out some of the new capabilities:
 
 > [!div class="nextstepaction"]
-> [Get started with SQL Server Aris](quickstart-sql-server-aris-get-started.md)
+> [Get started with SQL Server Aris](quickstart-sql-server-aris-get-started.md)