{"id":28444456,"url":"https://github.com/open-edge-platform/orch-utils","last_synced_at":"2025-06-29T17:31:36.811Z","repository":{"id":289149576,"uuid":"958748256","full_name":"open-edge-platform/orch-utils","owner":"open-edge-platform","description":"Utilities of Edge Manageability Framework Orchestrator","archived":false,"fork":false,"pushed_at":"2025-06-19T10:44:28.000Z","size":23065,"stargazers_count":24,"open_issues_count":15,"forks_count":4,"subscribers_count":20,"default_branch":"main","last_synced_at":"2025-06-19T11:37:32.686Z","etag":null,"topics":["deployment","edge","orchestration","utility"],"latest_commit_sha":null,"homepage":"https://docs.openedgeplatform.intel.com/edge-manage-docs","language":"Go","has_issues":false,"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/open-edge-platform.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSES/Apache-2.0.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-01T17:41:39.000Z","updated_at":"2025-06-16T21:26:41.000Z","dependencies_parsed_at":"2025-06-11T22:34:50.210Z","dependency_job_id":"f5233a4c-2f99-47a1-be63-7af38213e174","html_url":"https://github.com/open-edge-platform/orch-utils","commit_stats":null,"previous_names":["open-edge-platform/orch-utils"],"tags_count":98,"template":false,"template_full_name":null,"purl":"pkg:github/open-edge-platform/orch-utils","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-edge-platform%2Forch-utils","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-edge-platform%2Forch-utils/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-edge-platform%2Forch-utils/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-edge-platform%2Forch-utils/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/open-edge-platform","download_url":"https://codeload.github.com/open-edge-platform/orch-utils/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-edge-platform%2Forch-utils/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262637195,"owners_count":23341107,"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":["deployment","edge","orchestration","utility"],"created_at":"2025-06-06T09:09:18.591Z","updated_at":"2025-06-29T17:31:36.801Z","avatar_url":"https://github.com/open-edge-platform.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Orchestrator Utilities\n\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Build](https://github.com/open-edge-platform/orch-utils/actions/workflows/lint-test-build-publish.yml/badge.svg)](https://github.com/open-edge-platform/orch-utils/actions/workflows/lint-test-build-publish.yml)\n[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/open-edge-platform/orch-utils/badge)](https://scorecard.dev/viewer/?uri=github.com/open-edge-platform/orch-utils)\n## Overview\n\nThe orch-utils repository is a crucial component of the Edge Orchestrator, providing various utility functions and tools\nto facilitate the deployment and management of the Edge Orchestrator services. This repository includes utility Helm\ncharts, Dockerfiles, and Go code that support the Edge Orchestrator.\n\nKey features include:\n\n- Kubernetes Jobs: Facilitates deployments such as Harbor/Vault bootstrap and pod security patches.\n- Namespace Creation: Manages the creation of Kubernetes namespaces.\n- Release Service Utilities: Includes tools for token refresh and other release service-related tasks.\n- Policies: Contains Istio and Kyverno policies for security and traffic management.\n- Traefik Routes: Manages Traefik routes for ingress control.\n- Traefik Plugins: Provides Traefik plugins for customizing Traefik behavior.\n- Keycloak Tenant Controller (KTC): Manages multi-tenancy and user authentication.\n- Squid Proxy: Provides a proxy for Edge Nodes in OT networks.\n\n## Get Started\n\nSee the [Documentation](https://docs.openedgeplatform.intel.com/edge-manage-docs/main/index.html) to get started using orch-utils.\n\n### Lint\n\n```sh\nmage lint:all\n```\n\n### Test\n\n```sh\nmage test:golang\n```\n\n### Build\n\n```sh\nmage build:authService\nmage build:awsSmProxy\nmage build:certSynchronizer\nmage build:keycloakTenantController\nmage build:nexusAPIGateway\nmage build:nexusCompiler\nmage build:openAPIGenerator\nmage build:secretsConfig\nmage build:squidProxy\nmage build:tenancyAPIMapping\nmage build:tenancyDatamodel\nmage build:tenancyManager\nmage build:tokenFS\nmage chartsBuild\n```\n\n### Release\n\n```sh\nmage push:authService\nmage push:awsSmProxy\nmage push:certSynchronizer\nmage push:charts\nmage push:keycloakTenantController\nmage push:nexusAPIGateway\nmage push:nexusCompiler\nmage push:openAPIGenerator\nmage push:publicAwsSmProxy\nmage push:publicCharts\nmage push:secretsConfig\nmage push:squidProxy\nmage push:tenancyAPIMapping\nmage push:tenancyDatamodel\nmage push:tenancyManager\nmage push:tokenFs\n```\n\n## Develop\n\nTo develop orch-utils, the following development prerequisites are required:\n\n- [Go](https://go.dev/doc/install)\n- [Mage](https://magefile.org/)\n- [asdf](https://asdf-vm.com/guide/getting-started.html)\n- [Docker](https://docs.docker.com/get-docker/)\n\nTo build and test orch-utils, first clone the repository:\n\n```sh\ngit clone https://github.com/open-edge-platform/orch-utils orch-utils\n\ncd orch-utils\n```\n\nThen, install the required install tools:\n\n```sh\nmage asdfPlugins\n```\n\nTo build the project, run the [build](#build) command.\n\n## Contribute\n\nTo learn how to contribute to the project, see the [Contributor's Guide](https://docs.openedgeplatform.intel.com/edge-manage-docs/main/developer_guide/contributor_guide/index.html).\n\n## Community and Support\n\nTo learn more about the project, its community, and governance, visit the [Edge Orchestrator\nCommunity](https://github.com/open-edge-platform).\n\nFor support, start with [Troubleshooting](https://docs.openedgeplatform.intel.com/edge-manage-docs/main/developer_guide/troubleshooting/index.html) or [contact us](https://github.com/open-edge-platform).\n\n## License\n\nEdge Manageability Framework is licensed under [Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-edge-platform%2Forch-utils","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopen-edge-platform%2Forch-utils","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-edge-platform%2Forch-utils/lists"}