{"id":20329002,"url":"https://github.com/affix/sidekiq-connector","last_synced_at":"2025-04-11T20:41:18.936Z","repository":{"id":87753377,"uuid":"153943002","full_name":"affix/sidekiq-connector","owner":"affix","description":"A Sidekiq connector for @OpenFaas","archived":false,"fork":false,"pushed_at":"2019-07-21T13:58:01.000Z","size":26,"stargazers_count":6,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-25T16:46:21.453Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/affix.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":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-10-20T19:55:04.000Z","updated_at":"2021-12-02T14:11:59.000Z","dependencies_parsed_at":null,"dependency_job_id":"8c897ab6-e3ac-4cbe-a32d-82fbd5a4f4ce","html_url":"https://github.com/affix/sidekiq-connector","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/affix%2Fsidekiq-connector","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/affix%2Fsidekiq-connector/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/affix%2Fsidekiq-connector/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/affix%2Fsidekiq-connector/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/affix","download_url":"https://codeload.github.com/affix/sidekiq-connector/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248478686,"owners_count":21110748,"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-14T20:09:01.371Z","updated_at":"2025-04-11T20:41:18.914Z","avatar_url":"https://github.com/affix.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"## sidekiq-connector\n\nThe sidekiq connector connects OpenFaaS functions to sidekiq topics.\n\nGoals:\n\n* Allow functions to subscribe to sidekiq topics\n* Ingest data from sidekiq and execute functions\n* Work with the OpenFaaS REST API / Gateway\n* Formulate and validate a generic \"connector-pattern\" to be used for various event sources like sidekiq, AWS SNS, RabbitMQ etc\n\n## Try it out\n\n### Deploy Swarm\n\nDeploy the stack which contains sidekiq and the connector:\n\n```bash\ndocker stack deploy sidekiq -c ./yaml/connector-swarm.yml\n```\n\n* Deploy or update a function so it has an annotation `topic=faas-request` or some other topic\n\nAs an example:\n\n```shell\n$ faas store deploy figlet --annotation topic=\"faas-request\"\n```\n\nThe function can advertise more than one topic by using a comma-separated list i.e. `topic=topic1,topic2,topic3`\n\n* Publish some messages to the topic in question i.e. `faas-request`\n\nInstructions are below for publishing messages\n\n* Watch the logs of the sidekiq-connector\n\n\n### Deploy on Kubernetes\n\nThe following instructions show how to run `sidekiq-connector` on Kubernetes.\n\nDeploy a function with a `topic` annotation:\n\n```bash\n$ faas store deploy figlet --annotation topic=\"faas-request\" --gateway \u003cfaas-netes-gateway-url\u003e\n```\n\nDeploy sidekiq:\n\nYou can run the reis, sidekiq and sidekiq-connector pods with:\n\n```bash\nkubectl apply -f ./yaml/kubernetes/\n```\n\nIf you already have sidekiq then update `./yaml/kubernetes/connector-dep.yml` with your redis address and then deploy only that file:\n\n```bash\nkubectl apply -f ./yaml/kubernetes/connector-dep.yml\n```\n\n## Configuration\n\nThis configuration can be set in the YAML files for Kubernetes or Swarm.\n\n| env_var               | description                                                 |\n| --------------------- |----------------------------------------------------------   |\n| `upstream_timeout`      | Go duration - maximum timeout for upstream function call    |\n| `rebuild_interval`      | Go duration - interval for rebuilding function to topic map |\n| `queues`                | Queues to which the connector will bind                     |\n| `gateway_url`           | The URL for the API gateway i.e. http://gateway:8080 or http://gateway.openfaas:8080 for Kubernetes       |\n| `redis_host`            | Default is `127.0.0.1:6379`                                          |\n| `print_response`        | Default is `true` - this will output the response of calling a function in the logs |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faffix%2Fsidekiq-connector","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faffix%2Fsidekiq-connector","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faffix%2Fsidekiq-connector/lists"}