{"id":31923027,"url":"https://github.com/rocketchat/helm-charts","last_synced_at":"2026-04-02T19:04:13.025Z","repository":{"id":38846520,"uuid":"286542361","full_name":"RocketChat/helm-charts","owner":"RocketChat","description":"Repository for RocketChat helm charts","archived":false,"fork":false,"pushed_at":"2025-10-01T17:09:13.000Z","size":20119,"stargazers_count":43,"open_issues_count":55,"forks_count":79,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-10-01T19:11:38.416Z","etag":null,"topics":["helm","helm-charts","kubernetes"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RocketChat.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-08-10T17:47:39.000Z","updated_at":"2025-09-25T14:29:42.000Z","dependencies_parsed_at":"2024-05-08T19:24:52.799Z","dependency_job_id":"619bb8a8-e0c4-45d7-90f2-a0c1169a9182","html_url":"https://github.com/RocketChat/helm-charts","commit_stats":null,"previous_names":[],"tags_count":95,"template":false,"template_full_name":null,"purl":"pkg:github/RocketChat/helm-charts","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RocketChat%2Fhelm-charts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RocketChat%2Fhelm-charts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RocketChat%2Fhelm-charts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RocketChat%2Fhelm-charts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RocketChat","download_url":"https://codeload.github.com/RocketChat/helm-charts/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RocketChat%2Fhelm-charts/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279017232,"owners_count":26086016,"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","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["helm","helm-charts","kubernetes"],"created_at":"2025-10-13T23:43:29.421Z","updated_at":"2026-02-02T19:03:19.029Z","avatar_url":"https://github.com/RocketChat.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# helm-charts\n\nThis is helm repository for RocketChat charts. Follow the steps below to start deploying any of them in your Kubernetes cluster.\n\n## Important Note!\n\nIf you are currently using the built in mongo and have not already switched to an external mongo please see our forum post:\n\nhttps://forums.rocket.chat/t/action-required-helm-chart-moving-from-bitnami-to-official-mongodb-chart/22679\n\nWe will be removing the built in mongo using Bitnami in susequent versions.\n\n## Usage\n\nBe sure you have helm3 binary insalled, add this repository and install rocketchat chart:\n\n```bash\n$ helm repo add rocketchat https://rocketchat.github.io/helm-charts\n```\n\nAnd check our rocketchat server helm chart folder for more instructions [here](https://github.com/RocketChat/helm-charts/tree/master/rocketchat)\n\n\n## Contributing\n\nWe welcome contributions to the RocketChat Helm charts! This section provides information on how to run tests, add new tests, and the tools used in our testing infrastructure.\n\n### Prerequisites\n\nBefore contributing, ensure you have the following tools installed:\n\n- **Helm 3**: For chart management and testing\n- **Docker**: For running mock services and containerized tests\n- **kubectl**: For Kubernetes cluster interaction\n- **BATS (Bash Automated Testing System)**: Already included as a submodule in the `bats/` directory\n\n### Testing Infrastructure\n\nOur testing setup uses several tools and frameworks:\n\n- **BATS**: Bash Automated Testing System for writing and running tests\n- **BATS-Detik**: Kubernetes-specific BATS library for testing Kubernetes resources\n- **KWOK**: Kubernetes WithOut Kubelet for lightweight cluster testing\n- **KinD**: Kubernetes in Docker for local cluster testing\n- **Docker Compose**: For running mock services\n\n### Running Tests\n\n#### Quick Start\n\nThe easiest way to run tests is using the Task runner:\n\n```bash\n# Run tests using KWOK (lightweight, recommended for development)\n./task.bash clean rocketchat microservices mock\n./task.bash clean rocketchat microservices mock\n\n# Run tests using KinD (full Kubernetes cluster)\n./task.bash clean rocketchat microservices cluster\n./task.bash clean rocketchat microservices cluster\n```\n\n#### Test Modes\n\nThe tests support two deployment modes:\n\n- **Monolith**: Single RocketChat instance with all services\n- **Microservices**: Distributed RocketChat deployment with separate services\n\n### Adding New Tests\n\n#### Test Structure\n\nTests are located in `rocketchat/tests/` and use BATS framework:\n\n- `rocketchat.bats`: Main test suite with deployment and assertion tests\n- `common.bash`: Common test utilities and functions\n- `run.bash`: Test execution script\n\n#### Writing New Tests\n\n1. **Test File Location**: Add new test files in `rocketchat/tests/` directory\n2. **BATS Syntax**: Use standard BATS syntax with test tags for organization\n3. **Test Tags**: Use tags to categorize tests:\n   - `pre`: Pre-deployment checks\n   - `deploy`: Deployment tests\n   - `assertion`: Resource verification tests\n   - `monolith`/`microservices`: Mode-specific tests\n\nExample test structure:\n\n```bash\n#!/bin/bash\n\nload \"../../bats/common.sh\"\nload \"../../bats/kubernetes_common.sh\"\nload \"common.bash\"\n\n# bats test_tags=assertion\n@test \"verify custom pod configuration\" {\n  test_pods \\\n    \"somepod-0\" \\\n}\n```\n\n#### Test Utilities\n\nThe test framework provides several utilities:\n\n- **Kubernetes assertions**: Use functions from `bats/kubernetes_common.sh`\n- **Common utilities**: Use functions from `bats/common.sh`\n- **Chart-specific utilities**: Use functions from `rocketchat/tests/common.bash`\n\n### Continuous Integration\n\nTests are automatically run in GitHub Actions on:\n- Pull requests affecting `rocketchat/`, `bats/`, `mock/`, or test workflows\n- Manual workflow dispatch\n- Workflow calls from other repositories\n\nThe CI pipeline runs tests for both monolith and microservices modes using both KWOK and KinD clusters.\n\n### Troubleshooting\n\n#### Common Issues\n\n1. **Submodules not initialized**: Run `./task.bash submodules`\n2. **Docker not running**: Ensure Docker daemon is running\n3. **Port conflicts**: Check if required ports are available\n4. **Cluster already exists**: Verify with `docker ps` and `king get cluster` if there is no leftovers from a failed run\n\n#### Environment Variables\n\nKey environment variables for testing:\n\n- `ROCKETCHAT_HOST`: Hostname for RocketChat (default: rocketchat.example.com)\n- `ROCKETCHAT_TAG`: RocketChat image tag (default: 7.7.1)\n- `HELM_TAG`: Chart version for testing (default: 0.0.0)\n- `POD_RETRIES`: Number of retries for pod checks (default: 5)\n- `POD_RETRY_INTERVAL`: Interval between retries in seconds (default: 30)\n\n### Contributing Guidelines\n\n1. **Test Coverage**: Ensure new features include appropriate tests\n2. **Test Tags**: Use appropriate tags to categorize your tests\n3. **Documentation**: Update this section if you add new testing tools or procedures\n4. **CI Compatibility**: Ensure tests work in the CI environment\n5. **Local Testing**: Test your changes locally before submitting PRs\n\nFor more detailed information about the RocketChat chart, see the [chart-specific README](https://github.com/RocketChat/helm-charts/tree/master/rocketchat).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frocketchat%2Fhelm-charts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frocketchat%2Fhelm-charts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frocketchat%2Fhelm-charts/lists"}