Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/keirany/splunk-releases

Collection of utilites for interacting with Splunk Enterprise/Universal forwarders releases.
https://github.com/keirany/splunk-releases

splunk splunk-enterprise splunk-release splunk-universal-forwarder

Last synced: 19 days ago
JSON representation

Collection of utilites for interacting with Splunk Enterprise/Universal forwarders releases.

Host: GitHub
URL: https://github.com/keirany/splunk-releases
Owner: KeiranY
Created: 2020-12-01T23:24:37.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2022-01-08T06:33:34.000Z (almost 3 years ago)
Last Synced: 2024-12-06T21:38:02.773Z (29 days ago)
Topics: splunk, splunk-enterprise, splunk-release, splunk-universal-forwarder
Language: TypeScript
Homepage:
Size: 993 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 4
Metadata Files:
- Readme: readme.md

Awesome Lists containing this project

README

        [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/KeiranY/splunk-releases/Jest%20&%20Codecov?logo=github)](https://github.com/KeiranY/splunk-releases/actions?query=workflow%3A%22Jest+%26+Codecov%22)

[![OpenAPI Verstion](https://img.shields.io/badge/dynamic/json?logo=openapi-initiative&logoColor=FFFFFF&color=success&label=OpenAPI&query=defaultVersion&url=https%3A%2F%2Fapp.swaggerhub.com%2Fapiproxy%2Fregistry%2FKeiranY%2Fsplunk-releases%2F.meta)](https://app.swaggerhub.com/apis-docs/KeiranY/splunk-releases)

[![Codecov](https://img.shields.io/codecov/c/github/KeiranY/splunk-releases)](https://codecov.io/gh/KeiranY/splunk-releases)

[![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/KeiranY/splunk-releases)](https://www.codefactor.io/repository/github/keirany/splunk-releases)

# Splunk Releases

Collection of utilites for interacting with Splunk Enterprise/Universal forwarders releases.

#### Table of Contents

- [Splunk Releases](#splunk-releases)

      - [Table of Contents](#table-of-contents)

  - [Command Line](#command-line)

    - [Usage](#usage)

    - [Flags](#flags)

    - [Environment Variables](#environment-variables)

    - [Example](#example)

  - [Rest API](#rest-api)

    - [Usage](#usage-1)

    - [Environmant Variables](#environmant-variables)

    - [Documentation](#documentation)

## Command Line

The command line utility can be used to retrieve the download link to a Splunk release

### Usage

Run the CLI tool *once* using: `npx github:KeiranY/splunk-releases`

Install the CLI tool with: `npm i -g github:KeiranY/splunk-releases` and run with `sr-cli`.

### Flags

```

$ sr-cli

Usage: cli [options] [command]

Options:

  -p, --platform     platform filter i.e. linux

  -a, --arch             architecture filter i.e x86_64

  -v, --version       version filter i.e 8.1.0

  -f, --filetype     filetype filter i.e tgz

  -r, --product       product filter (enterprise/forwarder)

  -c, --checksum   calculate checksum of download

  -h, --help                   display help for command

Commands:

  search                       (default) search for a splunk release

  download|d [filename]        download a splunk release

  help [command]               display help for command

```

### Environment Variables

Environment variables can also supply filters, cli parameters take precedence over these.

| Environment Variable      | Flag | Example   |

| ------------------------- | ---- | --------- |

| SPLUNKRELEASES_PLATFORM   | -p   | linux     |

| SPLUNKRELEASES_ARCH       | -a   | x86_64    |

| SPLUNKRELEASES_VERSION    | -v   | 8.1.0     |

| SPLUNKRELEASES_FILETYPE   | -f   | tgz       |

| SPLUNKRELEASES_PRODUCT    | -r   | forwarder |

| SPLUNKRELEASES_DOWNLOAD   | -d   | splunk.tgz|

| SPLUNKRELEASES_CHECKSUM   | -c   | md5       |

### Example

![Example of using the splunk releases CLI command](./cli-example.gif)

## Rest API

The REST API lets you retrieve info about splunk release (`/details`) or to download individual releases directly (`/download`).

An example of the API server *may* be running at [sr.keirany.com](https://sr.keirany.com/details?limit=1).

### Usage

Run the CLI tool *once* using: `npx -p github:KeiranY/splunk-releases sr-api`

Install the CLI tool with: `npm i -g github:KeiranY/splunk-releases` and run with `sr-api`.

### Environmant Variables

| Environment Variable | Description     | Default   |

| --- | --- | --- |

| SPLUNKRELEASES_API_MAX_LIMIT | Sets the max number of relases returned in a page | 100 |

| SPLUNKRELEASES_API_DEFAULT_LIMIT | Sets the default number of relases returned in a page | 10 |

| SPLUNKRELEASES_APIPORT | Web server port | Random between 1024-65536 |

| SPLUNKRELEASES_APIRETRIES | Attempts to bind to port |5 |

### Documentation

See the [SwaggerHub Page](https://app.swaggerhub.com/apis-docs/KeiranY/splunk-releases) for documentation and examples for the Rest API (OpenApi3 spec [here](https://app.swaggerhub.com/apis/KeiranY/splunk-releases)).