{
  "schema_version": 2,
  "id": "operate/kubernetes/reference",
  "title": "Reference",
  "url": "https://redis.io/docs/latest/operate/kubernetes/reference/",
  "summary": "Resources to help you manage Redis Enterprise custom resources on Kubernetes.",
  "tags": [
    "docs",
    "operate",
    "kubernetes"
  ],
  "last_updated": "2026-09-28T15:03:12+01:00",
  "children": [
    {
      "id": "operate/kubernetes/reference/supported_k8s_distributions",
      "summary": "Support matrix for the current Redis Software for Kubernetes operator",
      "title": "Supported Kubernetes distributions",
      "url": "https://redis.io/docs/latest/operate/kubernetes/reference/supported_k8s_distributions/"
    },
    {
      "id": "operate/kubernetes/reference/api",
      "summary": "Reference documentation for Redis Enterprise operator APIs",
      "title": "API reference",
      "url": "https://redis.io/docs/latest/operate/kubernetes/reference/api/"
    },
    {
      "id": "operate/kubernetes/reference/yaml",
      "summary": "Example YAML files for deploying Redis Enterprise on Kubernetes with different configurations.",
      "title": "YAML examples",
      "url": "https://redis.io/docs/latest/operate/kubernetes/reference/yaml/"
    }
  ],
  "page_type": "content",
  "content_hash": "cac7b07d18dcd35a55cf2ff14073a8748d84a411213f7d10eb4db14a18b43044",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "This reference documentation covers Redis Enterprise custom resources, API specifications, and practical instructions for creating, configuring, and managing Redis Enterprise deployments on Kubernetes."
    },
    {
      "id": "work-with-custom-resources",
      "title": "Work with custom resources",
      "role": "content",
      "text": "Redis Enterprise for Kubernetes uses custom resources to manage clusters and databases. Use standard Kubernetes tools to create, modify, and delete these resources."
    },
    {
      "id": "create-custom-resources",
      "title": "Create custom resources",
      "role": "content",
      "text": "Use `kubectl apply` with YAML manifests to create custom resources:\n\n[code example]"
    },
    {
      "id": "view-custom-resources",
      "title": "View custom resources",
      "role": "content",
      "text": "Use these commands to list and inspect existing custom resources:\n\n[code example]"
    },
    {
      "id": "modify-custom-resources",
      "title": "Modify custom resources",
      "role": "content",
      "text": "Edit the YAML manifest and reapply to update custom resources:\n\n[code example]"
    },
    {
      "id": "yaml-examples",
      "title": "YAML examples",
      "role": "content",
      "text": "Find complete YAML examples for common deployment scenarios:\n\n- [YAML examples](https://redis.io/docs/latest/operate/kubernetes/reference/yaml) - Ready-to-use YAML configurations for different deployment types"
    },
    {
      "id": "example-categories",
      "title": "Example categories",
      "role": "example",
      "text": "- [Basic deployment](https://redis.io/docs/latest/operate/kubernetes/reference/yaml/basic-deployment) - Essential YAML files for simple Redis Enterprise deployment\n- [Rack awareness](https://redis.io/docs/latest/operate/kubernetes/reference/yaml/rack-awareness) - YAML examples for rack-aware deployments across availability zones\n- [Active-Active](https://redis.io/docs/latest/operate/kubernetes/reference/yaml/active-active) - YAML examples for Active-Active databases across multiple clusters\n- [Multi-namespace](https://redis.io/docs/latest/operate/kubernetes/reference/yaml/multi-namespace) - YAML examples for deploying across multiple namespaces"
    },
    {
      "id": "api-reference",
      "title": "API reference",
      "role": "content",
      "text": "Review complete API specifications for all Redis Enterprise custom resources:"
    },
    {
      "id": "core-resources",
      "title": "Core resources",
      "role": "content",
      "text": "- [Redis Enterprise cluster API (REC)](https://redis.io/docs/latest/operate/kubernetes/reference/api/redis_enterprise_cluster_api) - Manage Redis Enterprise clusters\n- [Redis Enterprise database API (REDB)](https://redis.io/docs/latest/operate/kubernetes/reference/api/redis_enterprise_database_api) - Manage Redis databases"
    },
    {
      "id": "active-active-resources",
      "title": "Active-Active resources",
      "role": "content",
      "text": "- [Active-Active database API (REAADB)](https://redis.io/docs/latest/operate/kubernetes/reference/api/redis_enterprise_active_active_database_api) - Manage Active-Active databases\n- [Remote cluster API (RERC)](https://redis.io/docs/latest/operate/kubernetes/reference/api/redis_enterprise_remote_cluster_api) - Configure remote cluster connections"
    },
    {
      "id": "access-control-resources",
      "title": "Access control resources",
      "role": "content",
      "text": "- [RedisEnterpriseUser API (REUSER)](https://redis.io/docs/latest/operate/kubernetes/reference/api/redis_enterprise_user_api) - Manage users for access control\n- [RedisEnterpriseRole API (REROLE)](https://redis.io/docs/latest/operate/kubernetes/reference/api/redis_enterprise_role_api) - Define roles scoped to selected databases\n- [RedisEnterpriseRoleBinding API (REROLEBINDING)](https://redis.io/docs/latest/operate/kubernetes/reference/api/redis_enterprise_role_binding_api) - Bind users to a scoped role\n- [RedisEnterpriseClusterRole API (RECROLE)](https://redis.io/docs/latest/operate/kubernetes/reference/api/redis_enterprise_cluster_role_api) - Define cluster-scoped roles\n- [RedisEnterpriseClusterRoleBinding API (RECROLEBINDING)](https://redis.io/docs/latest/operate/kubernetes/reference/api/redis_enterprise_cluster_role_binding_api) - Bind users to a cluster-scoped role\n- [RedisEnterpriseACL API (REACL)](https://redis.io/docs/latest/operate/kubernetes/reference/api/redis_enterprise_acl_api) - Define access control lists"
    },
    {
      "id": "compatibility",
      "title": "Compatibility",
      "role": "compatibility",
      "text": "Check supported Kubernetes distributions and versions:\n\n- [Supported Kubernetes distributions](https://redis.io/docs/latest/operate/kubernetes/reference/supported_k8s_distributions) - Compatible Kubernetes platforms and versions"
    },
    {
      "id": "best-practices",
      "title": "Best practices",
      "role": "content",
      "text": "Follow these best practices when working with custom resources:\n\n- **Use version control**: Store your YAML manifests in version control systems\n- **Validate before applying**: Use `kubectl apply --dry-run=client` to validate changes\n- **Monitor resource status**: Check resource status after you apply changes\n- **Follow naming conventions**: Use consistent naming for easier management\n- **Document configurations**: Add annotations and labels to describe resource purpose"
    }
  ],
  "examples": [
    {
      "id": "create-custom-resources-ex0",
      "language": "bash",
      "code": "kubectl apply -f my-redis-cluster.yaml\nkubectl apply -f my-redis-database.yaml",
      "section_id": "create-custom-resources"
    },
    {
      "id": "view-custom-resources-ex0",
      "language": "bash",
      "code": "# List Redis Enterprise clusters\nkubectl get rec\n\n# List Redis Enterprise databases\nkubectl get redb\n\n# List Active-Active databases\nkubectl get reaadb\n\n# List remote clusters\nkubectl get rerc\n\n# Get detailed information about a specific resource\nkubectl describe rec my-cluster\nkubectl describe redb my-database",
      "section_id": "view-custom-resources"
    },
    {
      "id": "modify-custom-resources-ex0",
      "language": "bash",
      "code": "# Edit and apply updated manifest\nkubectl apply -f updated-redis-cluster.yaml\n\n# Or edit directly (not recommended for production)\nkubectl edit rec my-cluster\nkubectl edit redb my-database",
      "section_id": "modify-custom-resources"
    }
  ]
}