A command line tool to help with shipping system addons in Balrog
Перейти к файлу
Rehan Dalal 9f55460bb3
Add configuration options to README
2018-09-18 04:23:49 -04:00
morgoth Major overhaul and add ability to upload to balrog 2018-09-18 01:18:43 -04:00
requirements Major overhaul and add ability to upload to balrog 2018-09-18 01:18:43 -04:00
.gitignore Prep for balrog integration 2017-09-07 04:29:17 -04:00
README.md Add configuration options to README 2018-09-18 04:23:49 -04:00
setup.py Major overhaul and add ability to upload to balrog 2018-09-18 01:18:43 -04:00

README.md

morgoth-cli

A command line tool to help with shipping system addons in Balrog

Installation

Clone the repo locally:

$ git clone https://github.com/rehandalal/morgoth-cli.git

Use pip to install from the repo:

$ cd morgoth-cli
$ pip install --editable .

Note: You can leave out the --editable flag however you will then need to reinstall any time you update the repo.

Configuration

To configure this tool simply run the following command:

$ morgoth init

Note: This command validates your authentication credentials and you will need to be connected to the VPN to successfully run it.

If you change your password/credentials at any point you can use the auth command to make changes to your auth settings:

$ morgoth auth

Additionally if you need to change any other configurations you can simply run:

$ morgoth config [KEY] [VALUE]

For example if you use AWS profile you can configure the profile to use with the following:

$ morgoth config aws.profile my-profile-name

Configuration options

balrog_url: The URL of the Balrog server to use.

username: Your LDAP username.

password: Your LDAP password. (Encrypted using GPG before it is stored)

gpg.homedir: The GPG homedir where your keys are stored.

gpg.fingerprint: The fingerprint of the GPG key you would like to use for encryption.

aws.profile: The name of the AWS profile to use.

aws.prefix: The prefix to be added to the filename in the S3 bucket.

aws.bucket_name: The name of the S3 bucket to use.

aws.base_url: The base public URL for the S3 bucket.