Skip to content
This repository has been archived by the owner on Mar 19, 2020. It is now read-only.

Latest commit

 

History

History
102 lines (59 loc) · 5.87 KB

README.md

File metadata and controls

102 lines (59 loc) · 5.87 KB
Raw

sye eks

The sye eks commands will create and manage Amazon EKS Kubernetes clusters suitable for running Sye.

It should be noted that the sye eks command does not install Sye itself, it only creates an Kubernetes cluster suitable for running Sye on. Sye has to be installed afterwards using Helm. For instruction on how to configure and install Sye using Helm in Kubernetes, please reference the Sye Live OTT Kubernetes Installation Guide.

EKS Cluster Settings

Sye has specific requirements on the Kubernetes cluster it will run on, which are implemented by the sye eks command. The requirements are:

Enhanced Networking

Sye needs high performance networking to be able to perform well. To ensure good network performance the the virtual machines must be configured with enhanced networking using single root I/O virtualization (SR-IOV). For a list of supported instance types see Enhanced Networking on Linux

Public IPv4 Addresses

The streaming traffic from the egress pitchers is emitted directly from the worker nodes running the pitchers. The pitchers are running with host networking and to be able to stream they need to have public IPv4 addresses to be assigned to the primary NIC of each worker node.

Firewall Reconfiguration

The SSP (Sye Streaming Protocol) traffic needs to be able to flow in both direction from and to the egress pitchers (and possibly also to ingress or fan-out pitchers if external SSP sources are being used). In addition the connect broker needs the TCP port 2505 to be open for incoming traffic.

sye eks cluster-create automatically opens UDP port 2123 to 2130 and 2505 towards all worker nodes for this purpose.

Ingress

Sye needs an ingress for inbound HTTPS traffic into the cluster. For this the nginx-ingress ingress controller can be used, see NGINX Ingress Controller to learn more how it works.

sye eks cluster-create automatically installs the nginx-ingress into the kube-system namespace.

Tiller (Helm)

The server side component of Helm, Tiller, is automatically installed by the sye eks cluster-create command. A service-account and RBAC roles are provided as well.

DNS configuration

The ingress maps requests to different DNS names to different parts of the Sye system. For this to work the requests must be made towards the proper URLs which in turn has to be configured in the DNS. This is not done by the sye eks commands, and needs to be managed elsewhere.

Worker node Cloudformation template

The sye eks command uses a slightly modified version of the default Cloudformation template for the EKS worker nodes. The following changes have been made to the template:

  • Allow streaming SSP traffic over UDP by opening up the UDP port 2123 to 2130 on all worker nodes.
  • Allow connect broker traffic to the cluster the TCP port 2505 on all worker nodes.
  • Add IAM policy for performing automatic discovery of auto scaling groups.

Amazon EKS Prerequisites

IAM role

Before using sye eks to create an Amazon EKS cluster an IAM role that Kubernetes cluster can assume needs to be created. This only needs to be done one time and can be used for multiple EKS clusters.

Follow the Getting Started with Amazon EKS to create an Amazon EKS Service Role, such as eksServiceRole.

kubectl for Amazon EKS

The sye eks command uses kubectl to setup the Kubernetes cluster after being created. This command needs to be installed together with the aws-iam-authenticator. They can be installed by following the To install aws-iam-authenticator for Amazon EKS section in the Getting Started with Amazon EKS guide.

Usage Examples

Create an EKS cluster

To create an EKS cluster named my-cluster in a region that has been prepared do:

sye eks cluster-create --role-name eksServiceRole --region us-west-2 \
	--name sye-eks --release 1.10 --instance-type m5.4xlarge \
	--ami ami-0a54c984b9f908c81 --count 5 --kubeconfig ~/.kube/my-cluster.yaml \
	--ssh-key my-keypair

This will create a cluster with 5 worker nodes and will run kubernetes 1.10. Credentials for kubectl will be stored in ~/.kube/my-cluster.yaml (this file will be overwritten if it already exist).

After running sye eks cluster-create a values file for the Cluster Autoscaler Helm chart called autoscaler.yaml is created in the current directory. The cluster-autoscaler can then be installed using this command:

helm upgrade --kubeconfig ${kubeconfig} --install --namespace kube-system autoscaler stable/cluster-autoscaler --version 0.12.1 -f ${valuesFile}`

Use the recommended Cluster Autoscaler version with the intended Kubernetes master version, see Releases.

Delete an EKS cluster

A requirement before deleting an Amazon Eks cluster is that all active services associated with a load balancer have been manually deleted. Otherwise the VPC might be stuck with orphaned resources preventing the Cloudformation stack from being removed, see Deleting a Cluster for more information.

The following command deletes an EKS cluster that has been previously created with sye eks cluster-create:

sye eks cluster-delete --region us-west-2 --name sye-eks

Post Install Actions

Register DNS entries

The DNS names of the Sye frontends as well as the Sye management UI needs to be registered in a DNS server. The address that the DNS entries should point to is given by:

kubectl get service -l app=nginx-ingress --namespace kube-system