{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Prerequisites","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Install Kubernetes CLI tool - kubectl. Instructions can be found here: ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://kubernetes.io/docs/tasks/tools/install-kubectl/"}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Install the AWS CLI version 2:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"inlineCard","attrs":{"url":"https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html"}}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Install Helm package manager","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"inlineCard","attrs":{"url":"https://helm.sh/docs/intro/install/"}}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"SQL Server connection string.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The SQL user account specified in the connection string must have the db_owner role of the databases so it can create or change tables.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Request the container registry login from IQX for pulling OneList images;","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"SMTP server login and sender email address. A full mailbox is required if email approval channel is enabled;","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Generate the Machine Key for each environment. This is a Base64 string representing an array of ","type":"text"},{"text":"50","type":"text","marks":[{"type":"strong"}]},{"text":" bytes.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Use tools like ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://generate.plus/en/base64"}},{"text":" to generate a random string of the required length.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Define the Kubernetes namespace for the OneList environment to be deployed. E.g. onelist-dev, onelist-qa, onelist-prod. It may be required to follow your company's naming standard for these namespaces.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Use this value to replace the ","type":"text"},{"text":" ","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":"placeholder in the instructions below.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Define the label for the OneList environment to be deployed. This is a short label, e.g. dev, qa, prod. The first letter must be unique in all the environments planned and it is used as the suffix of the database names.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Use this value to replace the ","type":"text"},{"text":" ","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":"placeholder in the instructions below.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Request a Public Certificate using ACM","type":"text","marks":[{"type":"link","attrs":{"href":"https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html"}}]},{"text":" or ","type":"text"},{"text":"Import a Certificate into ACM","type":"text","marks":[{"type":"link","attrs":{"href":"https://docs.aws.amazon.com/acm/latest/userguide/import-certificate-api-cli.html"}}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Download the below two files and put them in the same directory.","type":"text"}]}]}]},{"type":"mediaGroup","content":[{"type":"media","attrs":{"id":"85dddc4d-9e0d-4424-b0e9-b5732e24c7f3","collection":"contentId-835747847","type":"file"}},{"type":"media","attrs":{"id":"7963118d-c640-45e8-ae09-8988b7bba2c0","collection":"contentId-835747847","type":"file"}}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Recommended Configuration","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"3fe87009-a810-4d21-8775-6a55f70a44c5"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Environments","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"EKS","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"SQL","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Production","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Worker node: EC2 T3.large, 2 vCPU, 16 GiB RAM","type":"text"}]},{"type":"paragraph","content":[{"text":"Worker node count: 3;","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Amazon RDS for SQL Server","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"collation: SQL_Latin1_General_CP1_CI_AS","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"size: Standard instance, db.t4.large","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Databases: ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"OneList_p","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"RoleManager_p","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Comms_p","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Non-production","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Worker node: EC2 T3.large, 2 vCPU, 16 GiB RAM","type":"text"}]},{"type":"paragraph","content":[{"text":"Worker node count: 3;","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Amazon RDS for SQL Server","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"collation: SQL_Latin1_General_CP1_CI_AS","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"size: Standard instance, db.t4.large","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Databases: the \"x\" represents the environment tag, e.g. d for Development, q for QA.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"OneList_x","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"RoleManager_x","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Comms_x","type":"text"}]}]}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Connect to EKS cluster","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Configure your AWS CLI credential if it is not yet configured. ","type":"text"},{"type":"hardBreak"},{"text":"Run command below and","type":"text"},{"text":" ","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":"input information prompted. ","type":"text"},{"type":"hardBreak"},{"text":"aws configure","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"type":"hardBreak"},{"text":"For more information, see ","type":"text"},{"text":"Configuring the AWS CLI","type":"text","marks":[{"type":"link","attrs":{"href":"https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html"}}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set context to the EKS cluster. Run the command below.","type":"text"},{"type":"hardBreak"},{"text":"aws eks --region update-kubeconfig --name ","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Deployment steps","type":"text"}]},{"type":"paragraph","content":[{"text":"Open a command prompt from the folder that contains the YAML deployment files. Flow steps below to deploy OneList.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"1. Create the Kubernetes namespace","type":"text"}]},{"type":"paragraph","content":[{"text":"Run the command below to create the Kubernetes namespace for the OneList environment, e.g. onelist-dev.","type":"text"}]},{"type":"paragraph","content":[{"text":"kubectl create namespace ","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"For example: ","type":"text"}]},{"type":"paragraph","content":[{"text":"kubectl create namespace onelist-dev","type":"text","marks":[{"type":"em"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"2. Create ConfigMap and Secret","type":"text"}]},{"type":"paragraph","content":[{"text":"The values.yaml file configures the required environment variables that are used by OneList services.","type":"text"}]},{"type":"paragraph","content":[{"text":"Open the \"values.yaml\" in notepad and update the following fields with the actual value. ","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Config","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"RoleManager__MachineKey ","type":"text"},{"type":"hardBreak"},{"text":"The value is the generated machine key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Database__ConnectionString ","type":"text"},{"type":"hardBreak"},{"text":"The value is the SQL Server connection string. The name of the databases will be automatically specified by the services.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ASPNETCORE_ENVIRONMENT","type":"text"},{"type":"hardBreak"},{"text":"The value is ","type":"text"},{"text":"","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Smtp__UserName ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Smtp__Password","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Smtp__From ","type":"text"},{"type":"hardBreak"},{"text":"This is the sender email address of notifications from OneList","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Smtp__Host","type":"text"},{"type":"hardBreak"},{"text":"This is the SMTP server OneList use to send notifications.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Smtp__Port","type":"text"},{"type":"hardBreak"},{"text":"This is the port of SMTP server.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Smtp__UseSsl","type":"text"},{"type":"hardBreak"},{"text":"Define if SMTP server uses SSL connection. For Office365 SMTP service, the value is always false. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Localization__DefaultCulture","type":"text"},{"type":"hardBreak"},{"text":"The default culture. Use the code from: ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://iqxbusiness.atlassian.net/wiki/spaces/ONELIST70/pages/1698037783"}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Localization__DefaultTimeZone","type":"text"},{"type":"hardBreak"},{"text":"The default time zone. The time zone id is the “TZ database name” from this page: ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://en.wikipedia.org/wiki/List_of_tz_database_time_zones"}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"supportedCultures","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Localization__SupportedCultures__0","type":"text"},{"type":"hardBreak"},{"text":"The other supported cultures. Use the code from: ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://iqxbusiness.atlassian.net/wiki/spaces/ONELIST70/pages/1698037783"}},{"text":". When there is more than one supported culture, add another Localization__SupportedCultures__n entry and increase the trailing number n by 1. E.g. Localization__SupportedCultures__1","type":"text"}]}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"imageCredentials","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"username","type":"text"},{"type":"hardBreak"},{"text":"Login username of IQX container registry.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"password","type":"text"},{"type":"hardBreak"},{"text":"Login password of IQX container registry.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"email","type":"text"},{"type":"hardBreak"},{"text":"Your email address.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ingress","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"host ","type":"text"},{"type":"hardBreak"},{"text":"The DNS host name of the OneList application.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"alb.ingress.kubernetes.io/certificate-arn","type":"text","marks":[{"type":"link","attrs":{"href":"http://alb.ingress.kubernetes.io/certificate-arn"}}]},{"type":"hardBreak"},{"text":"ARN of the SSL certificate in ACM.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"alb.ingress.kubernetes.io/wafv2-acl-arn","type":"text","marks":[{"type":"link","attrs":{"href":"http://alb.ingress.kubernetes.io/wafv2-acl-arn"}}]},{"type":"hardBreak"},{"text":"ARN of the WAF ACL.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"persistentVolumeVolumeHandle","type":"text"},{"type":"hardBreak"},{"text":"EFS ID for supporting the EKS persistent volume. ","type":"text"},{"type":"hardBreak"},{"text":"The ID is in this format: ","type":"text"},{"text":"::","type":"text","marks":[{"type":"underline"},{"type":"strong"},{"type":"em"}]},{"type":"hardBreak"},{"text":"Example: fs-09b1fb3a7c9299901::fsap-07ab32df8345e6591","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"image","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"tag","type":"text"},{"type":"hardBreak"},{"text":"Tag name of the images that are going to be deployed.","type":"text"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Save the \"values.yaml\" file.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"3. Install the AWS Load Balancer Controller add-on (if not installed)","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Verify that if the controller is installed. Skip this section if already installed.","type":"text"}]},{"type":"codeBlock","content":[{"text":"kubectl get deployment -n kube-system aws-load-balancer-controller","type":"text"}]},{"type":"paragraph","content":[{"text":"If you see the following. The Controller is installed.","type":"text"}]},{"type":"codeBlock","content":[{"text":"NAME READY UP-TO-DATE AVAILABLE AGE\naws-load-balancer-controller 2/2 2 2 20h","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Follow this instruction to create a n OIDC provider for the cluster.","type":"text"},{"type":"hardBreak"},{"type":"inlineCard","attrs":{"url":"https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html"}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Skip this step if ","type":"text"},{"text":"AWSLoadBalancerControllerIAMPolicy ","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":"policy already exist. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Download an IAM policy file.","type":"text"},{"type":"hardBreak"},{"text":"https://raw.githubusercontent.com/kubernetes-sigs/aws-load-balancer-controller/v2.4.7/docs/install/iam_policy.json","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://raw.githubusercontent.com/kubernetes-sigs/aws-load-balancer-controller/v2.4.7/docs/install/iam_policy.json"}}]}]},{"type":"paragraph","content":[{"text":"Create an IAM policy using the policy downloaded in the previous step.","type":"text"}]},{"type":"codeBlock","content":[{"text":"aws iam create-policy \\\n --policy-name AWSLoadBalancerControllerIAMPolicy \\\n --policy-document file://iam_policy.json","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Check if role ","type":"text"},{"text":"AmazonEKSLoadBalancerControllerRole","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" already exists. If already exists, use another role name.","type":"text"}]},{"type":"paragraph","content":[{"text":"a. Create an IAM role. Replace ","type":"text"},{"text":"my-cluster","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" with the name of your cluster, ","type":"text"},{"text":"111122223333 ","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":"with your account ID, ","type":"text"},{"text":"AmazonEKSLoadBalancerControllerRole ","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":"with your role name and then run the command.","type":"text"}]},{"type":"codeBlock","content":[{"text":"eksctl create iamserviceaccount \\\n --cluster=my-cluster \\\n --namespace=kube-system \\\n --name=aws-load-balancer-controller \\\n --role-name AmazonEKSLoadBalancerControllerRole \\\n --attach-policy-arn=arn:aws:iam::111122223333:policy/AWSLoadBalancerControllerIAMPolicy \\\n --approve","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Install the AWS Load Balancer Controller using Helm. Replace ","type":"text"},{"text":"region-code","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":", ","type":"text"},{"text":"vpc-xxxxxxxx","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" and ","type":"text"},{"text":"my-cluster","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" with the correct value.","type":"text"}]},{"type":"codeBlock","content":[{"text":"helm repo add eks https://aws.github.io/eks-charts\nhelm repo update eks\nhelm install aws-load-balancer-controller eks/aws-load-balancer-controller \\\n -n kube-system \\\n --set clusterName=my-cluster \\\n --set serviceAccount.create=false \\\n --set serviceAccount.name=aws-load-balancer-controller \\\n --set region=region-code \\\n --set vpcId=vpc-xxxxxxxx","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"4. Deploy OneList Helm chart","type":"text"}]},{"type":"paragraph","content":[{"text":"Enter the folder that contains the values.yaml and onelist.tgz files. Run the command below.","type":"text"}]},{"type":"paragraph","content":[{"text":"helm install -n -f .\\values.yaml onelist.tgz","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"For example:","type":"text"}]},{"type":"paragraph","content":[{"text":"helm install onelist-dev -n onelist-dev -f .\\values.yaml onelist.tgz","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"5. Get the generated AWS public URL for OneList DNS configuration","type":"text"}]},{"type":"paragraph","content":[{"text":"Run the following command to discover the public URL of the environment for configuring the OneList DNS alias.","type":"text"}]},{"type":"paragraph","content":[{"text":"kubectl get ingress -n ","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"The AWS public URL is similar to this: ","type":"text"},{"text":"e6325261-onelist650-onelis-7461-1342161572.ap-southeast-2.elb.amazonaws.com","type":"text","marks":[{"type":"link","attrs":{"href":"http://e6325261-onelist650-onelis-7461-1342161572.ap-southeast-2.elb.amazonaws.com/"}}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"6. Create the administrator user account","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Navigate to the OneList URL in the browser, you will be presented to the following page to create the first user account. The System Administrator access is automatically granted to this user account.","type":"text"}]}]}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":25.0},"content":[{"type":"media","attrs":{"width":722,"id":"7d54d62c-69d5-45a3-b085-a80064bce793","collection":"contentId-835747847","type":"file","height":801}}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Log on using the email and password of the newly created user account to complete the application configuration steps.","type":"text"}]}]}]}],"version":1}

Browser not supported