{"id":25980121,"url":"https://github.com/ot-container-kit/logging-operator","last_synced_at":"2025-03-05T07:33:40.252Z","repository":{"id":38204920,"uuid":"288245828","full_name":"OT-CONTAINER-KIT/logging-operator","owner":"OT-CONTAINER-KIT","description":"A golang based operator to create and manage EFK (Elasticsearch, Fluentd, and Kibana) stack on Kubernetes","archived":false,"fork":false,"pushed_at":"2022-10-06T08:09:24.000Z","size":15648,"stargazers_count":42,"open_issues_count":5,"forks_count":11,"subscribers_count":3,"default_branch":"master","last_synced_at":"2023-03-06T13:36:55.856Z","etag":null,"topics":["cloud-native","efk","elasticsearch","fluentd","hacktoberfest","kibana","kubernetes","openshift","operator","operatorhub","opstreesolutions"],"latest_commit_sha":null,"homepage":"https://ot-logging-operator.netlify.app/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OT-CONTAINER-KIT.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null}},"created_at":"2020-08-17T17:39:22.000Z","updated_at":"2022-10-15T12:50:47.000Z","dependencies_parsed_at":"2023-01-19T09:45:47.773Z","dependency_job_id":null,"html_url":"https://github.com/OT-CONTAINER-KIT/logging-operator","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OT-CONTAINER-KIT%2Flogging-operator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OT-CONTAINER-KIT%2Flogging-operator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OT-CONTAINER-KIT%2Flogging-operator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OT-CONTAINER-KIT%2Flogging-operator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OT-CONTAINER-KIT","download_url":"https://codeload.github.com/OT-CONTAINER-KIT/logging-operator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241989365,"owners_count":20053796,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloud-native","efk","elasticsearch","fluentd","hacktoberfest","kibana","kubernetes","openshift","operator","operatorhub","opstreesolutions"],"created_at":"2025-03-05T07:33:39.439Z","updated_at":"2025-03-05T07:33:40.237Z","avatar_url":"https://github.com/OT-CONTAINER-KIT.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./static/logging-operator-logo.svg\" height=\"220\" width=\"220\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://dev.azure.com/opstreedevops/DevOps/_build/latest?definitionId=8\u0026repoName=OT-CONTAINER-KIT%logging-operator\u0026branchName=master\"\u003e\n    \u003cimg src=\"https://dev.azure.com/opstreedevops/DevOps/_apis/build/status/logging-operator?repoName=OT-CONTAINER-KIT%logging-operator\u0026branchName=master\" alt=\"Azure Pipelines\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://goreportcard.com/report/github.com/OT-CONTAINER-KIT/logging-operator\"\u003e\n    \u003cimg src=\"https://goreportcard.com/badge/github.com/OT-CONTAINER-KIT/logging-operator\" alt=\"GoReportCard\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"http://golang.org\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/go-mod/go-version/OT-CONTAINER-KIT/logging-operator\" alt=\"GitHub go.mod Go version (subdirectory of monorepo)\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://quay.io/repository/opstree/logging-operator\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/container-ready-green\" alt=\"Docker\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/OT-CONTAINER-KIT/logging-operator/master/LICENSE\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/License-Apache%202.0-blue.svg\" alt=\"License\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\nLogging Operator is an operator created in Golang to set up and manage EFK(Elasticsearch, Fluentd, and Kibana) cluster inside Kubernetes and Openshift environment. This operator is capable of setting up each individual component of EFK cluster separately.\n\nFor documentation, please refer to [https://ot-logging-operator.netlify.app/](https://ot-logging-operator.netlify.app/)\n\n## Architecture\n\nArchitecture of logging operator looks like this:-\n\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"./static/logging-operator-arc.png\"\u003e\n\u003c/div\u003e\n\n## Purpose\n\nThe aim and purpose of creating this Logging Operator to provide an easy and extensible interface to setting up logging stack such as EFK(Elasticsearch, Fluentd, and Kibana). It helps in setting up different nodes of elasticsearch cluster, fluentd as a log shipper and kibana for visualization.\n\n## Supported Features\n\n- Setup of elasticsearch cluster with different nodes type:- master, data, ingestion, and client.\n- Customizable configuration for elasticsearch, fluentd stack.\n- Setup of fluentd as light-weight log-shipper as Daemonset.\n- Kibana will be set up as visualization tool for elastic stack.\n- Seamless upgrades of elasticsearch, fluentd, and kibana.\n- Security best practices support for complete stack such as TLS, elastic security.\n- Kubernetes resources objects support like:- resources, securityContext, affinity, tolerations, etc.\n\n## Prerequisites\n\nLogging Operator requires a Kubernetes cluster of version `\u003e=1.16.0`. If you have just started with the CRD and Operators, it is highly recommended using the latest version of Kubernetes cluster.\n\n## Getting Started\n\nIf you want to start using the logging-operator in a quickstart mode, you can begin with the [documentation](https://ot-logging-operator.netlify.app/). It will help you and guide you through the setup of Elasticsearch, Fluentd, and Kibana  step-by-step.\n\nThe configuration for EFK (Elasticsearch, Fluentd, Kibana) set up is defined inside the CRD manifests. But all the examples manifests can be found in the [example](./examples) directory.\n\n## Quickstart\n\n### Logging Operator Setup\n\nThe setup can be done by using helm. The logging-operator can easily get installed using helm commands.\n\n```shell\n# Add the helm chart\n$ helm repo add ot-helm https://ot-container-kit.github.io/helm-charts/\n...\n\"ot-helm\" has been added to your repositories\n```\n\n```shell\n# Deploy the Logging Operator\n$ helm upgrade logging-operator ot-helm/logging-operator \\\n  --install --namespace ot-operators\n...\nRelease \"logging-operator\" does not exist. Installing it now.\nNAME: logging-operator\nLAST DEPLOYED: Sun May 29 01:06:58 2022\nNAMESPACE: ot-operators\nSTATUS: deployed\nREVISION: 1\n```\n\nAfter the deployment, verify the installation of operator.\n\n```shell\n# Testing Operator\n$ helm test logging-operator --namespace ot-operators\n...\nNAME:           logging-operator\nLAST DEPLOYED:  Sun May 29 01:06:58 2022\nNAMESPACE:      ot-operators\nSTATUS:         deployed\nREVISION:       1\nTEST SUITE:     logging-operator-test-connection\nLast Started:   Sun May 29 01:07:56 2022\nLast Completed: Sun May 29 01:08:02 2022\nPhase:          Succeeded\n```\n\n## Upcoming Features\n\n- Plugins support for elasticsearch and kibana\n- Plugins support for fluentd\n- Index template support in operator\n- Index lifecycle support in operator\n\n## Contact\n\nThis project is managed by [OpsTree Solutions](https://opstree.com/). If you have any queries or suggestions, mail us at [opensource@opstree.com](mailto:opensource@opstree.com).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fot-container-kit%2Flogging-operator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fot-container-kit%2Flogging-operator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fot-container-kit%2Flogging-operator/lists"}