GitXplorerGitXplorer
a

jec

public
1 stars
4 forks
2 issues

Commits

List of commits on branch master.
Verified
2e94053f3df8d85d004bac38bbb7eb8da5ce61b0

Merge pull request #11 from atlassian/BIF-Fix-upload-artifact

eertugrulsmz committed 7 days ago
Unverified
4107e3a774d0b403dbfd82f1080eff8b3877e021

BIF- Fix deprecation notice from github

eertugrulsmz committed 7 days ago
Verified
d3dbce0c959dbec8e5cd64579d25d4ba3587c88c

Merge pull request #7 from atlassian/BIF-1093

mmetehanozturk committed 4 months ago
Unverified
e856cc0c6c23e11f524c00d46a45357991b4b23e

Remove macos tests

mmetehanozturk committed 4 months ago
Unverified
c7405450fcc1d1f88b2bfaec38c100bacc3e7515

BIF-1121 Add an example script to read payload and to send callback

mmetehanozturk committed 4 months ago
Unverified
f2156b876e88574d4c99a583f3fa8f67df55eccc

BIF-1093 Send configuration failure callbacks back to JSM

mmetehanozturk committed 6 months ago

README

The README file for this repository.

JIRA EDGE CONNECTOR

Atlassian license Build Status Coverage Status Go Report Card GoDoc PRs Welcome

Jira Edge Connector (JEC) is a lightweight application that provides:

  • Jira Service Management integration for systems that don't need the inbound internet
  • Ability to run executables and scripts triggered by Jira Service Management
  • Deployment on-premises or in the customer’s cloud environment

JEC integrates with a number of monitoring and ITSM tools, allowing Jira Service Management to send actions back to keep various toolsets in sync across the organization. JEC also hosts custom scripts that can be executed remotely.

Supported Script Technologies

JEC includes support for running Groovy, Python and Go scripts, along with any .sh shell script or executable.

JEC supports environment variables, arguments, and flags that are passed to scripts. These can be set globally for all scripts or locally on a per script basis. Stderr and stdout options are also available.

Support for Git

JEC provides the ability to retrieve files from Git.

Configuration files for JEC can be maintained in Git to ensure version control. Likewise, scripts and credentials can be kept in Git and retrieved when needed so that credentials are not stored locally.

Installation

Environment Variables

Prerequisites

For setting configuration file properties such as location and path:

  • First, you should set some environment variables for the locate configuration file. There are two options here, you can get the configuration file from a local drive or by using git.

For reading configuration files from a local drive:

  • Set JEC_CONF_SOURCE_TYPE and JEC_CONF_LOCAL_FILEPATH variables.

From reading configuration files from a git repository:

  • Set JEC_CONF_SOURCE_TYPE, JEC_CONF_GIT_URL, JEC_CONF_GIT_FILEPATH, JEC_CONF_GIT_PRIVATE_KEY_FILEPATH, and JEC_CONF_GIT_PASSPHRASE variables.

If you are using a public repository, you should use an https format of a git url and you do not need to set private key and passphrase.

For more information, you can visit JEC documentation page // TODO: Add link

Flag

Prometheus default metrics can be grabbed from http://localhost:<port-number>/metrics

To run multiple JEC in the same environment, -jec-metrics flag should be set as distinct port number values. -jec-metrics <port-number>

Logs

JEC log file is located:

  • On Windows: var/log/jec/jec<pid>.log
  • On Linux: /var/log/jec/jec<pid>.log
  • At the end of the file name of the log, there is program identifier (pid) to identify which process is running.

Configuration File

JEC supports json and yaml file extension with fields.

For definition of all fields which should be provided in configuration file, you can visit JEC documentation page // TODO: Add link

Usage

You can run executable that you build according the building JEC executables section.

JEC_CONF_SOURCE_TYPE=LOCAL JEC_CONF_LOCAL_FILEPATH=$JEC_FILE_PATH ./main

Also you can run JEC by using Docker. For more information, please visit documentation // TODO: Add link

Tests

You can run tests with go test

Contributions

Contributions to JEC are welcome! Please see CONTRIBUTING.md for details.

License

Copyright (c) 2023 Atlassian US., Inc. Apache 2.0 licensed, see LICENSE file.


With �� from Atlassian