Utho Application Operator

Table of Contents

• Install the controller
• Examples
• Build
• How it Works
• Versioning
• Utho Application CRD Reference
  • Utho Application Spec
  • Load Balancer Spec
  • Target Group Spec
  • Frontend Spec
  • ACL Spec
• Utho DNS CRD Reference
  • Utho DNS Spec
  • DNS Record Spec

Utho Application Operator is a Kubernetes Operator that is used to manage various resources required by your Kubernetes Based Application like Load Balancer, etc.

With this Operator, you can do the following:

• Create a CRD called UthoApplication and provide networking parameters.
• Manage your resources from the CRD
• Hassle Free Netwokr Resource Provisioning.

Install the controller

Prerequisites

• You need to have Helm CLI installed on your machine.
• You must have an Utho API Key.

Install the Cloud Controller Helm Chart

To install the chart with the release name utho-app-operator:

Add the Utho Operator Repository to your Helm repositories:

helm repo add utho-operator https://uthoplatforms.github.io/utho-app-operator-helm/

helm repo update

Install the Utho Operator Chart:

Note: make sure to set the Utho API Key

helm install <release_name> utho-operator/utho-app-operator-chart --set API_KEY=<YOUR_API_KEY> -n <namespace> --create-namespace

Example:

helm install utho-app-operator utho-operator/utho-app-operator-chart --set API_KEY=################## -n dev --create-namespace

Examples

Here are some complete examples of an application leveraging utho-cloud-controller-manager:

• Network Load balancer
• Applicaton Load balancer

Build the operator

Prerequisites

In order to build the operator you'll have to have Go installed on your machine. In order to do so, follow the instructions on its website.

Build process

Building the operator should be as simple as running:

make build

This Makefile target will take care of everything from generating client side code, generating Kubernetes manifests, downloading the dependencies and the tools used in the build process and finally, it will build the binary.

After this step has finished successfully you should see the operator's binary bin/manager.

You can also run it directly via make run which will run the operator on your machine against the cluster that you have configured via your KUBECONFIG.

How it works

Utho Application Controller provides a UthoApplication CRD to specify the deployment of network resources like Utho LB, Utho TG, etc. Here is an example of UthoApplication.

ALB Example

apiVersion: apps.utho.com/v1alpha1
kind: UthoApplication
metadata:
  name: my-application
  namespace: <namespace>
spec:
  loadBalancer:
    aclRule:
      - name: test-rule
        conditionType: url_path
        value:
          type: url_path
          data:
            - "/"
            - "/path"
    frontend:
      name: test-fe-3
      algorithm: roundrobin
      protocol: http
      port: 81
    type: application
    dcslug: innoida
    name: test-lb
  targetGroups:
    - health_check_timeout: 5
      health_check_interval: 30
      health_check_path: /
      health_check_protocol: TCP
      healthy_threshold: 2
      name: test-tg-blaa
      protocol: HTTP
      unhealthy_threshold: 3
      port: 30002
    - health_check_timeout: 5
      health_check_interval: 30
      health_check_path: /
      health_check_protocol: TCP
      healthy_threshold: 2
      name: test-tg-2
      protocol: HTTP
      unhealthy_threshold: 4
      port: 30002

NLB example

apiVersion: apps.utho.com/v1alpha1
kind: UthoApplication
metadata:
  name: test-app-nlb
spec:
  loadBalancer:
    backendPort: 30080
    frontend:
      name: test-fe
      algorithm: roundrobin
      protocol: tcp
      port: 80
    type: network
    dcslug: innoida
    name: test-lb

DNS Example

apiVersion: apps.utho.com/v1alpha1
kind: UthoDNS
metadata:
  name: my-dns
  namespace: <namespace>
spec:
  domain: "example.com"
  records:
    - hostname: "www"
      type: "A"
      ttl: 300
      value: "192.0.2.1"
    - hostname: "mail"
      type: "MX"
      ttl: 300
      value: "mail.example.com"
      priority: 10

You can choose to apply the CRD in any namespace that you want. However, we recommend to create a separate namespace so that you can track all of your CRs easily.

Versioning

As of now, this operator is still in developmental state. This is the v1alpha1 version. In case, you face a problem/bug, please raise an issue in Github.

UthoApplication CRD Reference

UthoApplicationSpec

Defines the desired state of the UthoApplication.

FIELD	DESCRIPTION
apiVersion	apps.utho.com/v1alpha1
kind	UthoApplication
metadata	Refer to Kubernetes API documentation for fields of metadata.
spec	UthoApplicationSpec

UthoApplicationSpec

Specifies the UthoApplication configuration.

FIELD	DESCRIPTION
loadBalancer	LoadBalancer
targetGroups	[]TargetGroup

LoadBalancer

Specifies the load balancer configuration.

FIELD	DESCRIPTION	EXAMPLE VALUES
frontend	Frontend, optional
type	string, default: application	application
dcslug	string	innoida
name	string	my-lb
aclRule	[]ACLRule, optional

Available DCSlug are as innoida,inmumbaizone2,inbangalore,defra1,uslosangeles

Frontend

Specifies the frontend configuration.

FIELD	DESCRIPTION	EXAMPLE VALUES
name	string	test-fe
algorithm	string	roundrobin or leastconn
protocol	string	http or https
port	int64	80 or 443
certificateName	string, optional	test-name
redirectHttps	bool, optional	0 for no, 1 for yes
cookie	bool, optional	0 for no, 1 for yes

ACLRule

Specifies an ACL rule.

FIELD	DESCRIPTION	EXAMPLE VALUES
name	string	test-rule
conditionType	string	http_user_agent, http_referer, url_path, http_method, query_string, http_header
value	ACLData

ACLData

Specifies the ACL data.

FIELD	DESCRIPTION	EXAMPLE VALUES
type	string	http_user_agent, http_referer, url_path, http_method, query_string, http_header
data	[]string	/

TargetGroup

Specifies a target group configuration.

FIELD	DESCRIPTION	EXAMPLE VALUES
name	string	test-tg
protocol	string	HTTP, TCP, HTTPS, UDP
health_check_path	string	/healthz
health_check_protocol	string	HTTP, TCP, HTTPS, UDP
health_check_interval	int64	30
health_check_timeout	int64	5
healthy_threshold	int64	3
unhealthy_threshold	int64	2
port	int64	80

Utho DNS CRD Reference

UthoDNS

Defines the desired state of the UthoDNS.

FIELD	DESCRIPTION
apiVersion	apps.utho.com/v1alpha1
kind	UthoDNS
metadata	Refer to Kubernetes API documentation for fields of metadata.
spec	UthoDNSSpec

UthoDNSSpec

Specifies the UthoDNS configuration.

FIELD	DESCRIPTION
dnsRecords	[]DNSRecord
domain	string

DNSRecord

Specifies a DNS record configuration.

FIELD	DESCRIPTION	EXAMPLE VALUES
hostname	string	test
type	string	A, CNAME, MX, TXT
ttl	int64	300
value	string	1.1.1.1
priority	int64, optional	10
port	int64, optional	80
weight	int64, optional	10
portType	string, optional