Skip to content

Commit 155c53b

Browse files
committed
update references from mssqlctl to azdata
1 parent 0f6f040 commit 155c53b

8 files changed

Lines changed: 48 additions & 48 deletions

File tree

samples/features/sql-big-data-cluster/app-deploy/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ Application deployment allows you to deploy applications into SQL Server big dat
77

88
## Pre-requisites
99
* SQL Server big data cluster CTP 2.3 or later
10-
* `mssqlctl` CLI familiarity. If you are unfamiliar with `mssqlctl` please refer to - [App Deployment in SQL Server big data cluster](https://docs.microsoft.com/en-us/sql/big-data-cluster/big-data-cluster-create-apps?view=sqlallproducts-allversions) for more information.
10+
* `azdata` CLI familiarity. If you are unfamiliar with `azdata` please refer to - [App Deployment in SQL Server big data cluster](https://docs.microsoft.com/en-us/sql/big-data-cluster/big-data-cluster-create-apps?view=sqlallproducts-allversions) for more information.
1111

1212
* Tip
13-
**mssqlctl app -h** will display the various commands to manage the app
13+
**azdata app -h** will display the various commands to manage the app
1414

1515
## Templates
1616
Templates are used by our [App Deploy add-ins](https://docs.microsoft.com/en-us/sql/big-data-cluster/app-deployment-extension?view=sqlallproducts-allversions) and can be used to quickly deploy applications.

samples/features/sql-big-data-cluster/app-deploy/RollDice/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ To run this sample, you need the following prerequisites.
3434
**Software prerequisites:**
3535

3636
1. SQL Server big data cluster CTP 2.3 or later.
37-
2. `mssqlctl`. Refer to [installing mssqlctl](https://docs.microsoft.com/en-us/sql/big-data-cluster/deploy-install-mssqlctl?view=sqlallproducts-allversions) document on setting up the `mssqlctl` and connecting to a SQL Server 2019 big data cluster.
37+
2. `azdata`. Refer to [installing azdata](https://docs.microsoft.com/en-us/sql/big-data-cluster/deploy-install-azdata?view=sqlallproducts-allversions) document on setting up the `azdata` and connecting to a SQL Server 2019 big data cluster.
3838

3939
<a name=run-this-sample></a>
4040

@@ -44,20 +44,20 @@ To run this sample, you need the following prerequisites.
4444
2. Log in to the SQL Server big data cluster using the command below using the IP address of the `mgmtproxy-svc-external` in your cluster. If you are not familiar with `mssqltctl` you can refer to the [documentation](https://docs.microsoft.com/en-us/sql/big-data-cluster/big-data-cluster-create-apps?view=sqlallproducts-allversions) and then return to this sample.
4545

4646
```bash
47-
mssqlctl login -e https://<ip-address-of-mgmtproxy-svc-external>:30777 -u <user-name> -p <password>
47+
azdata login -e https://<ip-address-of-mgmtproxy-svc-external>:30777 -u <user-name> -p <password>
4848
```
4949
3. Deploy the application by running the following command, specifying the folder where your `spec.yaml` and `roll-dice.R` files are located:
5050
```bash
51-
mssqlctl app create --spec ./RollDice
51+
azdata app create --spec ./RollDice
5252
```
5353
4. Check the deployment by running the following command:
5454
```bash
55-
mssqlctl app list -n roll-dice -v [version]
55+
azdata app list -n roll-dice -v [version]
5656
```
5757
Once the app is listed as `Ready` you can continue to the next step.
5858
5. Test the app by running the following command:
5959
```bash
60-
mssqlctl app run -n roll-dice -v [version] --input x=3
60+
azdata app run -n roll-dice -v [version] --input x=3
6161
```
6262
You should get output like the example for three dice below. The results of the dice rolled are in the `result` data frame:
6363
```json
@@ -88,7 +88,7 @@ To run this sample, you need the following prerequisites.
8888
6. You can clean up the sample by running the following commands:
8989
```bash
9090
# delete app
91-
mssqlctl app delete --name roll-dice --version [version]
91+
azdata app delete --name roll-dice --version [version]
9292
```
9393

9494
<a name=sample-details></a>

samples/features/sql-big-data-cluster/app-deploy/SSIS/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ To run this sample, you need the following prerequisites.
2323
**Software prerequisites:**
2424

2525
1. SQL Server big data cluster CTP 2.3 or later.
26-
2. `mssqlctl`. Refer to [installing mssqlctl](https://docs.microsoft.com/en-us/sql/big-data-cluster/deploy-install-mssqlctl?view=sqlallproducts-allversions) document on setting up the `mssqlctl` and connecting to a SQL Server big data cluster.
26+
2. `azdata`. Refer to [installing azdata](https://docs.microsoft.com/en-us/sql/big-data-cluster/deploy-install-azdata?view=sqlallproducts-allversions) document on setting up the `azdata` and connecting to a SQL Server big data cluster.
2727
3. Optional: to see the SSIS package itself, install Visual Studio 2017 if you don't have it already. After that download and install [SSDT](https://docs.microsoft.com/en-us/sql/ssdt/download-sql-server-data-tools-ssdt?view=sql-server-2017#ssdt-for-vs-2017-standalone-installer).
2828
4. Optional: install [SSMS](https://docs.microsoft.com/en-us/sql/ssms/download-sql-server-management-studio-ssms?view=sql-server-2017) if it is not already installed.
2929

@@ -35,16 +35,16 @@ To run this sample, you need the following prerequisites.
3535
2. Log in to the SQL Server big data cluster using the command below using the IP address of the `mgmtproxy-svc-external` in your cluster. If you are not familiar with `mssqltctl` you can refer to the [documentation](https://docs.microsoft.com/en-us/sql/big-data-cluster/big-data-cluster-create-apps?view=sqlallproducts-allversions) and then return to this sample.
3636

3737
```bash
38-
mssqlctl login -e https://<ip-address-of-mgmtproxy-svc-external>:30777 -u <user-name> -p <password>
38+
azdata login -e https://<ip-address-of-mgmtproxy-svc-external>:30777 -u <user-name> -p <password>
3939
```
4040
3. Replace `[SA_PASSWORD]` in the `spec.yaml` file with the password for SQL user `sa`.
4141
4. Deploy the application by running the following command, specifying the folder where your `spec.yaml` and `back-up-db.dtsx` files are located:
4242
```bash
43-
mssqlctl app create --spec ./SSIS
43+
azdata app create --spec ./SSIS
4444
```
4545
5. Check the deployment by running the following command:
4646
```bash
47-
mssqlctl app list --name back-up-db --version [version]
47+
azdata app list --name back-up-db --version [version]
4848
```
4949
Once the app is listed as `Ready` the job should run within a minute.
5050
You can check if the backup is created by running:
@@ -56,7 +56,7 @@ To run this sample, you need the following prerequisites.
5656
6. You can clean up the sample by running the following commands:
5757
```bash
5858
# delete app
59-
mssqlctl app delete --name back-up-db --version [version]
59+
azdata app delete --name back-up-db --version [version]
6060
# delete backup files
6161
kubectl -n [your namespace] exec -it mssql-master-pool-0 -c mssql-server -- /bin/bash -c "rm /var/opt/mssql/data/*.DWConfigbak"
6262
```
@@ -73,7 +73,7 @@ Here is the spec file for this application. This sample uses the `SSIS` runtime
7373
|Setting|Description|
7474
|-|-|
7575
|options|Specifies any command line parameters passed to the execution of the SSIS package|
76-
|schedule|Specifies when the job should run. This follows cron expressions. A value of '*/1 * * * *' means the job runs *every minute*. If omitted the package will not run automatically and you can run the package on demand using `mssqlctl run -n back-up-db -v [version]` or making a call to the API.|
76+
|schedule|Specifies when the job should run. This follows cron expressions. A value of '*/1 * * * *' means the job runs *every minute*. If omitted the package will not run automatically and you can run the package on demand using `azdata run -n back-up-db -v [version]` or making a call to the API.|
7777

7878
```yaml
7979
name: back-up-db

samples/features/sql-big-data-cluster/app-deploy/addpy/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ To run this sample, you need the following prerequisites.
3535
**Software prerequisites:**
3636

3737
1. SQL Server big data cluster CTP 2.3 or later.
38-
2. `mssqlctl`. Refer to [installing mssqlctl](https://docs.microsoft.com/en-us/sql/big-data-cluster/deploy-install-mssqlctl?view=sqlallproducts-allversions) document on setting up the `mssqlctl` and connecting to a SQL Server 2019 big data cluster.
38+
2. `azdata`. Refer to [installing azdata](https://docs.microsoft.com/en-us/sql/big-data-cluster/deploy-install-azdata?view=sqlallproducts-allversions) document on setting up the `azdata` and connecting to a SQL Server 2019 big data cluster.
3939

4040
<a name=run-this-sample></a>
4141

@@ -45,20 +45,20 @@ To run this sample, you need the following prerequisites.
4545
2. Log in to the SQL Server big data cluster using the command below using the IP address of the `mgmtproxy-svc-external` in your cluster. If you are not familiar with `mssqltctl` you can refer to the [documentation](https://docs.microsoft.com/en-us/sql/big-data-cluster/big-data-cluster-create-apps?view=sqlallproducts-allversions) and then return to this sample.
4646

4747
```bash
48-
mssqlctl login -e https://<ip-address-of-mgmtproxy-svc-external>:30777 -u <user-name> -p <password>
48+
azdata login -e https://<ip-address-of-mgmtproxy-svc-external>:30777 -u <user-name> -p <password>
4949
```
5050
3. Deploy the application by running the following command, specifying the folder where your `spec.yaml` and `add.py` files are located:
5151
```bash
52-
mssqlctl app create --spec ./addpy
52+
azdata app create --spec ./addpy
5353
```
5454
4. Check the deployment by running the following command:
5555
```bash
56-
mssqlctl app list -n addpy -v [version]
56+
azdata app list -n addpy -v [version]
5757
```
5858
Once the app is listed as `Ready` you can continue to the next step.
5959
5. Test the app by running the following command:
6060
```bash
61-
mssqlctl app run -n addpy -v [version] --input x=3,y=5
61+
azdata app run -n addpy -v [version] --input x=3,y=5
6262
```
6363
You should get output like the example below. The result of adding 3+5 are returned as `result`.
6464
```json
@@ -75,7 +75,7 @@ To run this sample, you need the following prerequisites.
7575
```
7676
6. <a name=restapi></a>Any app you create is also accessible using a RESTful web service that is [Swagger](swagger.io) compliant. You can get the endpoint for the web service by running:
7777
```bash
78-
mssqlctl app describe --name addpy --version [version]
78+
azdata app describe --name addpy --version [version]
7979
```
8080
This will return an output much like the following:
8181
```json
@@ -106,28 +106,28 @@ To run this sample, you need the following prerequisites.
106106
}
107107
```
108108
Note the IP address and the port number in this output. Open the following URL in your browser:
109-
`https://[IP]:[PORT]/api/docs/swagger.json`. You will have to log in with the same credentials you used for `mssqlctl login`. The contents of the `swagger.json` you can paste into [Swagger Editor](https://editor.swagger.io) to understand what methods are available:
109+
`https://[IP]:[PORT]/api/docs/swagger.json`. You will have to log in with the same credentials you used for `azdata login`. The contents of the `swagger.json` you can paste into [Swagger Editor](https://editor.swagger.io) to understand what methods are available:
110110
![API Swagger](api_swagger.png)
111111

112112
Notice the `app` GET method as well as the `token` POST method. Since the authentication for apps uses JWT tokens you will need to get a token my using your favorite tool to make a POST call to the `token` method. Here is an example of how to do just that in [Postman](https://www.getpostman.com/):
113113
![Postman Token](postman_token.png)
114114

115115
The result of this request will give you an `access_token`, which you will need to call the URL to run the app.
116116

117-
> *Optional*: If you want, you can open the URL for the `swagger` that was returned when you ran `mssqlctl app describe --name addpy --version [version]` in your browser. You will have to log in with the same credentials you used for `mssqlctl login`. The contents of the `swagger.json` you can paste into [Swagger Editor](https://editor.swagger.io). You will see that the web service exposes the `run` method.
117+
> *Optional*: If you want, you can open the URL for the `swagger` that was returned when you ran `azdata app describe --name addpy --version [version]` in your browser. You will have to log in with the same credentials you used for `azdata login`. The contents of the `swagger.json` you can paste into [Swagger Editor](https://editor.swagger.io). You will see that the web service exposes the `run` method.
118118

119119
You can use your favorite tool to call the `run` method (`https://[IP]:30778/api/app/addpy/[version]/run`), passing in the parameters in the body of your POST request as json. In this example we will use [Postman](https://www.getpostman.com/). Before making the call, you will need to set the `Authorization` to `Bearer Token` and paste in the token you retrieved earlier. This will set a header on your request. See the screenshot below.
120120
![Postman Run Headers](postman_run_1.png)
121121
Next, in the requests body, pass in the parameters to the app you are calling and set the `content-type` to `application/json`:
122122
![Postman Run Body](postman_run_2.png)
123-
When you send the request, you will get the same output as you did when you ran the app through `mssqlctl app run`:
123+
When you send the request, you will get the same output as you did when you ran the app through `azdata app run`:
124124
![Postman Run Result](postman_result.png)
125125
You have now successfully called the app through the web service!
126126

127127
7. You can clean up the sample by running the following commands:
128128
```bash
129129
# delete app
130-
mssqlctl app delete --name addpy --version [version]
130+
azdata app delete --name addpy --version [version]
131131
```
132132

133133
<a name=sample-details></a>

samples/features/sql-big-data-cluster/app-deploy/magic8ball/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ To run this sample, you need the following prerequisites.
3434
**Software prerequisites:**
3535

3636
1. SQL Server big data cluster CTP 2.3 or later.
37-
2. `mssqlctl`. Refer to [installing mssqlctl](https://docs.microsoft.com/en-us/sql/big-data-cluster/deploy-install-mssqlctl?view=sqlallproducts-allversions) document on setting up the `mssqlctl` and connecting to a SQL Server 2019 big data cluster.
37+
2. `azdata`. Refer to [installing azdata](https://docs.microsoft.com/en-us/sql/big-data-cluster/deploy-install-azdata?view=sqlallproducts-allversions) document on setting up the `azdata` and connecting to a SQL Server 2019 big data cluster.
3838

3939
<a name=run-this-sample></a>
4040

@@ -44,20 +44,20 @@ To run this sample, you need the following prerequisites.
4444
2. Log in to the SQL Server big data cluster using the command below using the IP address of the `mgmtproxy-svc-external` in your cluster. If you are not familiar with `mssqltctl` you can refer to the [documentation](https://docs.microsoft.com/en-us/sql/big-data-cluster/big-data-cluster-create-apps?view=sqlallproducts-allversions) and then return to this sample.
4545

4646
```bash
47-
mssqlctl login -e https://<ip-address-of-mgmtproxy-svc-external>:30777 -u <user-name> -p <password>
47+
azdata login -e https://<ip-address-of-mgmtproxy-svc-external>:30777 -u <user-name> -p <password>
4848
```
4949
3. Deploy the application by running the following command, specifying the folder where your `spec.yaml` and `magic8ball.py` files are located:
5050
```bash
51-
mssqlctl app create --spec ./magic8ball
51+
azdata app create --spec ./magic8ball
5252
```
5353
4. Check the deployment by running the following command:
5454
```bash
55-
mssqlctl app list -n magic8ball -v [version]
55+
azdata app list -n magic8ball -v [version]
5656
```
5757
Once the app is listed as `Ready` you can continue to the next step.
5858
5. Test the app by running the following command:
5959
```bash
60-
mssqlctl app run -n magic8ball -v [version] --input txt="Will it rain tomorrow?"
60+
azdata app run -n magic8ball -v [version] --input txt="Will it rain tomorrow?"
6161
```
6262
You should get output like the example below. The answer to your question are returned as `result`.
6363
```json
@@ -78,7 +78,7 @@ To run this sample, you need the following prerequisites.
7878
6. You can clean up the sample by running the following commands:
7979
```bash
8080
# delete app
81-
mssqlctl app delete --name magic8ball --version [version]
81+
azdata app delete --name magic8ball --version [version]
8282
```
8383

8484
<a name=sample-details></a>

samples/features/sql-big-data-cluster/app-deploy/mleap/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ To run this sample, you need the following prerequisites.
3131
**Software prerequisites:**
3232

3333
1. SQL Server big data cluster CTP 2.3 or later.
34-
2. `mssqlctl`. Refer to [installing mssqlctl](https://docs.microsoft.com/en-us/sql/big-data-cluster/deploy-install-mssqlctl?view=sqlallproducts-allversions) document on setting up the `mssqlctl` and connecting to a SQL Server 2019 big data cluster.
34+
2. `azdata`. Refer to [installing azdata](https://docs.microsoft.com/en-us/sql/big-data-cluster/deploy-install-azdata?view=sqlallproducts-allversions) document on setting up the `azdata` and connecting to a SQL Server 2019 big data cluster.
3535

3636
<a name=run-this-sample></a>
3737

@@ -41,25 +41,25 @@ To run this sample, you need the following prerequisites.
4141
2. Log in to the SQL Server big data cluster using the command below using the IP address of the `mgmtproxy-svc-external` in your cluster. If you are not familiar with `mssqltctl` you can refer to the [documentation](https://docs.microsoft.com/en-us/sql/big-data-cluster/big-data-cluster-create-apps?view=sqlallproducts-allversions) and then return to this sample.
4242

4343
```bash
44-
mssqlctl login -e https://<ip-address-of-mgmtproxy-svc-external>:30777 -u <user-name> -p <password>
44+
azdata login -e https://<ip-address-of-mgmtproxy-svc-external>:30777 -u <user-name> -p <password>
4545
```
4646
3. This example uses a TensorFlow Machine Learning Model that uses public US Census data predict income. [More details and information on the example are here](https://docs.microsoft.com/en-us/sql/big-data-cluster/train-and-create-machinelearning-models-with-spark?view=sqlallproducts-allversions). The application you will be deploying as part of this sample is a Random Forest Model that was built in Spark and has been [serialized as an MLeap bundle](https://docs.microsoft.com/en-us/sql/big-data-cluster/export-model-with-spark-mleap?view=sqlallproducts-allversions).
4747

4848
Deploy the app using the `create` command and pass the location of the spec file. In the example below, the spec file is expected to be in the `mleap` folder:
4949
```bash
50-
mssqlctl app create --spec ./mleap/
50+
azdata app create --spec ./mleap/
5151
```
5252
1. Check the deployment by running the following command:
5353
```bash
54-
mssqlctl app list -n mleap-census -v [version]
54+
azdata app list -n mleap-census -v [version]
5555
```
5656
Once the app is listed as `Ready` you can continue to the next step.
5757
2. Now that the app has been deployed you can test if the app works correctly by passing in a sample input that is available in the `mleap` folder. The deployed app is a RESTful webservice that is [Swagger](swagger.io) compliant. For this sample we will show you how you can test this using the CLI.
5858

5959
To test the app, run the command below. The input parameter is a `MLeapFrame`, a `json` file that describes the parameters and the values provided to the model for predicting income. Note that the input parameter has a special character '@' to indicate that a `json` file is being passed. This command needs to be run within the `mleap` folder.
6060

6161
```bash
62-
mssqlctl app run --name mleap-census --version [version] --input schema=@census_frame.json
62+
azdata app run --name mleap-census --version [version] --input schema=@census_frame.json
6363
```
6464

6565
The result will be a json output that includes the predicted income along with additional data.
@@ -69,7 +69,7 @@ To run this sample, you need the following prerequisites.
6969
6. You can clean up the sample by running the following commands:
7070
```bash
7171
# delete app
72-
mssqlctl app delete --name mleap-census --version [version]
72+
azdata app delete --name mleap-census --version [version]
7373
```
7474

7575
<a name=sample-details></a>

0 commit comments

Comments
 (0)