DCI downloader module
Project description
DCI Downloader
dci-downloader
is a useful tool for downloading the latest versions of Red Hat products.
TLDR
$ sudo dnf -y install https://packages.distributed-ci.io/dci-release.el8.noarch.rpm
$ sudo dnf -y install dci-downloader
$ source ~/dcirc.sh
$ dci-downloader RHEL-9.2 /tmp/repo
Requirements
Red Hat SSO
DCI is connected to the Red Hat SSO. You will need a Red Hat account.
Remoteci
A remoteci is a Virtual Machine or a baremetal server running RHEL. You should check that your remoteci:
- Is running the latest RHEL 8 release.
- Has enough free space in the destination folder.
- Should be able to reach:
https://api.distributed-ci.io
(443).https://repo.distributed-ci.io
(443).https://registry.distributed-ci.io
(443).
Installation
The dci-downloader
is packaged and available as a RPM files.
$ sudo dnf -y install https://packages.distributed-ci.io/dci-release.el8.noarch.rpm
$ sudo dnf -y install dci-downloader
Configuration
Remoteci creation
DCI is connected to the Red Hat SSO. You need to log in https://www.distributed-ci.io
with your redhat.com SSO account. Your user account will be created in our database the first time you connect.
After the first connection you can create a remoteci. Go to https://www.distributed-ci.io/remotecis and click Create a new remoteci
button. Once your remoteci
is created, you can retrieve the connection information in the Authentication
column. Save those information in ~/dcirc.sh
file.
At this point, you can validate your credentials with the following commands:
$ source ~/dcirc.sh
$ dcictl remoteci-list
If you see your remoteci in the list, everything is working great so far.
Topic access
Before using dci-downloader, we need to check the list of topic (version of the product) you have access to:
$ source ~/dcirc.sh
$ dcictl topic-list
If you don't see any topic then you should contact your EPM at Red Hat which will give you access to the topic you need.
Usage
You can now download the latest version of a product using dci-downloader.
RHEL examples
Example command to download the latest RHEL-9.2 components into /tmp/repo folder.
$ dci-downloader RHEL-9.2 /tmp/repo
RHOSP examples
$ dci-downloader OSP16.1 /tmp/repo
dci-downloader also allows to mirror the container images associated with the component to a local anonymous registry.
$ dci-downloader OSP16.1 /tmp/repo --registry local_registry_host:5000
ℹ NOTE: except when using dci-openstack-agent, it's the user's responsibility to provide a working anonymous registry. If needed a simple way to setup one is by using Docker Distribution registry in a container
$ podman run --rm -p 5000:5000 registry:2
ℹ NOTE: dci-downloader does not currently clean/purge/untag any image on the registry, leaving this responsibility to the the user until a suitable solution is provided.
Options
By default dci-downloader will download all variants for x86_64 architecture without debug RPMs.
Download other architectures
To download other architectures you can specify those using --arch
option
Download x86_64 and ppc64le architectures for RHEL-9.2 topic:
$ dci-downloader RHEL-9.2 /tmp/repo --arch x86_64 --arch ppc64le
Specific variants
To download only specific variants you can specify those using --variant
Download only AppStream and BaseOS variants:
$ dci-downloader RHEL-9.2 /tmp/repo --variant AppStream --variant BaseOS
Filters
By default dci-downloader download the latest components attached to a topic.
But if you want to filter those component, you can use the --filter <type>
or --filter <type>:<tag>
option.
Download only the latest RHEL-9.2 compose
$ dci-downloader RHEL-9.2 /tmp/repo --filter=compose
Download only the latest RHEL-9.2 compose
with tag nightly
$ dci-downloader RHEL-9.2 /tmp/repo --filter=compose:nightly
Download the whole compose
To download everything you can add the --all
flag
$ dci-downloader RHEL-9.2 /tmp/repo --all
Debug RPMs
To download debug RPMs you can add the --debug
flag
Download RHEL-9.2 compose with debug rpms
$ dci-downloader RHEL-9.2 /tmp/repo --debug
Settings file
You can use a settings file to send parameters to parameterize dci-downloader.
Use --settings
parameter:
$ dci-downloader --settings "/etc/dci-rhel-agent/settings.yml"
All settings from settings.yml file will overwrite cli parameters.
Examples of a settings file:
download_folder: /tmp/repo
topics:
- name: RHEL-9.2
filters:
- type: compose
tag: nightly
- name: RHEL-8.6
filters:
- type: compose
tag: milestone
archs:
- ppc64le
variants:
- AppStream
- name: BaseOS
with_debug: true
Proxy
If you are using a proxy, just add HTTP_PROXY
or HTTPS_PROXY
env variable pointing to your proxy.
License
Apache License, Version 2.0 (see LICENSE file)
Help
If something is not working correctly, ensure you have the latest version installed
$ dci-downloader --version
$ dci-downloader --help
To contact DCI see Questions and help
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file dci-downloader-3.2.0.tar.gz
.
File metadata
- Download URL: dci-downloader-3.2.0.tar.gz
- Upload date:
- Size: 19.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3796cc909453489afca7b303b9bc7d59409f281f4c28b08b27a258c13b792766 |
|
MD5 | 3f40c478ee405ef060d79c851072bc44 |
|
BLAKE2b-256 | 18622ae83de9c2ba95ffa09a6629eb8c58abf784dee0b48764a37d082c7676b7 |
File details
Details for the file dci_downloader-3.2.0-py3-none-any.whl
.
File metadata
- Download URL: dci_downloader-3.2.0-py3-none-any.whl
- Upload date:
- Size: 20.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f465f6797926b10731f21080aa4fb22f9354b00caaa221a694079acfcbd16bad |
|
MD5 | ba166de90ece7e7820a5987a020f1a09 |
|
BLAKE2b-256 | 7c2788b14bdc4aa6be961fe9a2eb7e4168b523ad8ea41e77f68b1776245c8f6a |