{"id":22351886,"url":"https://github.com/screwdriver-cd/aws-producer-service","last_synced_at":"2026-02-17T06:01:42.168Z","repository":{"id":44995888,"uuid":"409263498","full_name":"screwdriver-cd/aws-producer-service","owner":"screwdriver-cd","description":"Screwdriver AWS Integration Producer Service","archived":false,"fork":false,"pushed_at":"2025-02-20T00:03:54.000Z","size":40,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-09-26T11:51:55.441Z","etag":null,"topics":["kafka"],"latest_commit_sha":null,"homepage":"https://cd.screwdriver.cd/pipelines/7971/events","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/screwdriver-cd.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,"zenodo":null}},"created_at":"2021-09-22T15:45:08.000Z","updated_at":"2025-02-20T00:02:14.000Z","dependencies_parsed_at":"2025-04-12T17:45:04.900Z","dependency_job_id":"5080f460-640a-45bc-a71b-dc35f590a59d","html_url":"https://github.com/screwdriver-cd/aws-producer-service","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/screwdriver-cd/aws-producer-service","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screwdriver-cd%2Faws-producer-service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screwdriver-cd%2Faws-producer-service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screwdriver-cd%2Faws-producer-service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screwdriver-cd%2Faws-producer-service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/screwdriver-cd","download_url":"https://codeload.github.com/screwdriver-cd/aws-producer-service/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screwdriver-cd%2Faws-producer-service/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29535934,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-17T05:00:25.817Z","status":"ssl_error","status_checked_at":"2026-02-17T04:57:16.126Z","response_time":100,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["kafka"],"created_at":"2024-12-04T12:16:15.730Z","updated_at":"2026-02-17T06:01:42.146Z","avatar_url":"https://github.com/screwdriver-cd.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# aws-producer-service\nScrewdriver AWS Integration Producer Service\n[![Version][npm-image]][npm-url] ![Downloads][downloads-image] [![Build Status][status-image]][status-url] [![Open Issues][issues-image]][issues-url] ![License][license-image]\n\u003e Producer Service for Screwdriver Kafka Queue\n\nThis service acts as a message producer and provides and interface to publish messages to Screwdriver Kafka Instance.\n\n## Table of Contents\n- [Installation and Usage](#installation-and-usage)\n- [Configuration](#configuration)\n- [Methods](#methods)\n- [Testing](#testing)\n- [Contribute](#contribute)\n- [License](#license)\n\n### Installation and Usage\n\n```bash\nnpm install screwdriver-aws-producer-service\n```\n## Configuration\nThe configuration for the package\n\n| Parameter        | Type  | Default    | Description |\n| :-------------   | :---- | :----------| :-----------|\n|enabled| bool | true | Flag for enabling broker config|\n|hosts| array | [] | Array of broker endpoints|\n|sasl| object |  | sasl object|\n|sasl.mechanism| string | scram-sha-512 | sasl mechanism|\n|sasl.secretId| string | - | AWS secret manager id for sasl secret|\n|clientId| string | - | Client id connecting to kafka brokers|\n|accessKeyId| string | - | AWS access key id|\n|secretAccessKey| string | - | AWS secret key id|\n|region| string | - | AWS region|\n```\nkafka:\n  # flag for kafka broker\n  enabled: true\n  # kafka brokers list\n  hosts: KAFKA_BROKERS_LIST\n  # sasl options\n  sasl:\n    # sasl mechanism\n    mechanism: scram-sha-512\n    # secret id for sasl/scram\n    secretId: fakesecret\n  # client id of the producer\n  clientId: sd-producer\n  # Amazon access key\n  accessKeyId: KAFKA_ACCESS_KEY_ID\n  # Amazon secret access key\n  secretAccessKey: KAFKA_ACCESS_KEY_SECRET\n  # AWS region \n  region: AWS_REGION\n```\n\n## Methods\n#### Producer Methods\n#### `connect`\n##### Expected Outcome\nConnects as a client instance to the kafka broker based on the specified configuration\n##### Expected Return\nA Promise that resolves to a Kafka producer object.\n\n#### `sendMessage`\n##### Expected Outcome\nSends a message to a kafka topic.\n##### Required Parameters\n| Parameter        | Type  |  Description |\n| :-------------   | :---- | :-------------|\n| producer        | Object | The producer object after calling connect() |\n| data        | Object | The message data object |\n| topic | String | The name of the topic |\n| messageId | String | The id of the message\n\n#### Admin Methods\n#### `connectAdmin`\n##### Expected Outcome\nConnects as a client instance to the kafka broker based as an admin with elevated permissions on the specified configuration\n##### Expected Return\nA Promise that resolves to a Kafka admin object.\n\n#### `createTopic`\n##### Expected Outcome\nCreates a kafka topic and disconnects the admin connection.\n##### Required Parameters\n| Parameter        | Type  |  Description |\n| :-------------   | :---- | :-------------|\n| admin        | Object | The admin object after calling connectAdmin() |\n| topic | String | The name of the topic |\n\n#### `getTopicMetadata`\n##### Expected Outcome\nGets kafka metadata for the give kafka topic and disconnects the admin connection.\n##### Required Parameters\n| Parameter        | Type  |  Description |\n| :-------------   | :---- | :-------------|\n| admin        | Object | The admin object after calling connectAdmin() |\n| topic | String | The name of the topic |\n##### Expected Return\nA Promise that resolves to a Kafka topic metadata object.\n\n## Testing\n\n```bash\nnpm test\n```\n\n## Contribute\nTo start contributing to Screwdriver, have a look at our guidelines, as well as pointers on where to start making changes, in our [contributing guide](http://docs.screwdriver.cd/about/contributing).\n\n## License\n\nCode licensed under the BSD 3-Clause license. See LICENSE file for terms.\n\n[npm-image]: https://img.shields.io/npm/v/screwdriver-aws-producer-service.svg\n[npm-url]: https://npmjs.org/package/screwdriver-aws-producer-service\n[downloads-image]: https://img.shields.io/npm/dt/aws-producer-service.svg\n[license-image]: https://img.shields.io/npm/l/aws-producer-service.svg\n[issues-image]: https://img.shields.io/github/issues/screwdriver-cd/screwdriver.svg\n[issues-url]: https://github.com/screwdriver-cd/screwdriver/issues\n[status-image]: https://cd.screwdriver.cd/pipelines/7971/badge\n[status-url]: https://cd.screwdriver.cd/pipelines/7971\n[screwdriver job-tools]: https://github.com/screwdriver-cd/job-tools\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscrewdriver-cd%2Faws-producer-service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscrewdriver-cd%2Faws-producer-service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscrewdriver-cd%2Faws-producer-service/lists"}