{"id":15465046,"url":"https://github.com/cored/broadway","last_synced_at":"2026-06-20T03:31:54.049Z","repository":{"id":66523311,"uuid":"53088217","full_name":"cored/broadway","owner":"cored","description":"Broadway ","archived":false,"fork":false,"pushed_at":"2016-08-02T15:31:25.000Z","size":1891,"stargazers_count":0,"open_issues_count":0,"forks_count":4,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-03-11T15:51:05.942Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cored.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":"2016-03-03T22:15:24.000Z","updated_at":"2018-05-21T20:00:09.000Z","dependencies_parsed_at":"2023-02-25T07:30:20.288Z","dependency_job_id":null,"html_url":"https://github.com/cored/broadway","commit_stats":{"total_commits":101,"total_committers":6,"mean_commits":"16.833333333333332","dds":0.4158415841584159,"last_synced_commit":"dd4c40629f1b04b5c156b6cfbcf48a2476a18c6c"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/cored/broadway","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cored%2Fbroadway","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cored%2Fbroadway/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cored%2Fbroadway/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cored%2Fbroadway/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cored","download_url":"https://codeload.github.com/cored/broadway/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cored%2Fbroadway/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34556494,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-20T02:00:06.407Z","response_time":98,"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":[],"created_at":"2024-10-02T00:44:27.103Z","updated_at":"2026-06-20T03:31:54.022Z","avatar_url":"https://github.com/cored.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# broadway\nBroadway \n\nBroadway helps developers deploy their projects with defining their deployment\nworkflows in Broadway playbooks. It runs as a service interacting with\nKubernetes and allowing users to interact with it through various interfaces\n(Slack, CLI, Web).\n\n## Playbook\nA Broadway Playbook is a YAML file for defining a project's deployment tasks.\n\n`id`, `name`, and at least one item in `tasks` are mandatory fields.\n\nEach task item must have one or more of: a `manifests` array, a `pod_manifest`\nitem.\n\nThese manifest items must match .yml files in the `manifests` directory, e.g.\nthe \"Deploy Postgres\" task below expects files `manifests/postgres-rc.yml` and\n`manifests/postgres-service.yml`.\n\n```yaml\n---\nid: web\nname: Web Project\nmeta:\n  team: Web team\n  email: webteam@namely.com\n  slack: web\nvars:\n  - version\n  - assets_version\n  - owner\ntasks:\n  - name: Deploy Postgres\n    manifests:\n      - postgres-rc\n      - postgres-service\n  - name: Deploy Redis\n    manifests:\n      - redis-rc\n      - redis-service\n  - name: Database Migration\n    pod_manifest: migration-pod\n    wait_for:\n      - success\n  - name: Deploy Web\n    manifests:\n      - web-rc\n      - web-service\n      - worker-rc\n```\n\n## Setup\nYou should have prerequisites\n[Kubernetes](http://kubernetes.io/docs/getting-started-guides/binary_release/)\nand [Docker](https://docs.docker.com/engine/installation/) installed already.\nYou should have a running, active Docker machine in this terminal:\n\n    $ kubectl version\n      \u003e \"Client Version... Server Version...\"\n    $ docker-machine status default\n      \u003e \"Running\"\n\nIf you have an inactive docker machine, start it:\n\n    $ eval $(docker-machine env default)\n\nClone the broadway repo and run the startup script:\n\n    $ git clone https://github.com/namely/broadway; cd broadway\n    $ ./broadway-dev-up.sh\n\nAfter lots of docker container setup, you should see output:\n\n    \u003e ...\n    \u003e namespace \"broadway\" created\n\nNow you should have a running Broadway server:\n    $ curl localhost:8080\n      \u003e {\n      \u003e   \"paths\": [\n      \u003e     \"/api\",\n      \u003e ...\n\n## Running Broadway\n\nTo run the Broadway server with your playbooks, you can use `broadwayctl` to start it up. The default directory for playbooks is `$(pwd)/playbooks`.\n\n```sh\n$ broadwayctl server --playbooks=./playbooks --addr=0.0.0.0:8080\n=\u003e starting broadway server...\n=\u003e loading playbooks...\n```\n\nThis will load the directory of playbooks and ensure that everything is hunky dory.\n\n## Instance\nAn instance represents a Broadway instance that may or may not be deployed.\nGood usecase is when a CI server creates an instance in Broadway sending the\nversion then the user can deploy the instance from Slack.\n\nInstance Statuses:\n - new\n - deploying\n - deployed\n - deleting\n - error\n\nInstance Attributes:\n - playbook id – playbook identifier (String)\n - id – instance identifier (String)\n - status – instance status\n - created – when the instance was created\n - vars – map of String values\n\n\n\n## API\n\n1. Create or update Instance\n\nUser can post to `/instances` to create or update instances. We allow updates\nvia POST request to simplify the http interface.\n\n\nRequest:\n```\nPOST /instances\n\n{\n  \"playbook_id\": \"web\",\n  \"id\": \"master\",\n  \"vars\": {\n    \"version\": \"dc231ba\",\n    \"assets_version\": \"dc231ba\",\n    \"owner\": \"bill\"\n  }\n}\n```\n\nResponse:\n```\nStatus: 201 Created\n\n\n{\n  \"playbook_id\": \"web\",\n  \"id\": \"master\",\n  \"status\": \"new\",\n  \"vars\": {\n    \"version\": \"dc231ba\",\n    \"assets_version\": \"dc231ba\",\n    \"owner\": \"bill\"\n  }\n}\n```\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcored%2Fbroadway","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcored%2Fbroadway","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcored%2Fbroadway/lists"}