As of Nov 13, 2020, charts in this repo will no longer be updated. For more information, see the Helm Charts Deprecation and Archive Notice, and Update.
This chart is deprecated and no longer supported.
- This chart requires Docker Engine 1.8+ in any of their supported platforms. Please see vendor requirements here for more information.
- At least 2GB of RAM (3.25 GB prior to 2017-CU2). Make sure to assign enough memory to the Docker VM if you're running on Docker for Mac or Windows.
- Requires the following variables
- You must change the acceptEula.value in the values.yaml file to
Yor include--set acceptEula.value=Yin the command line ofhelm installto override the default value ofN. - You must change the editions variable in the values.yaml file to include the edition of SQL Server or include
--set edition.value=<your_product_id | edition_name>in the command line ofhelm install.
- You must change the acceptEula.value in the values.yaml file to
- Creates a SQL Server 2017 deployment (default edition: Express)
- Creates a Kubernetes Service on specified port (default: 1433)
- Creates a Secret to hold SA_PASSWORD
You can install the chart with the release name mymssql as below.
$ helm install --name mymssql stable/mssql-linux --set acceptEula.value=Y --set edition.value=Developer
...Note - If you do not specify a name, helm will select a name for you.
You can use kubectl get to view all of the installed components.
$ kubectl get all -l app=mssql-linux
NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
deploy/mymssql-mssql-linux 1 1 1 1 9m
NAME DESIRED CURRENT READY AGE
rs/mymssql-mssql-linux-8688756468 1 1 1 9m
NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
deploy/mymssql-mssql-linux 1 1 1 1 9m
NAME DESIRED CURRENT READY AGE
rs/mymssql-mssql-linux-8688756468 1 1 1 9m
NAME READY STATUS RESTARTS AGE
po/mymssql-mssql-linux-8688756468-x758g 1/1 Running 0 9m
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
svc/mymssql-mssql-linux ClusterIP 10.104.152.61 <none> 1433/TCP 9m
The sa password is randomized in the secret.yaml file. To retrieve the password, perform the following steps once you install the helm chart.
$ printf $(kubectl get secret --namespace default mymssql-mssql-linux-secret -o jsonpath="{.data.sapassword}" | base64 --decode);echo
...In case an existing secret is used, the sa password must be retrieved from that secret, of course.
- Run the following command
This command will create a pod called mssqlcli that will include the SQL Server Commandline sqlcmd and start at a bash prompt.
$ kubectl run mssqlcli --image=microsoft/mssql-tools -ti --restart=Never --rm=true -- /bin/bash
$ sqlcmd -S mymssql-mssql-linux -U sa
Password: <Enter SA Password>
$ 1> select @@VERSION;
$ 2> go
------------------------------------------------------------------------------------
Microsoft SQL Server 2017 (RTM-CU5) (KB4092643) - 14.0.3023.8 (X64)
Dec 22 2017 16:13:22
Copyright (C) 2017 Microsoft Corporation
Express Edition (64-bit) on Linux (Ubuntu 16.04.3 LTS)
(1 rows affected)
The configuration parameters in this section control the resources requested and utilized by the SQL Server instance.
| Parameter | Description | Default |
|---|---|---|
| acceptEula.value | EULA that needs to be accepted. It will need to be changed via commandline or values.yaml. | n |
| edition.value | The edition of SQL Server to install. See section Editions. | Express |
| sapassword | Password for sa login | Random (20-AlphNum)1 |
| existingSecret | Name of an existing secret containing the sa password | Empty String |
| existingSecretKey | Name of key of the password in existing secret | sapassword |
| image.repository | The docker hub repo for SQL Server | microsoft/mssql-server-linux |
| image.tag | The tag for the image | 2017-CU5 |
| image.pullPolicy | The pull policy for the deployment | IfNotPresent |
| image.pullSecrets | Specify an image pull secret if needed | Commented Out |
| nodeSelector | Node labels for pod assignment | {} |
| service.headless | Allows you to setup a headless service | false |
| service.type | Service Type | ClusterIP |
| service.loadBalancerIP | Loadbalancer IP | nil |
| service.port | Service Port | 1433 |
| service.nodePort | Optional NodePort to use when service.type is NodePort |
None |
| service.annotations | Kubernetes service annotations | {} |
| service.labels | Kubernetes service labels | {} |
| deployment.annotations | Kubernetes deployment annotations | {} |
| deployment.labels | Kubernetes deployment labels | {} |
| pod.annotations | Kubernetes pod annotations | {} |
| pod.labels | Kubernetes pod labels | {} |
| collation | Default collation for SQL Server | SQL_Latin1_General_CP1_CI_AS |
| lcid | Default languages for SQL Server | 1033 |
| hadr | Enable Availability Group | 0 |
| agent.enabled | Enable Agent | false |
| schedulerName | Name of the k8s scheduler (other than default) | nil |
| persistence.enabled | Persist the Data and Log files for SQL Server | true |
| persistence.existingDataClaim | Identify an existing Claim to be used for the Data Directory | Commented Out |
| persistence.existingTransactionLogClaim | Identify an existing Claim to be used for the Log Directory | Commented Out |
| persistence.existingBackupClaim | Identify an existing Claim to be used for the SQL Database Backups | Commented Out |
| persistence.existingMasterClaim | Identify an existing Claim to be used for the Master Database log & file | Commented Out |
| persistence.storageClass | Storage Class to be used | Commented Out |
| persistence.dataAccessMode | Data Access Mode to be used for the Data Directory | ReadWriteOnce |
| persistence.dataSize | PVC Size for Data Directory | 1Gi |
| persistence.logAccessMode | Data Access Mode to be used for the Log Directory | ReadWriteOnce |
| persistence.logSize | PVC Size for Log Directory | 1Gi |
| persistence.backupAccessMode | Data Access Mode to be used for the Backup Directory | ReadWriteOnce |
| persistence.backupSize | PVC Size for Backup Directory | 1Gi |
| persistence.masterAccessMode | Data Access Mode to be used for the Master Database | ReadWriteOnce |
| persistence.masterSize | PVC Size for Master Database | 1Gi |
| tolerations | List of node taints to tolerate | [] |
| affinity | Map of node/pod affinities | {} |
| securityContext | SecurityContext to apply to the pod | {} |
The SQL Server instance has liveness and readiness checks specified. These parameters can be used to tune the sensitivity of the liveness and readiness checks.
| Parameter | Description | Default |
|---|---|---|
| livenessprobe.initialDelaySeconds | Tells the kubelet that it should wait XX second(s) before performing the first probe | 15 |
| livenessprobe.periodSeconds | Field specifies that the kubelet should perform a liveness probe every XX seconds(s) | 20 |
| Parameter | Description | Default |
|---|---|---|
| readinessprobe.initialDelaySeconds | Tells the kubelet that it should wait XX second(s) before performing the first probe | 5 |
| readinessprobe.periodSeconds | Field specifies that the kubelet should perform a liveness probe every XX second(s) | 10 |
You can specify the resource limits for this chart in the values.yaml file. Make sure you comment out or remove the curly brackets from the values.yaml file before specifying resource limits. Example:
resources:
limits:
cpu: 1
memory: 2Gi
requests:
cpu: 0.5
memory: 2GiPersistence in this chart can be enabled by specifying persistence.enabled=true. The path to the database's data and log files can be customized to fit different requirements.
- Example 1 - Enable persistence in values.yaml without specifying claim
Note - This is useful for local development in a minikube environment
persistence:
enabled: true
# existingDataClaim:
# existingTransactionLogClaim:
# existingBackupClaim:
# existingMasterClaim:
# storageClass: "-"
dataAccessMode: ReadWriteOnce
dataSize: 1Gi
logAccessMode: ReadWriteOnce
logSize: 1Gi
backupAccessMode: ReadWriteOnce
backupLogSize: 1Gi
masterAccessMode: ReadWriteOnce
masterSize: 1Gi- Example 2 - Enable persistence in values.yaml with existing claim
Note - This is useful for production based environments for persistence volumes and claims already exist.
persistence:
enabled: true
existingDataClaim: pvc-mssql-data
existingTransactionLogClaim: pvc-mssql-log
existingBackupClaim: pvc-mssql-backup
existingMasterClaim: pvc-mssql-master
# storageClass: "-"
# dataAccessMode: ReadWriteOnce
# dataSize: 1Gi
# logAccessMode: ReadWriteOnce
# logSize: 1Gi
# backupAccessMode: ReadWriteOnce
# backupLogSize: 1Gi
# masterAccessMode: ReadWriteOnce
# masterSize: 1GiBelow are the supported versions of SQL Server on Linux. You can find out more information here.
- Developer : This will run the container using the Developer Edition (this is the default if no MSSQL_PID environment variable is supplied)
- Express : This will run the container using the Express Edition
- Standard : This will run the container using the Standard Edition
- Enterprise : This will run the container using the Enterprise Edition
- EnterpriseCore : This will run the container using the Enterprise Edition Core
- Product ID: This will run the container with the edition that is associated with the PID
You can change the collation of the MSSQL installation by changing the collation key in the values.yaml file. More information about Collation and Unicode Support can be found on the Microsoft Docs Page.
To change the language of the MSSQL installation, change the lcid key in the values.yaml. More informationa about languages can be found using the system view sys.syslanguages. A list of available languages can be found here.
- Example 1 - Retrieve Collation and Language
1>select substring(convert(varchar(30),serverproperty('Collation')),1,30), substring(convert(varchar(20),serverproperty('lcid')),1,20);
2>goAs part of this chart the master database is configured to be installed based in the /mssql-data/master.
As part of this chart you can enable your SQL Server container for Availability Groups. As an administrator, you will need to configure additional settings once this options is enabled. For more information on Availability Group(s) click here for more information.
1>SELECT SERVERPROPERTY ('IsHadrEnabled');
2>go