Getting Started

# You need to perform this task as root
curl -L https://bootstrap.grlx.dev/latest/farmer | bash

You’ll be asked several questions about the interface to listen on, which ports to use, etc. For the quick start, it’s recommended to use the default ports (TCP 5405-5406). You’ll be prompted for an admin public key, which you should have gotten from the prior step, and a certificate host name(s). Make sure the certificate host name matches the external-facing interface (a domain or IP address) as it will be used for TLS validation!

Copy the resource YAML below. Replace PASTE_YOUR_PUBLIC_KEY_HERE with your admin public key, and PASTE_YOUR_FARMERINTERFACE_HERE with the domain name or IP address of the farmer.

Deploy the farmer, e.g. kubectl apply -f grlx-farmer.yaml. This will deploy a single farmer to which you can add many external sprouts.

apiVersion: v1
kind: Service
metadata:
  name: grlx-farmer-np
spec:
  type: NodePort
  ports:
    - name: api
      port: 5405
      nodePort: 30405
    - name: bus
      port: 5406
      nodePort: 30406
  selector:
    statefulset.kubernetes.io/pod-name: grlx-farmer-0
---
apiVersion: apps/v1
kind: StatefulSet
metadata:
  name: grlx-farmer
spec:
  selector:
    matchLabels:
      app: grlx
      role: farmer
  serviceName: grlx-farmer
  replicas: 1
  template:
    metadata:
      labels:
        app: grlx
        role: farmer
    spec:
      containers:
        - name: main
          image: grlx/farmer:latest
          env:
            - name: ADMIN_PUBKEYS
              value: "PASTE_YOUR_PUBLIC_KEY_HERE"
            - name: CERT_HOSTS
              value: "localhost,PASTE_YOUR_FARMERINTERFACE_HERE"
            - name: FARMERINTERFACE
              value: "0.0.0.0" # do not modify
            - name: FARMERORGANIZATION
              value: "Your Organization" # change to your org name
          ports:
            - name: api
              containerPort: 5405
            - name: bus
              containerPort: 5406
          volumeMounts:
            - name: cache
              mountPath: /var/cache/grlx
            - name: config
              mountPath: /etc/grlx
            - name: data
              mountPath: /srv/grlx
      volumes:
        - name: cache
          emptyDir: {}
        - name: config
          hostPath:
            path: /etc/grlx
            type: DirectoryOrCreate
        - name: data
          hostPath:
            path: /srv/grlx
            type: DirectoryOrCreate

Copy the Docker Compose YAML below. Replace PASTE_YOUR_PUBLIC_KEY_HERE with your admin public key, then docker compose up to fire up an all-in-one farmer/sprout environment.

version: "3"
services:
  farmer:
    container_name: farmer
    image: grlx/farmer:latest
    hostname: farmer
    environment:
      - ADMIN_PUBKEYS=PASTE_YOUR_PUBLIC_KEY_HERE
      - CERT_HOSTS=localhost,farmer
      - FARMERINTERFACE=0.0.0.0
    volumes:
      - ./local/farmer:/etc/grlx
      # This is where the farmer whill store its recipes
      - ./local/data:/srv/grlx
    ports:
      - "5405:5405"
      - "5406:5406"
  sprout: # for testing grlx features only, not for production
    container_name: sprout
    image: grlx/sprout:latest
    hostname: sprout
    volumes:
      - ./local/sprout:/etc/grlx
    environment:
      - FARMERINTERFACE=farmer