SolrCloud

This Helm chart deploys Apache SolrCloud on Kubernetes, providing a highly available, distributed search platform. SolrCloud is built on Apache Solr and offers features like distributed indexing, automatic sharding, and fault tolerance.

Prerequisites

• Kubernetes 1.19+
• Helm 3.0+
• kubectl configured to communicate with your cluster
• Solr Operator installed in the cluster (automatically installed as a dependency)

Dependencies

Before installing the chart, you need to download the required dependencies. Run the following command in the chart directory:

helm dependency build

This command will:

1. Read the dependencies from Chart.yaml
2. Download the required charts (Solr Operator) from the specified repositories
3. Store them in the charts/ directory
4. Create or update the Chart.lock file with the exact versions

If you encounter any issues with the dependencies, you can try:

helm dependency update  # Updates dependencies to the latest versions

This chart requires the following dependencies to be installed:

Solr Operator

• Chart: solr-operator
• Version: 0.0.1
• Repository: https://helm.zop.dev
• Purpose: Manages the SolrCloud cluster lifecycle, including scaling, updates, and maintenance operations

To install this dependency automatically, ensure the following in your values.yaml:

solr-operator:
  enabled: true
  # Additional Solr Operator configuration...

The dependency will be automatically installed when you deploy the SolrCloud chart. You can customize its configuration through the respective section in your values.yaml file.

Add Helm Repository

Add the Helm repository by running:

helm repo add zopdev https://helm.zop.dev
helm repo update

For more details, see the Helm Repository Documentation.

Install Helm Chart

To deploy the SolrCloud Helm chart, use the following command:

helm install [RELEASE_NAME] zopdev/solrcloud

Replace [RELEASE_NAME] with your desired release name. Example:

helm install my-solrcloud zopdev/solrcloud

You can override default values during installation by providing a values.yaml file.

Refer to the Helm Install Documentation for further details.

Uninstall Helm Chart

To remove the SolrCloud Helm chart and associated resources, run:

helm uninstall [RELEASE_NAME]

Example:

helm uninstall my-solrcloud

Check the Helm Uninstall Documentation for more information.

Configuration

The SolrCloud Helm chart includes several configuration options to tailor the deployment to your needs. Below is a summary of the key configurations:

Example values.yaml

version: "8.11"

resources:
  requests:
    cpu: "500m"
    memory: "500Mi"
  limits:
    cpu: "1000m"
    memory: "1500Mi"

diskSize : "20Gi"

solr-operator:
  version : "v0.9.0"
  resources:
    requests:
      cpu: "100m"
      memory: "128Mi"
    limits:
      cpu: "200m"
      memory: "256Mi"

Features

• Deploys a fully configured SolrCloud cluster
• Automatic Zookeeper ensemble management
• Persistent storage for Solr data
• Basic authentication enabled by default
• Pod disruption budget for high availability
• Automatic scaling with pod vacate/populate
• Managed update strategy
• Customizable resource limits and requests
• Automatic Solr Operator deployment

Architecture

The SolrCloud deployment includes:

• SolrCloud cluster with configurable resources
• Zookeeper ensemble (3 replicas by default)
• Persistent volume claims for data storage
• Pod disruption budget for high availability
• Solr Operator for cluster management
• Basic authentication security
• Configurable update and scaling strategies

Contributing

We welcome contributions to improve this Helm chart. Please refer to the CONTRIBUTING.md file for contribution guidelines.

Code of Conduct

To maintain a healthy and collaborative community, please adhere to our Code of Conduct.

License

This project is licensed under the LICENSE. Please review it for terms of use.

Connection Config

• SOLR_HOST : Headless service name for the SolrCloud StatefulSet.
• SOLR_PORT : Port for accessing Solr HTTP interface.Defaults at 8983.
• SOLR_USER : Username for Solr authentication.