https://github.com/SmartOperatingBlock/automation-management-microservice

This is the repository of the Automation Management microservice of the Smart Operating Block project.
https://github.com/SmartOperatingBlock/automation-management-microservice

agents aop asl automation digital-twins jacamo web-of-things

Last synced: about 2 months ago
JSON representation

This is the repository of the Automation Management microservice of the Smart Operating Block project.

• Host: GitHub
• URL: https://github.com/SmartOperatingBlock/automation-management-microservice
• Owner: SmartOperatingBlock
• License: mit
• Created: 2023-03-13T10:30:17.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-28T18:05:30.000Z (about 2 months ago)
• Last Synced: 2024-07-28T22:33:47.489Z (about 2 months ago)
• Topics: agents, aop, asl, automation, digital-twins, jacamo, web-of-things
• Language: ASL
• Homepage: https://smartoperatingblock.github.io/automation-management-microservice/
• Size: 1.03 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Automation management microservice

![workflow status](https://github.com/smartoperatingblock/automation-management-microservice/actions/workflows/build-and-deploy.yml/badge.svg)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

![Version](https://img.shields.io/github/v/release/smartoperatingblock/automation-management-microservice?style=plastic)

[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=SmartOperatingBlock_automation-management-microservice&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=SmartOperatingBlock_automation-management-microservice)

[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=SmartOperatingBlock_automation-management-microservice&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=SmartOperatingBlock_automation-management-microservice)

[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=SmartOperatingBlock_automation-management-microservice&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=SmartOperatingBlock_automation-management-microservice)

[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=SmartOperatingBlock_automation-management-microservice&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=SmartOperatingBlock_automation-management-microservice)

This is the repository of the Automation Management microservice of the Smart Operating Block project.

## Usage

You need to specify the following environment variable:

- `AZURE_CLIENT_ID`: ID of an Azure AD application

- `AZURE_TENANT_ID`: ID of the application's Azure AD tenant

- `AZURE_CLIENT_SECRET`: the application's client secrets

- `AZURE_DT_ENDPOINT`: the Azure Digital Twins instance endpoint

- `BOOTSTRAP_SERVER_URL`: the kafka connection endpoint

- `CONFIG_PATH`: the path where the microservice can find the configuration for environmental data and automation scenarios.

- `SCHEMA_REGISTRY_URL`: the schema registry url

- `THING_DESCRIPTION_DIRECTORY_BASE_URL`: the base url for the thing description directory. To this base url must be necessary to add only the id of the thing.

If you want to run it via docker container:

1. Provide a `.env` file with all the environment variable described above

2. Run the container with the command:

   ```bash

    docker run ghcr.io/smartoperatingblock/automation-management-microservice:latest

    ```

   1. If you want to pass an environment file whose name is different from `.env` use the `--env-file ` parameter.

   

## Documentation

- Check out the website [here](https://smartoperatingblock.github.io/automation-management-microservice/)

- Direct link to the *Code* documentation [here](https://smartoperatingblock.github.io/automation-management-microservice/documentation/code-doc/)

- Direct link to the *AsyncAPI* documentation [here](https://smartoperatingblock.github.io/automation-management-microservice/documentation/asyncapi-doc)