cansupportme/seq-apikey-operator repository overview

⁠CanSupportMe.Operator.Seq

⁠Overview

⁠What is this?

This container is used as part of the Seq API Key Operator. It is used to create API keys in Seq and store them in Kubernetes secrets.

⁠Getting Started

⁠Installation

Create a simple values files called values.yaml and populate it as follows:

seq:
  serverUrl: "https://yourseq.instance.com"
  apiKey: ""

You'll need an API key with all permissions in Seq as well as the URL of your Seq instance.

helm upgrade --install -n seqapikey-system --create-namespace seqapikey-operator oci://registry-1.docker.io/cansupportme/seq-apikey-operator operator

⁠Example Seq API Key

The following manifest will ultimately create a Seq API key called AutoGen-default-apikey-for-product with an API which matches the value seqApiKey value in a secret called apikey-secret in the default namespace. This secret can be referenced in your application. The additional properties Application and Microservice will appear under "Attached properties" in the settings for the newly created API key in Seq.

apiVersion: seq.cansupport.me/v1alpha1
kind: SeqApiKey
metadata:
  name: apikey-for-product
  namespace: default
spec:
  secretName: apikey-secret
  additionalProperties:
    - name: Application
      value: my-product-name
    - name: Microservice
      value: my-microservice

⁠Expected Behaviours

• Deleting the generated secret (apikey-secret) will generate a new API key and store this in a new secret and update Seq with the new API key. Note that this will quickly delete then recreate the API key in Seq as token updating isn't permitted.
• Updating additional properties will automatically update equivalent properties in Seq
• Deleting the SeqApiKey object will also delete the Kubernetes secret and API within Seq
• Restarting the service will automatically recreate any missing API keys within Seq

⁠Kubernetes Operator

This operator is based on the CanSupportMe.Operator package⁠ which is a package designed for building simple Kubernetes operators.