Skip to content

Commit 8806368

Browse files
committed
Added note about VM setting
1 parent 50b2aaa commit 8806368

1 file changed

Lines changed: 23 additions & 11 deletions

File tree

  • samples/features/sql-big-data-cluster/deployment/kubeadm/ubuntu-single-node-vm

samples/features/sql-big-data-cluster/deployment/kubeadm/ubuntu-single-node-vm/README.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,37 +5,49 @@ Using this sample bash script, you will deploy a single node Kubernetes cluster
55

66
## Pre-requisites
77

8-
1. A vanilla Ubuntu 16.04 or 18.04 VM. All dependencies will be setup by the script. Using Azure Linux VMs is not yet supported.
9-
1. VM should have at least 8 CPUs, 64GB RAM and 100GB disk space. After installing the images you will be left with 50GB for data/logs across all components.
8+
1. A vanilla Ubuntu 16.04 or 18.04 virtual or physical machine. All dependencies will be setup by the script. Using Azure Linux VMs is not yet supported.
9+
1. Machine should have at least 8 CPUs, 64GB RAM and 100GB disk space. After installing the images you will be left with 50GB for data/logs across all components.
10+
1. Update existing packages using commands below to ensure that the OS image is up to date
1011

11-
## Instructions
12+
``` bash
13+
sudo apt update&&apt upgrade -y
14+
sudo systemctl reboot
15+
```
1216

13-
1. Download the script on the VM you are planning to use for the deployment
17+
## Recommended Virtual Machine settings
1418

15-
```
19+
1. Use static memory configuration for the virtual machine. For example, in hyper-v installations do not use dynamic memory allocation but instead allocate the recommended 64 GB or higher.
20+
21+
1. Use checkpoint or snapshot capability in your hyper visor so that you can rollback the virtual machine to a clean state.
1622

23+
## Instructions to deploy SQL Server big data cluster
24+
25+
1. Download the script on the VM you are planning to use for the deployment
26+
27+
``` bash
1728
curl --output setup-bdc.sh https://raw.githubusercontent.com/microsoft/sql-server-samples/master/samples/features/sql-big-data-cluster/deployment/kubeadm/ubuntu-single-node-vm/setup-bdc.sh
1829
```
1930

2031
1. Make the script executable
2132

22-
```
23-
33+
``` bash
2434
chmod +x setup-bdc.sh
2535
```
2636

2737
1. Run the script (make sure you are running with sudo)
2838

29-
```
30-
39+
``` bash
3140
sudo ./setup-bdc.sh
3241
```
3342

3443
1. Refresh alias setup for azdata
3544

36-
```
37-
45+
``` bash
3846
source ~/.bashrc
3947
```
4048

4149
When prompted, provide your input for the password that will be used for all external endpoints: controller, SQL Server master and gateway. The password should be sufficiently complex based on existing rules for SQL Server password. The controller username is defaulted to *admin*.
50+
51+
## Cleanup
52+
53+
1. The [cleanup-bdc.sh](cleanup-bdc.sh/) script is provided as convenience to reset the environment in case of errors. However, we recommend that you use a virtual machine for testing purposes and use the snapshot capabiility in your hyper-visor to rollback the virtual machine to a clean state.

0 commit comments

Comments
 (0)