{"id":15129985,"url":"https://github.com/dhouib-mohamed/k8s-auth-operator","last_synced_at":"2026-01-20T16:02:04.826Z","repository":{"id":251030521,"uuid":"836184892","full_name":"Dhouib-Mohamed/k8s-auth-operator","owner":"Dhouib-Mohamed","description":"Kubernetes auth operator manages Kubernetes cluster authentication using a declarative approach with CRDs for context, roles, and users, built with Kubebuilder.","archived":false,"fork":false,"pushed_at":"2024-08-10T14:30:39.000Z","size":104,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-11T17:14:39.117Z","etag":null,"topics":["authentication","cloud-native","cluster-management","crd","golang","k8s","kubebuilder","kubernetes","kubernetes-operator","rbac"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Dhouib-Mohamed.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":"2024-07-31T10:20:28.000Z","updated_at":"2025-01-24T07:31:35.000Z","dependencies_parsed_at":"2024-08-10T13:30:14.374Z","dependency_job_id":null,"html_url":"https://github.com/Dhouib-Mohamed/k8s-auth-operator","commit_stats":null,"previous_names":["dhouib-mohamed/k8s-auth-operator"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dhouib-Mohamed%2Fk8s-auth-operator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dhouib-Mohamed%2Fk8s-auth-operator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dhouib-Mohamed%2Fk8s-auth-operator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dhouib-Mohamed%2Fk8s-auth-operator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Dhouib-Mohamed","download_url":"https://codeload.github.com/Dhouib-Mohamed/k8s-auth-operator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247387020,"owners_count":20930757,"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":["authentication","cloud-native","cluster-management","crd","golang","k8s","kubebuilder","kubernetes","kubernetes-operator","rbac"],"created_at":"2024-09-26T02:25:54.892Z","updated_at":"2026-01-20T16:02:04.697Z","avatar_url":"https://github.com/Dhouib-Mohamed.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# k8s-auth-operator\nKubernetes auth operator is a project that aims to provide a solution to manage the authentication of the Kubernetes cluster. It is built using the Kubebuilder framework.\n\n\n## Description\nAs the Kubernetes cluster grows, managing the authentication of the cluster becomes a tedious task. This project aims to provide a solution to manage the authentication of the Kubernetes cluster. The operator will manage the authentication of the cluster by creating and managing the service accounts, roles, and role bindings. The operator will also provide a way to manage the authentication of the cluster using a declarative approach.\u003cbr\u003e\nIt uses a custom resource definition (CRD) to define the authentication configuration of the cluster. The operator will watch for changes to the CRD and reconcile the state of the cluster based on the configuration defined in the CRD.\n\u003cbr\u003eThe Provided CRDs are:\n- **Context:** This CRD defines the context of the authentication configuration. It groups the list of the relevant namespaces by name or by regex.\n- **Role:** This CRD defines the role of the authentication configuration. It defines the role name and the list of the resources that the role can access.\n- **User:** This CRD defines the user of the authentication configuration. It defines the username and the list of the roles that the user can access.\n\n## Getting Started\n\n### Prerequisites\n- go version v1.22.0+\n- docker version 17.03+.\n- kubectl version v1.11.3+.\n- Access to a Kubernetes v1.11.3+ cluster.\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=ghcr.io/Dhouib-Mohamed/k8s-auth-operator: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=ghcr.io/Dhouib-Mohamed/k8s-auth-operator: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**Create instances of your solution**\nYou can apply the samples (examples) from the config/sample:\n\n```sh\nkubectl apply -k config/samples/\n```\n\n\u003e**NOTE**: Ensure that the samples has default values to test it out.\n\n### To Uninstall\n**Delete the instances (CRs) from the cluster:**\n\n```sh\nkubectl delete -k config/samples/\n```\n\n**Delete the APIs(CRDs) from the cluster:**\n\n```sh\nmake uninstall\n```\n\n**UnDeploy the controller from the cluster:**\n\n```sh\nmake undeploy\n```\n\n## Project Distribution\n\nFollowing are the steps to build the installer and distribute this project to users.\n\n1. Build the installer for the image built and published in the registry:\n\n```sh\nmake build-installer IMG=ghcr.io/Dhouib-Mohamed/k8s-auth-operator:tag\n```\n\nNOTE: 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\nits dependencies.\n\n2. Using the installer\n\nUsers can just run kubectl apply -f \u003cURL for YAML BUNDLE\u003e to install the project, i.e.:\n\n```sh\nkubectl apply -f https://raw.githubusercontent.com/Dhouib-Mohamed/k8s-auth-operator/\u003ctag\u003e/dist/install.yaml\n```\n\n## Contributing\nIn order to contribute to this project, please follow the following steps:\n\n1. Fork the repository\n2. Create a new branch (`git checkout -b feature`)\n3. Make the appropriate changes in the files\n4. Add changes to reflect the changes made\n5. Commit your changes (`git commit -am 'Add new feature'`)\n6. Push to the branch (`git push origin feature`)\n7. Create a Pull Request\n8. Get the PR approved\n\n\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 2024.\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%2Fdhouib-mohamed%2Fk8s-auth-operator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdhouib-mohamed%2Fk8s-auth-operator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdhouib-mohamed%2Fk8s-auth-operator/lists"}