Deployment and Scheduling tool for Bare Metal

Overview

This is a simple tool to provision bare metal machines using OpenStack Bare Metal Service (ironic) and, optionally, OpenStack Image Service (glance) and OpenStack Networking Service (neutron).

Please note the Metalsmith project is in maintenance mode and it’s functionality is slowly being introduced into Ironic’s API and usual clients. No additional features are expected to be added to metalsmith directly.

• License: Apache License, Version 2.0

• Documentation: https://docs.openstack.org/metalsmith/

• Source: https://opendev.org/openstack/metalsmith

• Bugs: https://bugs.launchpad.net/metalsmith/+bugs

Installation

pip install --user metalsmith

Note

The current versions of metalsmith require Bare Metal API from the Stein release or newer. Use the 0.11 release series for older versions.

Contributing

• Pull requests: Gerrit (see developer’s guide)

• Bugs and RFEs: Launchpad (please do NOT report bugs to Github)

Python API

The main entry point to the API is metalsmith.Provisioner.

• metalsmith package
  • Submodules
    • metalsmith.exceptions module
    • metalsmith.instance_config module
    • metalsmith.sources module
    • metalsmith.version module
  • Module contents
    • Instance
    • InstanceState
    • Provisioner

Command-Line Interface

• metalsmith CLI
  • Deploy Command
  • Undeploy Command
  • See Also

Ansible Role

• Role - metalsmith_deployment
  • Variables
  • Instance
  • Example
• Module - metalsmith_instances
  • Module Documentation
  • Example Tasks

Indexes

• Index

• Module Index

• Search Page