The RingLink Kubernetes Operator allows you to expose services running in your cluster to your RingLink network.

The Ringlink Operator is conflicted with RingLink Kubernetes Load Balancer integration at now.

Setting Up the Kubernetes Operator

Prerequisites

A running Kubernetes cluster
A Config Key generated from the RingLink dashboard

Installation

By default, the operator installs into a namespace named ringlink.

To install the latest version of the RingLink Kubernetes Operator:

Add https://charts.ring.link to your helm repositories:

helm repo add ringlink https://charts.ring.link

Update helm repositories cache:

helm repo update

Install the operator:

helm upgrade --install\
    ringlink-operator \
    ringlink/ringlink-operator \
    --namespace ringlink \
    --create-namespace \
    --wait

(Optional) Create a `RingLinkConfiguration`

The operator uses a StatefulSet to run a RingLink device as a Pod in your cluster. To authorize the device, you'll need to create a RingLinkConfiguration.

Step 1: Create a Secret

First, create a Kubernetes Secret containing your config key. This must be created in the namespace where your operator installed, e.g. ringlink:

apiVersion: v1
kind: Secret
metadata:
  name: ringlink-token
  namespace: ringlink
data:
  token: <base64 encoded config key>

You can also create secret directly via kubectl:

kubectl -n ringlink create secret generic ringlink-token \
    --from-literal=token=<plain config key>

Step 2: Define the Configuration

Then, create a RingLinkConfiguration and mark it as the default:

apiVersion: ring.link/v1
kind: RingLinkConfiguration
metadata:
  annotations:
    networking.ring.link/default: "true"
  name: ringlink-sample
spec:
  network: 53cd98d2
  secretName: ringlink-token

Set .spec.network to your RingLink network ID. If you don't have one yet, you can create it in the dashboard.

Kubernetes Operator