View and spend compute available Alces Fligtht Center compute credits
The following are required to run this application:
- OS: Centos7
- Ruby: 2.6+
- Bundler
The following can be used to quickly install charge client with a single curl. It assumes that an appropriate version of git, ruby, and bundle are available on the path. Without these applications the boot-strapping script will fail. Ruby can be installed using flight runway or rvm.
The script will automatically configure the application to connect to the remote service. The only required configuration parameter is the CHARGE_CLIENT_JWT which will be used to set the authorization token. Please contact the Alces Flight Center support team on how to generate this token.
curl https://raw.githubusercontent.com/alces-flight/charge-client/master/scripts/bootstrap.sh | CHARGE_CLIENT_JWT=<token> bash
This script may be customised with various configuration parameters as follows:
CHARGE_CLIENT_BRANCH: The branch/ tag to install Default: The lastest release (not master)CHARGE_CLIENT_URL: The API base URL Default: https://center.alces-flight.comCHARGE_CLIENT_INSTALL_DIR: The install directory Default: /opt/flight/opt
These parameters are solely used by the bootstrapping script and are not required by the main application.
Start by cloning the repo, adding the binaries to your path, and install the gems:
git clone https://github.com/alces-flight/charge-client
cd charge-client
bundle install --without development test --path vendor
These application needs configuration parameters to setup the connection to the remote server. Refer to the reference config for the required keys. The configs needs to be stored within etc/config.yaml.
cd /path/to/client
touch etc/config.yaml
vi etc/config.yaml
To view the current compute unit balance:
bin/flight-cu balance
To spend compute unit:
bin/flight-cu spend 1000 'Client facing reason why the charge occurred'
To add a hidden reason for administrators:
bin/flight-cu spend 1000 'Client facing message' 'Hidden message that only admins can see'
Fork the project. Make your feature addition or bug fix. Send a pull request. Bonus points for topic branches.
Read CONTRIBUTING.md for more details.
Eclipse Public License 2.0, see LICENSE.txt for details.
Copyright (C) 2019-present Alces Flight Ltd.
This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at https://www.eclipse.org/legal/epl-2.0, or alternative license terms made available by Alces Flight Ltd - please direct inquiries about licensing to licensing@alces-flight.com.
Charge Client is distributed in the hope that it will be useful, but WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. See the Eclipse Public License 2.0 for more details.