gel-plugin-operator

GelOps

K8s Operator for Grafana Enterprise Logs plugin

Description

Operator for tenant management and LBAC creation.

For more information about Grafana Enterprise Logs visit GEL

Note: This Operator currently developed on GEL version 1.7.2

Getting Started

You’ll need a Kubernetes cluster to run against. You can use KIND to get a local cluster for testing, or run against a remote cluster. Note: Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster kubectl cluster-info shows).

1. Create a Tenant

apiVersion: loki.gelops.com/v1alpha1
kind: GrafanaEnterpriseLogsTenant
metadata:
  name: lintechso-tenant
spec:
  tenantInfo:
    name: "lintechso"
    displayName: "LinTechSo"
    clusterName: "loki"

result:

1. Create a LBAC

apiVersion: loki.gelops.com/v1alpha1
kind: GrafanaEnterpriseLogsAccessPolicy
metadata:
  name: lintechso-access-policy
spec:
  tenantInfoRef: 
    tenantName: "lintechso"
    clusterName: "loki"
    accessPolicies:
      -  "logs:read"
      -  "logs:write"
    labelSelectors:
      - '{foo="bar"}'
      - '{name="hello"}'

result:

1. Create a Token

apiVersion: loki.gelops.com/v1alpha1
kind: GrafanaEnterpriseLogsToken
metadata:
  name: lintechso-token
spec:
  accessPolicyRef: 
    name: "lintechso-access-policy"
  expirationTime: "2025-03-01T17:37:59.341728283Z"

result:

$kubctl get secrets/lintechso-token -o yaml

apiVersion: v1
data:
  token: xxxxxxxxx
kind: Secret
metadata:
  name: lintechso-token
type: Opaque

Running on the cluster

1. Checkout the deployment env

export Loki_Endpoint_Api_Version=v3
export Loki_Endpoint_Address="http://loki.com"
export Loki_Admin_Api_Token="X"

1. Install Instances of Custom Resources:

kubectl apply -f config/samples/

1. Build and push your image to the location specified by IMG:

make docker-build docker-push IMG=<some-registry>/gel:tag

1. Deploy the controller to the cluster with the image specified by IMG:

make deploy IMG=<some-registry>/gel:tag

Uninstall CRDs

To delete the CRDs from the cluster:

make uninstall

Undeploy controller

UnDeploy the controller from the cluster:

make undeploy

Contributing

How it works

This project aims to follow the Kubernetes Operator pattern.

It uses Controllers, which provide a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster.

Test It Out

1. Add Loki Endpoint credentials as an ENV

export Loki_Endpoint_Api_Version=v3
export Loki_Endpoint_Address="http://loki.com"
export Loki_Admin_Api_Token="X"

1. Install the CRDs into the cluster:

make install

1. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):

make run

NOTE: You can also run this in one step by running: make install run

Modifying the API definitions

If you are editing the API definitions, generate the manifests such as CRs or CRDs using:

make manifests

NOTE: Run make --help for more information on all potential make targets

More information can be found via the Kubebuilder Documentation

License

Copyright 2023.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.