# device-kit-ntp-service

**Repository Path**: industrial-edge/device-kit-ntp-service

## Basic Information

- **Project Name**: device-kit-ntp-service
- **Description**: IE Device Kit API reference implementation for ntp service
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2022-12-08
- **Last Updated**: 2023-01-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Introduction

The IE Device Kit API provides the abstraction layer that decouples the Industrial Edge Runtime from the underlying Linux systems. This allows to adapt the runtime and its behavior to serve for the specific needs of different Industrial Edge products. 

The IE Device Kit API is based on gRPC which provides a modern intermediate process communication style for building distributed applications and microservices. The Industrial Edge platform provides and maintains the protobuf specification files for the APIs contained in the IE Device Kit. These protobuf specifications can be used to create stub implementations for both client and server in various programming languages. The Industrial Edge Runtime ships with a client side implementation of these APIs and expects the host system to provide a server side implementation.

Purpose of these repositories is to share reference implementation of IE Device Kit APIs. You can use existing implementation or adapt it based on your needs.
# IEDK Ntp Service

NTP Service is a gRPC & Go based NTP configurator microservice for Edge Devices.

## Overview

_Ntp Service_ is developed in the go programming language and gRPC. More information can be found [here](https://grpc.io/docs/). The Ntp service runs as a systemd service within the device that has a debian-based operating system.

## Getting Started

### Prerequisities

> - Setting up Go
> - Additional requirements to _run_ or _develop_ the project

### Building the service and know-how about other features

> Instructions how to build the deb package:
>
> - For generating a deb package, [goreleaser](https://goreleaser.com/intro/) tool is heavily used. For proper execution, goreleaser needs a TAG identifier which indicates version of the deb package. TAG must obey the semantic versioning rules and must include ${major}.${minor}.${hotfix} release identifiers. Only two commands are needed for generating deb package: `cd build/package`, `TAG=X.Y.Z make deb` After running these commands, a __dist__ directory will be created under the __build/package__ directory and the deb package will be in dist directory. To install this generated deb package on the device as a daemon `cd dist`, `sudo apt install ./dm-ntp_X.Y.Z_linux_amd64.deb`
>
> Instructions how to use the make command:
>
> - There is a Makefile file under the __build/package__ directory. Unit tests, code coverage and many other similar features can be used via this Makefile. The following commands are used to view all features: `cd build/package`, `make help`

### Running the service

> To see the status and logs of the deb package running as daemon(systemd service) directly from the command line, the following commands are run: `systemctl status dm-ntp`, `journalctl -fu dm-ntp`

## FAQ

### How do I verify dependencies and download them?

The ntp microservice is dependent on the ntp service and the ntpdate binary. The following command is run to verify that these dependencies exist within the device.

```bash
dpkg -l | egrep "ii  ntp|ii  ntpdate"
```

If you get an output after running the command, these dependencies already installed on device.

If these dependencies are not installed in the device, installation can be performed with the following commands.

```bash
sudo apt-get update
sudo apt-get install ntp
sudo apt-get install ntpdate
```

# Contributing IE Device Kit Repository
Please check our [contribution guideline](CONTRIBUTING.md). 

# Contribution License Agreement
Please check [CLA](Siemens_CLA_1.1.pdf)

# How to be part of Siemens Industrial Edge Ecosystem
Please check [this](https://new.siemens.com/global/en/products/automation/topic-areas/industrial-edge.html) page to learn more information about Industrial Edge.