{"id":18299676,"url":"https://github.com/containersolutions/redis-cluster-operator","last_synced_at":"2025-04-05T13:35:10.173Z","repository":{"id":38452047,"uuid":"488547830","full_name":"ContainerSolutions/redis-cluster-operator","owner":"ContainerSolutions","description":"A Kubernetes Operator for running Production Redis Clusters","archived":false,"fork":false,"pushed_at":"2022-07-31T10:16:29.000Z","size":294,"stargazers_count":7,"open_issues_count":8,"forks_count":3,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-21T05:11:29.576Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/ContainerSolutions.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-05-04T10:40:32.000Z","updated_at":"2024-10-10T21:33:56.000Z","dependencies_parsed_at":"2022-08-19T06:00:33.330Z","dependency_job_id":null,"html_url":"https://github.com/ContainerSolutions/redis-cluster-operator","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ContainerSolutions%2Fredis-cluster-operator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ContainerSolutions%2Fredis-cluster-operator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ContainerSolutions%2Fredis-cluster-operator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ContainerSolutions%2Fredis-cluster-operator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ContainerSolutions","download_url":"https://codeload.github.com/ContainerSolutions/redis-cluster-operator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247342633,"owners_count":20923631,"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":[],"created_at":"2024-11-05T15:09:50.376Z","updated_at":"2025-04-05T13:35:09.827Z","avatar_url":"https://github.com/ContainerSolutions.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Redis Cluster Operator\n\nThe Redis Cluster Operator runs Redis Clusters on Kubernetes.\n\nWe've found many operators which either use the redis-cli directly, which makes it hard to customise\nbehaviour, or do not support a full productionised suite of features.\n\nThe aim for this operator is to run productionised clusters with most necessary features, \nas well as providing additions such as RunBooks to help debug issues with Redis Clusters \nwhen running them with this Operator, and ready-made load tests to test your Redis Clusters with real traffic.\n\n* [Features](#features-this-operator-supports)\n* [Installing The Operator](#installing-the-operator)\n  * [Bundled Cluster Wide](#bundled-cluster-wide)\n  * [Bundled Namespaced](#bundled-namespaced)\n  * [OLM bundle](#olm-bundle)\n* [Creating your first Redis Cluster](#creating-your-first-redis-cluster)\n* [Documentation](./docs/home.md)\n* [Contributing](./CONTRIBUTING.md)\n\n## Features this operator supports\n- [x] Cluster Creation\n- [ ] Cluster Management\n- [x] Support for replicated clusters (Master-Replica splits)\n- [ ] 0 Downtime scaling\n- [ ] 0 Downtime upgrades\n- [ ] Persistent clusters (Supported through Kubernetes PVC management)\n- [ ] Backup \u0026 Restore capability for persistent clusters\n- [ ] Documentation on observability for clusters\n- [ ] Runbooks for common debugging issues and resolutions\n- [ ] Ready-made k6s load tests to load Redis Clusters\n\n## Installing the Operator\n\n### bundled cluster-wide\n\nThe operator gets bundled for every release together with all of it's crds, rbac, and deployment.\n\nThe origin bundle works in cluster mode, and will manage all RedisClusters created in all namespaces. \n\nTo install or upgrade the operator \n```shell\nkubectl apply -f https://github.com/ContainerSolutions/redis-cluster-operator/releases/latest/download/bundle.yml\n```\n\nThis will install the Operator in a new namespace `redis-cluster-operator`. \n\nYou can also [install the operator in a custom namespace](./docs/installing-in-a-custom-namespace.md).\n\n### bundled namespaced\n\nThe operator currently works in cluster-wide mode, but the Operator will support namespaced mode in the future.\n\nWe know it's quite important for redundancy, reducing single-point of failures, \nas well as tenanted models, or excluding namespaces from the operator.\n\nThe Operator will support Namespaced mode in the future.\n\n### OLM bundle\n\n\u003e OLM bundling support is a work in progress. \n\u003e There are remnants of OLM due to the initial Operator SDK installation, \n\u003e but we have not specifically tested and looked at it in depth.\n\n## Creating your first Redis Cluster\n\nTo create your first Redis cluster, you'll need a CRD.\n\n```yaml\napiVersion: cache.container-solutions.com/v1alpha1\nkind: RedisCluster\nmetadata:\n  name: rediscluster-product-api\nspec:\n  masters: 3\n  replicasPerMaster: 1\n```\n\nOnce applied, the Operator will create all the necessary nodes, and set up the cluster ready for use.\n\nRemember to check out the [documentation](./docs/home.md) page for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcontainersolutions%2Fredis-cluster-operator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcontainersolutions%2Fredis-cluster-operator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcontainersolutions%2Fredis-cluster-operator/lists"}