ForemanProxmox

Build Status Maintainability Test Coverage

ForemanProxmox

Foreman plugin that adds Proxmox compute resource: managing virtual machines and containers using the fog-proxmox module.

It is intended to satisfy this feature.

Compatibility

Tested with:

  • Foreman = 1.17.1
  • Fog-proxmox >= 0.4.0

Installation

Gem

gem install the_foreman_proxmox

You can see it in about foreman page:

About resources About greffon

Packages

Deb, yum, rpm: work in progress...

Please see the Foreman manual for complete instructions:

Usage

Development

You need a Proxmox VE >= 5.1 server running.

  • Fork this github repo.
  • Clone it on your local machine

To install the plugin with foreman in a Docker container, move to the source code:

cd foreman_proxmox

Build a docker container:

sudo docker build -t foreman .

If you are behind a proxy http server, add:

--build-arg http_proxy=http://<user>:<password>@<ip>:<port>
...

Run it:

sudo docker run -it -p 3808:5000 --name foreman foreman

Access container's bash console:

sudo docker exec -it foreman bash

The docker container use ruby 2.3.7, latest nodejs 8.x (8.11.2) and foreman 1.17.1.

If you want to debug live. You have to clone foreman 1.17.1 repo and install foreman_proxmox plugin as gem. See how to create a foreman plugin

Contributing

You can reach the contributors. Bug reports and pull requests are welcome on GitHub at ForemanProxmox. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Please read how to contribute.

License

The code is available as open source under the terms of the GNU Public License v3.

Code of Conduct

Everyone interacting in the ForemanProxmox project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.