Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/briantist/galactory

An Ansible Galaxy proxy for Artifactory
https://github.com/briantist/galactory

ansible ansible-galaxy ansible-galaxy-collections artifactory hacktoberfest

Last synced: 12 days ago
JSON representation

An Ansible Galaxy proxy for Artifactory

Host: GitHub
URL: https://github.com/briantist/galactory
Owner: briantist
License: gpl-3.0
Created: 2022-06-03T01:02:01.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-02-27T22:19:25.000Z (10 months ago)
Last Synced: 2024-11-20T20:47:56.674Z (about 1 month ago)
Topics: ansible, ansible-galaxy, ansible-galaxy-collections, artifactory, hacktoberfest
Language: Python
Homepage:
Size: 221 KB
Stars: 33
Watchers: 5
Forks: 7
Open Issues: 31
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rst
- License: LICENSE

Awesome Lists containing this project

README

[![Test](https://github.com/briantist/galactory/actions/workflows/test.yml/badge.svg)](https://github.com/briantist/galactory/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/briantist/galactory/branch/main/graph/badge.svg?token=5ZS2WXM4K9)](https://codecov.io/gh/briantist/galactory)

# galactory
galactory is An Ansible Galaxy proxy for Artifactory.

Using an Artifactory Generic repository as its backend, galactory implements a limited subset of the Galaxy API (v2 & v3) to allow for installing and publishing collections.

It can also be set up to transparently proxy an upstream Galaxy server, storing the pulled artifacts in Artifactory, to be served as local artifacts from then on. This helps avoid throttling errors on busy CI systems, and allows for internal/private collections to declare dependencies on upstream collections (dependencies will only be installed from the same Galaxy server where a collection was installed from).

# Acknowledgements
This project is _heavily_ inspired by [amanda](https://github.com/sivel/amanda/).

# Artifactory compatibility
All features of galactory should work with the free-of-cost Artifactory OSS. Please report any usage that appears to require a Pro license.

# How to use
There isn't any proper documentation yet. The help output is below.

Pulling out this bit about configuration for emphasis:

> Args that start with `--` (eg. `--listen-addr`) can also be set in a config file (`/etc/galactory.d/*.conf` or `~/.galactory/*.conf` or specified via `-c`). Config file syntax allows:
> - `key=value`
> - `flag=true`
> - `stuff=[a,b,c]`
> (for details, see `DefaultConfigFileParser` syntax at https://github.com/bw2/ConfigArgParse#config-file-syntax).
>
> If an arg is specified in more than one place, then commandline values override environment variables which override config file values which override defaults.
>
> `defaults < config < environment variables < command line` (last one found wins)

```text
usage: python -m galactory [-h] [-c CONFIG] [--listen-addr LISTEN_ADDR]
[--listen-port LISTEN_PORT] [--server-name SERVER_NAME]
[--preferred-url-scheme PREFERRED_URL_SCHEME]
--artifactory-path ARTIFACTORY_PATH
[--artifactory-api-key ARTIFACTORY_API_KEY]
[--artifactory-access-token ARTIFACTORY_ACCESS_TOKEN]
[--use-galaxy-key] [--use-galaxy-auth]
[--galaxy-auth-type {api_key,access_token}] [--prefer-configured-key]
[--prefer-configured-auth] [--publish-skip-configured-key]
[--publish-skip-configured-auth] [--log-file LOG_FILE]
[--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--log-headers]
[--log-body] [--proxy-upstream PROXY_UPSTREAM]
[-npns NO_PROXY_NAMESPACE] [--cache-minutes CACHE_MINUTES]
[--cache-read CACHE_READ] [--cache-write CACHE_WRITE]
[--use-property-fallback]
[--health-check-custom-text HEALTH_CHECK_CUSTOM_TEXT]
[--api-version {v2,v3}] [--upload-format {base64,raw,auto}]

galactory is a partial Ansible Galaxy proxy that uploads and downloads collections, using an
Artifactory generic repository as its backend.

optional arguments:
-h, --help show this help message and exit
-c CONFIG, --config CONFIG
The path to a config file. [env var: GALACTORY_CONFIG]
--listen-addr LISTEN_ADDR
The IP address to listen on. [env var: GALACTORY_LISTEN_ADDR]
--listen-port LISTEN_PORT
The TCP port to listen on. [env var: GALACTORY_LISTEN_PORT]
--server-name SERVER_NAME
The host name and port of the server, as seen from clients. Used for
generating links. [env var: GALACTORY_SERVER_NAME]
--preferred-url-scheme PREFERRED_URL_SCHEME
Sets the preferred scheme to use when constructing URLs. Defaults to
the request scheme, but is unaware of reverse proxies.
[env var: GALACTORY_PREFERRED_URL_SCHEME]
--artifactory-path ARTIFACTORY_PATH
The URL of the path in Artifactory where collections are stored.
[env var: GALACTORY_ARTIFACTORY_PATH]
--artifactory-api-key ARTIFACTORY_API_KEY
If set, is the API key used to access Artifactory. If set with artifactory-access-token, this
value will not be used.
[env var: GALACTORY_ARTIFACTORY_API_KEY]
--artifactory-access-token ARTIFACTORY_ACCESS_TOKEN
If set, is the Access Token used to access Artifactory. If set with artifactory-api-key, this
value will be used and the API key will be ignored.
[env var: GALACTORY_ARTIFACTORY_ACCESS_TOKEN]
--use-galaxy-key If set, uses the Galaxy token sent in the request as the Artifactory auth. DEPRECATED: This
option will be removed in v0.11.0. Please use --use-galaxy-auth going forward.
[env var: GALACTORY_USE_GALAXY_KEY]
--use-galaxy-auth If set, uses the Galaxy token sent in the request as the Artifactory auth.
[env var: GALACTORY_USE_GALAXY_AUTH]
--galaxy-auth-type {api_key,access_token}
Auth received via a Galaxy request should be interpreted as this type of auth.
[env var: GALACTORY_GALAXY_AUTH_TYPE]
--prefer-configured-key
If set, prefer the confgured Artifactory auth over the Galaxy token.
DEPRECATED: This option will be removed in v0.11.0.
Please use --prefer-configured-auth going forward.
[env var: GALACTORY_PREFER_CONFIGURED_KEY]
--prefer-configured-auth
If set, prefer the confgured Artifactory auth over the Galaxy token.
[env var: GALACTORY_PREFER_CONFIGURED_AUTH]
--publish-skip-configured-key
If set, publish endpoint will not use configured auth, only auth included in a Galaxy
request.
DEPRECATED: This option will be removed in v0.11.0.
Please use --publish-skip-configured-auth going forward.
[env var: GALACTORY_PUBLISH_SKIP_CONFIGURED_KEY]
--publish-skip-configured-auth
If set, publish endpoint will not use configured auth, only auth included in a Galaxy
request.
[env var: GALACTORY_PUBLISH_SKIP_CONFIGURED_AUTH]
--log-file LOG_FILE If set, logging will go to this file instead of the console.
[env var: GALACTORY_LOG_FILE]
--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
The desired logging level. [env var: GALACTORY_LOG_LEVEL]
--log-headers Log the headers of every request (DEBUG level only).
[env var: GALACTORY_LOG_HEADERS]
--log-body Log the body of every request (DEBUG level only).
[env var: GALACTORY_LOG_BODY]
--proxy-upstream PROXY_UPSTREAM
If set, then find, pull and cache results from the specified galaxy server
in addition to local. [env var: GALACTORY_PROXY_UPSTREAM]
-npns NO_PROXY_NAMESPACE, --no-proxy-namespace NO_PROXY_NAMESPACE
Requests for this namespace should never be proxied. Can be specified
multiple times. [env var: GALACTORY_NO_PROXY_NAMESPACE]
--cache-minutes CACHE_MINUTES
The time period that a cache entry should be considered valid.
[env var: GALACTORY_CACHE_MINUTES]
--cache-read CACHE_READ
Look for upsteam caches and use their values.
[env var: GALACTORY_CACHE_READ]
--cache-write CACHE_WRITE
Populate the upstream cache in Artifactory. Should be false when no auth is
provided or the auth has no permission to write.
[env var: GALACTORY_CACHE_WRITE]
--use-property-fallback
Set properties of an uploaded collection in a separate request after publshinng.
Requires a Pro license of Artifactory. This feature is a workaround for an
Artifactory proxy configuration error and may be removed in a future version.
[env var: GALACTORY_USE_PROPERTY_FALLBACK]
--health-check-custom-text HEALTH_CHECK_CUSTOM_TEXT
Sets custom_text field for health check endpoint responses.
[env var: GALACTORY_HEALTH_CHECK_CUSTOM_TEXT]
--api-version {v2,v3}
The API versions to serve. Can be set to limit functionality to specific versions only.
Defaults to all supported versions.
[env var: GALACTORY_API_VERSION]
--upload-format {base64,raw,auto}
Galaxy accepts the uploaded collection tarball as either raw bytes or base64 encoded.
Ansible 2.9 uploads raw bytes, later versions upload base64. By default galactory will
try to auto-detect. Use this option to turn off auto-detection and force a specific format.
[env var: GALACTORY_UPLOAD_FORMAT]

Args that start with '--' (eg. --listen-addr) can also be set in a config file
(/etc/galactory.d/*.conf or ~/.galactory/*.conf or specified via -c). Config file syntax allows:
key=value, flag=true, stuff=[a,b,c] (for details, see syntax at https://goo.gl/R74nmi). If an arg
is specified in more than one place, then commandline values override environment variables which
override config file values which override defaults.
```

## Install
```shell
python3 -m pip install galactory
```

## Container

Latest tagged release:
```shell
docker run --rm ghcr.io/briantist/galactory:latest --help
```

Latest commit on `main`:
```shell
docker run --rm ghcr.io/briantist/galactory:main --help
```