{"id":18925172,"url":"https://github.com/exadel-inc/compreface-kubernetes","last_synced_at":"2025-04-15T12:33:11.010Z","repository":{"id":46276764,"uuid":"377152236","full_name":"exadel-inc/compreface-kubernetes","owner":"exadel-inc","description":"Exadel CompreFace Kubernetes configurations","archived":false,"fork":false,"pushed_at":"2021-11-03T12:15:10.000Z","size":32,"stargazers_count":10,"open_issues_count":4,"forks_count":8,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-28T21:35:18.257Z","etag":null,"topics":["compreface","docker","face-detection","face-recognition","face-verification","hacktoberfest","kubernetes","kubernetes-configs"],"latest_commit_sha":null,"homepage":"https://exadel.com/solutions/compreface/","language":null,"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/exadel-inc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-06-15T12:18:10.000Z","updated_at":"2025-03-04T05:21:52.000Z","dependencies_parsed_at":"2022-09-05T22:50:22.384Z","dependency_job_id":null,"html_url":"https://github.com/exadel-inc/compreface-kubernetes","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exadel-inc%2Fcompreface-kubernetes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exadel-inc%2Fcompreface-kubernetes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exadel-inc%2Fcompreface-kubernetes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exadel-inc%2Fcompreface-kubernetes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/exadel-inc","download_url":"https://codeload.github.com/exadel-inc/compreface-kubernetes/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249072590,"owners_count":21208212,"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":["compreface","docker","face-detection","face-recognition","face-verification","hacktoberfest","kubernetes","kubernetes-configs"],"created_at":"2024-11-08T11:09:50.966Z","updated_at":"2025-04-15T12:33:10.751Z","avatar_url":"https://github.com/exadel-inc.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# CompreFace-kubernetes\n\nCompreFace Kubernetes repository contains scripts and instructions that help deploy [Exadel CompreFace](https://github.com/exadel-inc/CompreFace) face recognition system in Kubernetes cluster.\n\n# Deployment on Minikube\nThis tutorial shows how to deploy CompreFace on Minikube\n\n1. (optional) create namespace and switch context\n```commandline\nkubectl apply -f minikube/0-ns.yaml\n```\n\n```commandline\nkubectl config set-context --current --namespace=compreface\n```\n\n2. Deploy db\n```commandline\nkubectl apply -f minikube/1-db.yaml\n```\n\n3. Deploy CompreFace modules\n```commandline\nkubectl apply -f minikube/2-core.yaml -f minikube/3-api.yaml -f minikube/4-admin.yaml -f minikube/5-fe.yaml\n```\n\n4. For expose to network run on host\n```commandline\nminikube service compreface-ui\n```\n\n# Helm Chart\nThis tutorial shows how to deploy CompreFace using Helm. To use helm you need to install it first, see the instructions [here](https://helm.sh/docs/intro/install/)\n\nAll necessary templates and values.yaml for helm chart you can find in the `helm-config` folder\n\n1. Install compreface chart. It will deploy the whole CompreFace application\n```commandline\nhelm install compreface-kubernetes ./helm-config --namespace compreface --create-namespace\n```\n\n2. Run minikube service for public access from your browser\n```commandline\nminikube service compreface-ui -n compreface\n```\n\n3. Delete compreface chart. It will terminate CompreFace application\n```commandline\nhelm delete compreface-kubernetes -n compreface\n```\n# Deployment on AWS\nThis tutorial shows how to install face recognition system CompreFace on AWS EKS cluster.\n\n1. Create EKS cluster (replace subnets from given aws account)\n```commandline\neksctl create cluster --name test --version 1.21 --region eu-west-1 --nodegroup-name standard-node --node-type t2.large --nodes 1 --nodes-min 1 --nodes-max 1 --managed --vpc-public-subnets subnet-4aee0001,subnet-73207829,subnet-fee6f998\n```\n\n2. Deploy application\n```commandline\nhelm install compreface-kubernetes ./helm-config --namespace compreface --create-namespace\n```\n\n3. Delete application\n```commandline\nhelm delete compreface-kubernetes -n compreface\n```\n\n4. Delete EKS cluster\n```commandline\neksctl delete cluster --name test\n```\n# CloudFormation\nCompreFace yaml file can be used for deploying CompreFace solution based on predefined AMIs image with CompreFace application inside\nIn current template ImageId: ami-0d3846ebc1bd6748e (us-east-1). It contains CompreFace release 0.6.0\n\nTo create stack you need to pass the KeyPair parameter of existing SSH key.\nStack will create separate VPC, subnet, route table, security group, EC2 instance with running CompreFace application on 8000 port.\n```commandline\naws cloudformation create-stack --stack-name myteststack --template-body file://CompreFace.yml --parameters ParameterKey=KeyName,ParameterValue=IharB\n```\nIn the outputs section of stack you will see public ip of CompreFace application.\n\nTo delete stack and all recently created resources:\n```commandline\naws cloudformation delete-stack --stack-name myteststack\n```\n\n# Contributing\n\nWe want to improve our open-source face recognition solution, so your contributions are welcome and greatly appreciated.\n\n* Just use CompreFace kubernetes and [report](https://github.com/exadel-inc/compreface-kubernetes/issues) ideas and bugs on GitHub\n* Share knowledge and experience via posting guides and articles, or just improve our [documentation](https://github.com/exadel-inc/compreface-kubernetes)\n* Add other kubernetes configs and tutorials. We will add it to our documentation\n* And last, but not least, you can just give a star to our facial recognition kubernetes repository\n\nAfter creating your first contributing pull request, you will receive a request to sign our Contributor License Agreement by commenting your pull request with a special message.\n\n### Report Bugs\n\nPlease report any bugs [here](https://github.com/exadel-inc/compreface-kubernetes/issues).\n\nIf you are reporting a bug, please specify:\n\n- Your operating system name and version\n- kubernetes version\n- CompreFace version\n- Any details about your local setup that might be helpful in troubleshooting\n- Detailed steps to reproduce the bug\n\n\n### Submit Feedback\n\nThe best way to send us feedback is to file an issue at https://github.com/exadel-inc/compreface-kubernetes/issues.\n\nIf you are proposing a feature, please:\n\n- Explain in detail how it should work.\n- Keep the scope as narrow as possible to make it easier to implement.\n\n\n# License info\n\nCompreFace Kubernetes is released under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0.html).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexadel-inc%2Fcompreface-kubernetes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fexadel-inc%2Fcompreface-kubernetes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexadel-inc%2Fcompreface-kubernetes/lists"}