Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zhmcclient/golang-zhmcclient
A GoLang client library for the IBM Z HMC Web Services API
https://github.com/zhmcclient/golang-zhmcclient
Last synced: 21 days ago
JSON representation
A GoLang client library for the IBM Z HMC Web Services API
- Host: GitHub
- URL: https://github.com/zhmcclient/golang-zhmcclient
- Owner: zhmcclient
- License: apache-2.0
- Created: 2023-09-25T05:39:35.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-02-26T03:16:46.000Z (10 months ago)
- Last Synced: 2024-02-26T04:29:32.214Z (10 months ago)
- Language: Go
- Homepage:
- Size: 409 KB
- Stars: 3
- Watchers: 3
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# golang-zhmcclient
zhmcclient - A golang client library for the IBM Z HMC Web Services API
## Generate Fake APIs
```bash
cd ./pkg/zhmcclient
go get github.com/maxbrunsfeld/counterfeiter/v6
export COUNTERFEITER_NO_GENERATE_WARNING=true
go generate ./...
```
## Build
```bash
make sample-build
make sample-build-mac
make sample-build-docker
```
## Unit Test
```bash
# 'FILE' corresponds to the filename w/o .go extentsion
# 'PKG' package to be tested
# If only PKG is provided all files (go modules) under the package will be tested
make unit-test PKG=pkg/zhmcclient FILE=lpar
```
## Sample Usage
```bash
make sample-build
export HMC_ENDPOINT="https://192.168.195.118:6794"
export HMC_USERNAME=${username}
export HMC_PASSWORD=${password}
./bin/sample
```
or
```bash
make sample-build-mac
export HMC_ENDPOINT="https://192.168.195.118:6794"
export HMC_USERNAME=${username}
export HMC_PASSWORD=${password}
./bin/sample-mac
```
## Contributing
Third party contributions to this project are welcome!
In order to contribute, create a [Git pull request](https://help.github.com/articles/using-pull-requests/), considering this:
* Test is required.
* Each commit should only contain one "logical" change.
* A "logical" change should be put into one commit, and not split over multiple
commits.
* Large new features should be split into stages.
* The commit message should not only summarize what you have done, but explain
why the change is useful.
* The commit message must follow the format explained below.
What comprises a "logical" change is subject to sound judgement. Sometimes, it
makes sense to produce a set of commits for a feature (even if not large).
For example, a first commit may introduce a (presumably) compatible API change
without exploitation of that feature. With only this commit applied, it should
be demonstrable that everything is still working as before. The next commit may
be the exploitation of the feature in other components.
For further discussion of good and bad practices regarding commits, see:
- [OpenStack Git Commit Good Practice](https://wiki.openstack.org/wiki/GitCommitMessages)
- [How to Get Your Change Into the Linux Kernel](https://www.kernel.org/doc/Documentation/process/submitting-patches.rst)
## License
The zhmcclient package is licensed under the [Apache 2.0 License](https://github.com/zhmcclient/golang-zhmcclient/blob/master/LICENSE).