Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 2.97 KB

README.md

File metadata and controls

48 lines (32 loc) · 2.97 KB
Raw

Skycoin Official Images "Extended Information"

This repository includes the "metadata" or "Extended Information" for all the official images of the Skycoin project; also host the script to make that possible.

The metadata is scraped and parsed with the help of repo-info tools

Updating Skycoin repository metadate

Supported environments and assumptions

  • The workspace is assumed to be any recent Linux or MacOS, no Windows instructions yet
  • It is recommended to have at least 10GB of free space in the partition used used by Docker to store container data.
  • A minimum of 2Mbit per second (256Kbyte/s) bandwidth is recommended. Otherwise the update process will take non-trivial time.
  • It is necessary to install a git client in advance, and configure it to push commits to Github an behalf of a Github account.

Initial steps

The following one-time configuration is required prior to scraping image metadata.

  1. Log into github.com
  2. Configure your SSH client
  3. Follow the steps in Github guide to setup SSH keys
  4. Navigate to this repository at https://github.com/skycoin/repo-info
  5. Fork it under the Github account namespace of your preference. Beware of the SSH clone URL e.g. [email protected]:simelo/skycoin-repo-info.git.
  6. Clone your fork e.g. git clone [email protected]:simelo/skycoin-repo-info.git

Updating the info

  1. Change working directory to repository folder to start working on it e.g. cd skycoin-repo-info
  2. Run the update script ./update.sh
  3. Once the script finishes it's job is time to review the data. Just git diff and review the new and modified files, if you spot an omission or a blank file: just repeat the last step.
  4. If all the data is ok, then commit it & push your data to your repository fork.
  5. Submit a pull request against the main skycoin/repo-info repository.

After these steps wait for feedback from the community for your changes to be merged with upstream branch.

Understanding update script

The update script will take care of the following tasks:

  • Download repo-info tools utility
  • Search and gather all the Docker images published in the Skycoin's dockerhub organization.
    • "Relevant images" are the ones with at least one of the following tags latest, develop, release, arm & dind this list can be widened on demand tweaking it on the update.sh script
  • Iterate over each repository and its tags to scrape requested metadata
    • This effectively downloads the images and extracts metadata from them (local) and also by issuing requests to Docker Hub API (remote)

If your internet speed is low; updating might take a while and connection issues can lead to incomplete/broken information. Errors will be reported in the logs.