{"id":25582680,"url":"https://github.com/mortada-codes/kubeowl","last_synced_at":"2025-08-02T21:06:03.602Z","repository":{"id":277838208,"uuid":"930789701","full_name":"mortada-codes/kubeowl","owner":"mortada-codes","description":null,"archived":false,"fork":false,"pushed_at":"2025-02-16T13:16:36.000Z","size":41,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-10T20:14:19.737Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mortada-codes.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}},"created_at":"2025-02-11T08:06:31.000Z","updated_at":"2025-02-16T13:16:39.000Z","dependencies_parsed_at":null,"dependency_job_id":"7702185c-e37d-4c19-83ab-ba49ae0e3ab8","html_url":"https://github.com/mortada-codes/kubeowl","commit_stats":null,"previous_names":["mortada-codes/kubeowl"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mortada-codes/kubeowl","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mortada-codes%2Fkubeowl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mortada-codes%2Fkubeowl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mortada-codes%2Fkubeowl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mortada-codes%2Fkubeowl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mortada-codes","download_url":"https://codeload.github.com/mortada-codes/kubeowl/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mortada-codes%2Fkubeowl/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268454336,"owners_count":24253150,"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-08-02T02:00:12.353Z","response_time":74,"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":"2025-02-21T05:18:06.103Z","updated_at":"2025-08-02T21:06:03.541Z","avatar_url":"https://github.com/mortada-codes.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# KubeOwl 🦉\n\nKubeOwl is a Kubernetes operator that seamlessly synchronizes environment variables between GitHub Actions and Kubernetes clusters, making secrets and configuration management effortless.\n\n## Description\n\nManaging environment variables and secrets across GitHub Actions and Kubernetes clusters can be challenging and error-prone. KubeOwl solves this by providing:\n\n- 🔄 Automatic synchronization of environment variables from GitHub Actions to Kubernetes\n- 🔐 Secure handling of sensitive data and secrets\n- 📦 Support for multiple deployment environments (dev, staging, prod)\n- 🎯 Selective synchronization based on namespaces and labels\n- 🔍 Audit logging of all synchronization events\n\n## Getting Started\n\n### Prerequisites\n- go version v1.23.0+\n- docker version 17.03+\n- kubectl version v1.11.3+\n- Access to a Kubernetes v1.11.3+ cluster\n- GitHub repository with Actions enabled\n- GitHub Personal Access Token with appropriate permissions\n\n### To Deploy on the cluster\n**Build and push your image to the location specified by `IMG`:**\n\n```sh\nmake docker-build docker-push IMG=\u003csome-registry\u003e/kubeowl:tag\n```\n\n**NOTE:** This image ought to be published in the personal registry you specified.\nAnd it is required to have access to pull the image from the working environment.\nMake sure you have the proper permission to the registry if the above commands don’t work.\n\n**Install the CRDs into the cluster:**\n\n```sh\nmake install\n```\n\n**Deploy the Manager to the cluster with the image specified by `IMG`:**\n\n```sh\nmake deploy IMG=\u003csome-registry\u003e/kubeowl:tag\n```\n\n\u003e **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin\nprivileges or be logged in as admin.\n\n### Configure and Deploy\n\n1. Create a KubeOwl Configuration:\n\n```yaml\napiVersion: sync.kubeowl.io/v1alpha1\nkind: EnvSync\nmetadata:\n  name: my-app-sync\nspec:\n  source:\n    github:\n      repository: owner/repo\n      environment: production\n  target:\n    namespace: my-namespace\n    secretName: my-app-secrets\n```\n\n2. Configure GitHub Actions:\n\n```yaml\nname: Sync Environment Variables\n\non:\n  push:\n    branches: [ main ]\n  workflow_dispatch:\n\njobs:\n  sync-env:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Configure KubeOwl\n        uses: kubeowl/action@v1\n        with:\n          cluster-url: ${{ secrets.CLUSTER_URL }}\n          token: ${{ secrets.KUBEOWL_TOKEN }}\n          namespace: my-namespace\n```\n\n3. Monitor Synchronization:\n\n```sh\nkubectl get envsyncs\nkubectl describe envsync my-app-sync\n```\n\n### To Uninstall\n\n1. Remove EnvSync resources:\n```sh\nkubectl delete envsyncs --all\n```\n\n2. Uninstall KubeOwl:\n```sh\nmake undeploy\n```\n\n## Contributing\n\nWe welcome contributions to KubeOwl! Here's how you can help:\n\n1. Fork the repository\n2. Create a feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\nPlease ensure your PR adheres to:\n- Kubernetes coding conventions\n- Secure handling of sensitive data\n- Comprehensive test coverage\n- Clear documentation updates\n\n**NOTE:** Run `make help` for more information on all potential `make` targets\n\nMore information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)\n\n1. Build the installer for the image built and published in the registry:\n\n```sh\nmake build-installer IMG=\u003csome-registry\u003e/kubeowl:tag\n```\n\n**NOTE:** The makefile target mentioned above generates an 'install.yaml'\nfile in the dist directory. This file contains all the resources built\nwith Kustomize, which are necessary to install this project without its\ndependencies.\n\n2. Using the installer\n\nUsers can just run 'kubectl apply -f \u003cURL for YAML BUNDLE\u003e' to install\nthe project, i.e.:\n\n```sh\nkubectl apply -f https://raw.githubusercontent.com/\u003corg\u003e/kubeowl/\u003ctag or branch\u003e/dist/install.yaml\n```\n\n### By providing a Helm Chart\n\n1. Build the chart using the optional helm plugin\n\n```sh\nkubebuilder edit --plugins=helm/v1-alpha\n```\n\n2. See that a chart was generated under 'dist/chart', and users\ncan obtain this solution from there.\n\n**NOTE:** If you change the project, you need to update the Helm Chart\nusing the same command above to sync the latest changes. Furthermore,\nif you create webhooks, you need to use the above command with\nthe '--force' flag and manually ensure that any custom configuration\npreviously added to 'dist/chart/values.yaml' or 'dist/chart/manager/manager.yaml'\nis manually re-applied afterwards.\n\n## Contributing\n\nWe welcome contributions to KubeOwl! Here's how you can help:\n\n1. Fork the repository\n2. Create a feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\nPlease ensure your PR adheres to:\n- Kubernetes coding conventions\n- Includes appropriate tests\n- Updates documentation as needed\n\n**NOTE:** Run `make help` for more information on all potential `make` targets\n\nMore information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)\n\n## License\n\nCopyright 2025.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmortada-codes%2Fkubeowl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmortada-codes%2Fkubeowl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmortada-codes%2Fkubeowl/lists"}