https://github.com/open-edge-platform/orch-utils
Utilities of Edge Manageability Framework Orchestrator
https://github.com/open-edge-platform/orch-utils
deployment edge orchestration utility
Last synced: 9 months ago
JSON representation
Utilities of Edge Manageability Framework Orchestrator
- Host: GitHub
- URL: https://github.com/open-edge-platform/orch-utils
- Owner: open-edge-platform
- Created: 2025-04-01T17:41:39.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-06-19T10:44:28.000Z (9 months ago)
- Last Synced: 2025-06-19T11:37:32.686Z (9 months ago)
- Topics: deployment, edge, orchestration, utility
- Language: Go
- Homepage: https://docs.openedgeplatform.intel.com/edge-manage-docs
- Size: 22 MB
- Stars: 24
- Watchers: 20
- Forks: 4
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSES/Apache-2.0.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Orchestrator Utilities
[](https://opensource.org/licenses/Apache-2.0) [](https://github.com/open-edge-platform/orch-utils/actions/workflows/lint-test-build-publish.yml)
[](https://scorecard.dev/viewer/?uri=github.com/open-edge-platform/orch-utils)
## Overview
The orch-utils repository is a crucial component of the Edge Orchestrator, providing various utility functions and tools
to facilitate the deployment and management of the Edge Orchestrator services. This repository includes utility Helm
charts, Dockerfiles, and Go code that support the Edge Orchestrator.
Key features include:
- Kubernetes Jobs: Facilitates deployments such as Harbor/Vault bootstrap and pod security patches.
- Namespace Creation: Manages the creation of Kubernetes namespaces.
- Release Service Utilities: Includes tools for token refresh and other release service-related tasks.
- Policies: Contains Istio and Kyverno policies for security and traffic management.
- Traefik Routes: Manages Traefik routes for ingress control.
- Traefik Plugins: Provides Traefik plugins for customizing Traefik behavior.
- Keycloak Tenant Controller (KTC): Manages multi-tenancy and user authentication.
- Squid Proxy: Provides a proxy for Edge Nodes in OT networks.
## Get Started
See the [Documentation](https://docs.openedgeplatform.intel.com/edge-manage-docs/main/index.html) to get started using orch-utils.
### Lint
```sh
mage lint:all
```
### Test
```sh
mage test:golang
```
### Build
```sh
mage build:authService
mage build:awsSmProxy
mage build:certSynchronizer
mage build:keycloakTenantController
mage build:nexusAPIGateway
mage build:nexusCompiler
mage build:openAPIGenerator
mage build:secretsConfig
mage build:squidProxy
mage build:tenancyAPIMapping
mage build:tenancyDatamodel
mage build:tenancyManager
mage build:tokenFS
mage chartsBuild
```
### Release
```sh
mage push:authService
mage push:awsSmProxy
mage push:certSynchronizer
mage push:charts
mage push:keycloakTenantController
mage push:nexusAPIGateway
mage push:nexusCompiler
mage push:openAPIGenerator
mage push:publicAwsSmProxy
mage push:publicCharts
mage push:secretsConfig
mage push:squidProxy
mage push:tenancyAPIMapping
mage push:tenancyDatamodel
mage push:tenancyManager
mage push:tokenFs
```
## Develop
To develop orch-utils, the following development prerequisites are required:
- [Go](https://go.dev/doc/install)
- [Mage](https://magefile.org/)
- [asdf](https://asdf-vm.com/guide/getting-started.html)
- [Docker](https://docs.docker.com/get-docker/)
To build and test orch-utils, first clone the repository:
```sh
git clone https://github.com/open-edge-platform/orch-utils orch-utils
cd orch-utils
```
Then, install the required install tools:
```sh
mage asdfPlugins
```
To build the project, run the [build](#build) command.
## Contribute
To 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).
## Community and Support
To learn more about the project, its community, and governance, visit the [Edge Orchestrator
Community](https://github.com/open-edge-platform).
For 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).
## License
Edge Manageability Framework is licensed under [Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0).