• Install Kubenetes CLI tool - kubectl. Instructions can be found here: https://kubernetes.io/docs/tasks/tools/install-kubectl/
• Install the command line tool of the Kubernetes hosting system:
  • Azure (AKS) https://docs.microsoft.com/en-us/cli/azure/install-azure-cli-windows?view=azure-cli-latest
• SQL Server connection string.
  • The SQL connection user account must have permission create new databases and db_owner of the databases.
• SSL certificate and private key without password
• Request the container registry login from IQX for pulling OneList images
• SMTP server login and email address if email approval channel is enabled
• Generate the Machine key for each environment. This is a Base64 string representing an array of 50 bytes.
  • Use tools like https://generate.plus/en/base64 to generate a random string of the required length.
• Download these Yaml files
  • onelist6-ingress.yaml
  • onelist6-service.yaml
  • onelist6-deployment.yaml
  • ingress-nginx-controller.yaml
  • config.yaml

Minimum Requirement

Log on to Azure Kubernetes Service (AKS)

1. Log on to Azure by executing this command: az login
2. Setup the Azure log in with kubectl by executing this command: az aks get-credentials --resource-group <Azure_Resource_Group> --name <Azure_Kubernetes_Service>

Deployment steps

Open a command prompt from the folder that contains the YAML deployment files. Flow steps below to deploy OneList.

1. Create the Kubernetes namespace

Run the command below to create the namespace in Kubernetes, e.g. onelist.

kubectl create namespace <ONELIST_NAMESPACE>

2. Create ConfigMap and Secret

These Kubernetes ConfigMap and Secret defines the required environment variables that are used by OneList services. Open the "config.yaml" in notepad and update the following fields with the actual value. 

• RoleManager__MachineKey 
  The value is the generated machine key.
• Database__ConnectionString
  The value is the SQL Server connection string. The name of the databases will be automatically specified by the services.
• Smtp__UserName 
• Smtp__Password
• ASPNETCORE_ENVIRONMENT
  The value specifies the environment. It can be one of the following Production, Dev, QA.
• Smtp__From
  This is the sender email address of notifications from OneList
• Smtp__Host
  This is the SMTP server OneList use to send notifications.
• Smtp__Port
  This is the port of SMTP server.
• Smtp__UseSsl
  Define if SMTP server uses SSL connection.

Save the "config.yaml" file then run the command below.

kubectl apply -f config.yaml --namespace <ONELIST_NAMESPACE>

3. Create the Secrete for pulling OneList images

Replace placeholders in the command below and run it.

kubectl create secret docker-registry iqx.acr --docker-server=https://iqxbusiness.azurecr.io --docker-username=<ACR_USERNAME> --docker-password=<ACR_PASSWORD> --docker-email=<YOUR_EMAIL_ADDRESS> --namespace <ONELIST_NAMESPACE>

4. Deploy OneList containers for the apps and services

Run the 2 commands below.

kubectl apply -f onelist6-deployment.yaml --namespace <ONELIST_NAMESPACE>

kubectl apply -f onelist6-service.yaml --namespace <ONELIST_NAMESPACE>

5. Create Nginx ingress service

Run the 2 commands below.

kubectl create -f ingress-nginx-controller.yaml

kubectl create -f onelist6-ingress.yaml --namespace <ONELIST_NAMESPACE>

6. Create the TLS secrete

Run the command below.

kubectl create secret tls tls.onelist --cert <SSL_CERTIFICATE_FILE> --key <PRIVATE_KEY_FILE> --namespace ingress-nginx

7. Create the administrator user account

• Navigate to the OneList URL in browser, you will be presented to following page to create the first user account. The System Administrator access is automatically granted to this user account.

• Log on using the email and password of the newly created user account to complete the application configuration steps.