search

SkylineCommunications / SLC-C-Github-Repositories

A DataMiner connector that can track github repositories.
2 stars 1 forks source link

readme

SLC-Connector-Github-Repositories

Quality Gate Status

A DataMiner connector that retrieves information from github. It's used to monitor repositories.

General

Installation

Manual

You can do a manual install by downloading the .dmprotocol package file from the releases.

  1. Go to releases
  2. Download the .dmprotocol package from the latest version
  3. Install the protocol on your DMA
  4. Create an element that uses the connector
  5. Fill in https://api.github.com as the IP address/host

Features

Configuration

You can configure an API Key under General/Configuration. By default this element runs without an api key. This means that the element can only sent 60 request per hour before being blocked out by Github. To get more request you can add an api key under General/Configuration page. To generate such a token you can go to Github.com -> Settings -> Developer settings -> Personal access tokens -> tokens (classic), to generate one. After setting a personal api key, you'll get 5000 request per hour.

Configuration

You can configure the polling timers under General/Poll Manager. Here you can enable or disable certain calls, do a manual refresh and set the poll frequency.

Poll Manager

Overview

On the Repositories - Overview page you get a tree control that shows all the configured repositories. You can view everything thats tracked from here.

  1. Repository information
  2. Tags
  3. Releases
  4. Issues
  5. Workflows

Repositories - Overview

Organizations

On the Organizations page you get an overview of the organizations the configured token is part of. You can enable repository tracking from this page. This will add all the repositories under the repository to the repositories table and start polling them.

Organizations

Tags

The tags table contains all the tags from all the tracked repositories. Here you can find the tag name the repository it's linked with and the commit ID it was placed on.

Releases

The releases table contains all the releases from all the tracked repositories. Here you can find some general information about the release, for example:

  1. Name
  2. Author
  3. When it was created
  4. ...

Repositories

Issues

The issues table contains all the issues from all the tracked repositories. Here you can find some general information about the issues, for example:

  1. Title
  2. Creator
  3. State (open or closed)
  4. when it was created
  5. ...

Issues

Workflows

The workflows table contains all the workflows from all the tracked repositories. Here you can find some general information about the workflows, for example:

  1. Name
  2. State
  3. Path to the yaml file
  4. when it was created
  5. ...

Workflows

Add Workflow

About DataMiner

DataMiner is a transformational platform that provides vendor-independent control and monitoring of devices and services. Out of the box and by design, it addresses key challenges such as security, complexity, multi-cloud, and much more. It has a pronounced open architecture and powerful capabilities enabling users to evolve easily and continuously.

The foundation of DataMiner is its powerful and versatile data acquisition and control layer. With DataMiner, there are no restrictions to what data users can access. Data sources may reside on premises, in the cloud, or in a hybrid setup.

A unique catalog of 7000+ connectors already exist. In addition, you can leverage DataMiner Development Packages to build you own connectors (also known as "protocols" or "drivers").

Note See also: About DataMiner.

About Skyline Communications

At Skyline Communications, we deal in world-class solutions that are deployed by leading companies around the globe. Check out our proven track record and see how we make our customers' lives easier by empowering them to take their operations to the next level.