{"id":22822481,"url":"https://github.com/switcherapi/switcher-gitops","last_synced_at":"2025-03-30T23:41:40.856Z","repository":{"id":222056703,"uuid":"752815770","full_name":"switcherapi/switcher-gitops","owner":"switcherapi","description":"GitOps Domain Snapshot Orquestrator for Switcher API","archived":false,"fork":false,"pushed_at":"2024-09-17T02:16:45.000Z","size":159,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2024-09-17T15:02:29.552Z","etag":null,"topics":["feature-flags","gitops","golang"],"latest_commit_sha":null,"homepage":"","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/switcherapi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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},"funding":{"patreon":"switcherapi","ko_fi":"petruki","github":["petruki"]}},"created_at":"2024-02-04T21:46:02.000Z","updated_at":"2024-09-17T02:16:45.000Z","dependencies_parsed_at":"2024-07-06T21:27:31.444Z","dependency_job_id":"551dd2b3-5704-4f68-8d68-4327bd04567f","html_url":"https://github.com/switcherapi/switcher-gitops","commit_stats":null,"previous_names":["switcherapi/switcher-gitops"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/switcherapi%2Fswitcher-gitops","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/switcherapi%2Fswitcher-gitops/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/switcherapi%2Fswitcher-gitops/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/switcherapi%2Fswitcher-gitops/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/switcherapi","download_url":"https://codeload.github.com/switcherapi/switcher-gitops/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246395573,"owners_count":20770240,"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":["feature-flags","gitops","golang"],"created_at":"2024-12-12T16:12:05.955Z","updated_at":"2025-03-30T23:41:40.838Z","avatar_url":"https://github.com/switcherapi.png","language":"Go","funding_links":["https://patreon.com/switcherapi","https://ko-fi.com/petruki","https://github.com/sponsors/petruki"],"categories":[],"sub_categories":[],"readme":"***\n\n\u003cdiv align=\"center\"\u003e\n\u003cb\u003eSwitcher GitOps\u003c/b\u003e\u003cbr\u003e\nGitOps Domain Snapshot Orchestrator for Switcher API\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n[![Master CI](https://github.com/switcherapi/switcher-gitops/actions/workflows/master.yml/badge.svg?branch=master)](https://github.com/switcherapi/switcher-gitops/actions/workflows/master.yml)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=switcherapi_switcher-gitops\u0026metric=alert_status)](https://sonarcloud.io/dashboard?id=switcherapi_switcher-gitops)\n[![Known Vulnerabilities](https://snyk.io/test/github/switcherapi/switcher-gitops/badge.svg)](https://snyk.io/test/github/switcherapi/switcher-gitops)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Docker Hub](https://img.shields.io/docker/pulls/trackerforce/switcher-gitops.svg)](https://hub.docker.com/r/trackerforce/switcher-gitops)\n[![Slack: Switcher-HQ](https://img.shields.io/badge/slack-@switcher/hq-blue.svg?logo=slack)](https://switcher-hq.slack.com/)\n\n\u003c/div\u003e\n\n***\n\n![Switcher API: Cloud-based Feature Flag API](https://github.com/switcherapi/switcherapi-assets/blob/master/logo/switcherapi_gitops.png)\n\n# About  \n**Switcher GitOps** is used to orchestrate Domain Snapshots for Switcher API. It allows managing feature flags and configurations lifecycle.\n\n- Manages Switchers with GitOps workflow (repository as a source of truth)\n- Repository synchronization allows integrated tools such as Switcher API Management and Switcher Slack App to work in sync\n- Flexible settings allow you to define the best workflow for your organization\n- Orchestrates accounts per Domain environments allowing seamless integration with any branching strategy\n\n# Getting Started\n\n## Using Swither API Cloud\n\nSwitcher GitOps is available as a cloud-hosted service. You can sign up for a free account at [Switcher API Cloud](https://cloud.switcherapi.com).\n\n1. Create and Configure a new Domain\n2. Select the Domain and click on the Menu toolbar\n3. Under Integrations, select Switcher GitOps\n4. Follow the instructions to set up the repository\n\n## Self-hosted: Deploying to Kubernetes\n\n### Requirements\n- Kubernetes cluster\n- Helm 3\n- Switcher API \u0026 Switcher Management\n- Git Token (read/write access) for the repository\n\nFind detailed instructions on how to deploy Switcher GitOps to Kubernetes [here](https://github.com/switcherapi/helm-charts).\n\n## Development: Deploying locally\n\n### Requirements\n- Docker \u0026 docker-compose\n- Switcher API \u0026 Switcher Management\n- Git Token (read/write access) for the repository\n\n1. Configure Switcher API to allow Switcher GitOps to access the API\u003cbr\u003e\nSet SWITCHER_GITOPS_JWT_SECRET for Switcher API and SWITCHER_API_JWT_SECRET for Switcher GitOps.\n\n2. [Start](https://github.com/switcherapi/switcher-api?tab=readme-ov-file#running-switcher-api-from-docker-composer-manifest-file) Switcher API and Switcher Management\n3. Start Switcher GitOps `docker-compose -d up`\u003cbr\u003e\nYou might need to remove mongodb setting from docker-compose.yml if launching the full Switcher API stack from step 2.\n\n## Development: Running locally\n\n### Requirements\n- Go [check version in go.mod]\n- MongoDB +7.0\n\n1. Clone the repository\n2. Configure the environment variables in the `.env.test` file\n3. `make run-test` to start the application\n\n# Integrated tests\n\nSet up PAT (Personal Access Token) for Switcher GitOps to access the repository. You can either create a fine-grained token with only the necessary permissions such as Content (Read and Write) and Metadata (Read) or use a personal token with full access.\n\nOnce you have the token, you can set it up in the `.env.test` environment file by including the following:\n```bash\nGIT_USER=[YOUR_GIT_USER]\nGIT_TOKEN=[YOUR_GIT_TOKEN]\nGIT_TOKEN_READ_ONLY=[YOUR_GIT_TOKEN_READ_ONLY]\nGIT_REPO_URL=[YOUR_GIT_REPO_URL]\nGIT_BRANCH=[YOUR_GIT_BRANCH]\nGIT_PATH=[YOUR_GIT_PATH]\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswitcherapi%2Fswitcher-gitops","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fswitcherapi%2Fswitcher-gitops","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswitcherapi%2Fswitcher-gitops/lists"}