Orchestrator Utilities

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 to get started using orch-utils.

Lint

mage lint:all

Test

mage test:golang

Build

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

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
• Mage
• asdf
• Docker

To build and test orch-utils, first clone the repository:

git clone https://github.com/open-edge-platform/orch-utils orch-utils

cd orch-utils

Then, install the required install tools:

mage asdfPlugins

To build the project, run the build command.

Contribute

To learn how to contribute to the project, see the Contributor's Guide.

Community and Support

To learn more about the project, its community, and governance, visit the Edge Orchestrator Community.

For support, start with Troubleshooting or contact us.

License

Edge Manageability Framework is licensed under Apache 2.0.