Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/devatherock/artifactory-badge

Badge generator for docker registries hosted in jfrog artifactory
https://github.com/devatherock/artifactory-badge

artifactory-badge badge-generator jfrog-artifactory

Last synced: about 2 months ago
JSON representation

Badge generator for docker registries hosted in jfrog artifactory

Host: GitHub
URL: https://github.com/devatherock/artifactory-badge
Owner: devatherock
License: mit
Created: 2020-10-17T14:29:36.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2024-10-22T09:09:42.000Z (2 months ago)
Last Synced: 2024-10-23T13:47:19.203Z (2 months ago)
Topics: artifactory-badge, badge-generator, jfrog-artifactory
Language: Groovy
Homepage: https://openapi-viewer.onrender.com?urls.primaryName=artifactory-badge
Size: 604 KB
Stars: 4
Watchers: 1
Forks: 4
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        [![CircleCI](https://circleci.com/gh/devatherock/artifactory-badge.svg?style=svg)](https://circleci.com/gh/devatherock/artifactory-badge)

[![Version](https://img.shields.io/docker/v/devatherock/artifactory-badge?sort=semver)](https://hub.docker.com/r/devatherock/artifactory-badge/)

[![Coverage Status](https://coveralls.io/repos/github/devatherock/artifactory-badge/badge.svg?branch=master)](https://coveralls.io/github/devatherock/artifactory-badge?branch=master)

[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=artifactory-badge&metric=alert_status)](https://sonarcloud.io/component_measures?id=artifactory-badge&metric=alert_status&view=list)

[![Docker Pulls](https://img.shields.io/docker/pulls/devatherock/artifactory-badge.svg)](https://hub.docker.com/r/devatherock/artifactory-badge/)

[![Docker Image Size](https://img.shields.io/docker/image-size/devatherock/artifactory-badge.svg?sort=date)](https://hub.docker.com/r/devatherock/artifactory-badge/)

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

# artifactory-badge

Badge generator for docker registries hosted in jfrog artifactory

## Usage

### Sample command

```

docker run --rm \

  -p 8080:8080 \

  -e ARTIFACTORY_URL=https://some/url \

  -e ARTIFACTORY_API_KEY=xyz \

  devatherock/artifactory-badge:1.1.0

```

### Configurable properties

#### application.yml

```yaml

logger:

  levels:

    io.micronaut.http.server.netty.NettyRequestLifecycle: DEBUG # Optional. To enable HTTP server access logs

```

#### Environment variables

| Name                                 |   Required   | Default                      | Description                                                                                                                                    |

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

| ARTIFACTORY_URL                      |   true       | (None)                       | The JFrog artifactory URL that hosts the docker registry                                                                                       |

| ARTIFACTORY_API_KEY                  |   true       | (None)                       | API key for interacting with artifactory's REST API                                                                                            |

| ARTIFACTORY_EXCLUDED_FOLDERS         |   false      | /_uploads                    | Subfolders to be not treated as docker tags                                                                                                    |

| ARTIFACTORY_DATE_FORMAT              |   false      | yyyy-MM-dd'T'HH:mm:ss.SSSXXX | Date format to parse dates in artifactory API responses                                                                                        |

| ARTIFACTORY_BADGE_SHIELDS_IO_ENABLED |   false      | true                         | Indicates if shields.io should be used to generate the badge                                                  |

| ARTIFACTORY_BADGE_PARALLELISM        |   false      | 5                            | Amount of parallelism to use when fetching details about versions of an image                                                                  |

| LOGGER_LEVELS_ROOT                   |   false      | INFO                         | [SLF4J](http://www.slf4j.org/api/org/apache/commons/logging/Log.html) log level, for all(framework and custom) code                            |

| LOGGER_LEVELS_IO_GITHUB_DEVATHEROCK  |   false      | INFO                         | [SLF4J](http://www.slf4j.org/api/org/apache/commons/logging/Log.html) log level, for custom code                                               |

| MICRONAUT_ENVIRONMENTS               |   false      | (None)                       | Setting the value to `local` will mock the calls to the artifactory. Only for testing purposes                                                 |

| MICRONAUT_SERVER_PORT                |   false      | 8080                         | Port in which the app listens on                                                                                                               |

| MICRONAUT_CONFIG_FILES               |   true       | (None)                       | Path to YAML config files. The YAML files can be used to specify complex, object and array properties                                          |

| LOGBACK_CONFIGURATION_FILE           |   false      | (None)                       | Class, file or remote path to logback configuration file. Will be ignored when using a remote path with any `logger.*` or `LOGGER_` config set |

### API spec

When the app is running, detailed API documentation can be accessed at `{host}/swagger-ui` or `{host}/swagger/artifactory-badge-{version}.yml`. The available endpoints are listed below for reference:

- `/docker/pulls?package=path/to/package` - Generates download count badge

- `/docker/image-size?package=path/to/package` - Generates docker image size badge

- `/docker/layers?package=path/to/package` - Generates docker image layers count badge

- `/version?package=path/to/package` - Generates latest version badge

### Sample badge generated by the custom generator

```xml

    docker pulls: 47

    

        

        

    

    

        

    

    

        

        

        

    

    

         docker pulls 

         47 

    

```

## Troubleshooting

### Enabling debug logs

- Set the environment variable `LOGGER_LEVELS_ROOT` to `DEBUG` to enable all debug logs - custom and framework

- Set the environment variable `LOGGER_LEVELS_IO_GITHUB_DEVATHEROCK` to `DEBUG` to enable debug logs only in custom code

- For fine-grained logging control, supply a custom [logback.xml](http://logback.qos.ch/manual/configuration.html) file 

and set the environment variable `LOGBACK_CONFIGURATION_FILE` to `/path/to/custom/logback.xml`

### JSON logs

Refer [logstash-logback-encoder](https://github.com/logstash/logstash-logback-encoder) documentation to customize the field names and formats in the log. To output logs as JSON, set the environment variable `LOGBACK_CONFIGURATION_FILE` to `logback-json.xml`