mash-client
overview
mash-client provides a command line utility to interface with the MASH server REST API.
Installation
To install the package use the following commands as root:
$ zypper ar http://download.opensuse.org/repositories/Cloud:/Tools/<distribution>
$ zypper refresh
$ zypper in mash-client
Requirements
- Click
- requests
- PyYaml
- PyJWT
Docs
Usage
Mash user commands
The mash user account is the authentication mechanism of a user against the mash server. It will store information about cloud framework specific account information. The cloud framework account information stored for a given mash user provides the credentials necessary for mash to access a cloud framework account.
mash user create
Create a mash user account.
mash user delete
Delete a mash user account.
mash user info
List information about your user account.
Mash authentication commands
Authentication command are used after a mash user has been created
mash auth login
Login to the mash user account
mash auth logout
Log out of the mash user account
mash auth token
Manage the authentication token
Mash cloud account commands
mash account <framework> add
Add cloud framework account information to the mash user account. Supported s are azure, ec2, and gce.
mash account <framework> delete
Remove cloud framework account information from the mash user account.
mash account <framework> info
Retrieve cloud framework account information from the mash user account.
mash account <framework> list
List all the framework accounts configured for the mash user.
mash account <framework> update
Update information for a cloud framework account for the mash user.
Mash job commands
mash job <framework> add [PATH_TO_JOB_DOC]
Send a job request to the mash server submitting the specified job document. The job document will be validated and a UUID is returned if the job is accepted.
mash job delete
Delete a job from the mash server. If the job is a one time job parts of the job may already be executed and created artifacts are not cleaned up.
mash job info
Retrieve information about a given job in the pipeline.
mash job list
List all the user's job in the mash pipeline.
All commands and subcommands support the --help option to provide command help. For example
mash account azure add --help
Issues/Enhancements
Please submit issues and requests to Github.
Contributing
Contributions to mash-client are welcome and encouraged. See CONTRIBUTING for info on getting started.
License
Copyright (c) 2019 SUSE LLC.
Distributed under the terms of GPL-3.0+ license, see LICENSE for details.
1 maintainer
Release files for mash-client 4.7.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mash_client-4.7.0.tar.gz | 52.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mash_client-4.7.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 103.7 kB
Release files / mash_client-4.7.0.tar.gz
| Download URL | mash_client-4.7.0.tar.gz |
|---|---|
| Size | 52.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
899b2dfa919f57e5767004cb4851a10e81920a9004b2e33986dc8a2a59a950b3
|
|
BLAKE2b-256 checksum How to use checksums |
f38bad7f19400902834f9fb4b5dc949ea313e780a864e60f3053bdd05908d28c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.3
|
Release files / mash_client-4.7.0-py3-none-any.whl
| Download URL | mash_client-4.7.0-py3-none-any.whl |
|---|---|
| Size | 50.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
43cbf06d7398d055e220d9ec3b966d4eb7e585dedd888ddb08c1f8c9f793dbd4
|
|
BLAKE2b-256 checksum How to use checksums |
7d8811f33af0f8b170eebcdd5a2893c22cf0e497d562ced044e875ff7e961bd9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.3
|
