docker-machine-driver-pnap

README

Docker Machine Driver Plugin for Bare Metal Cloud

Create Docker Machines on Bare Metal Cloud.

Bare Metal Cloud • API • Developers Portal • Knowledge Base • Support

Requirements

• Bare Metal Cloud account
• Go

Creating a Bare Metal Cloud account

1. Go to the Bare Metal Cloud signup page.
2. Follow the prompts to set up your account.
3. Use your credentials to log in to Bare Metal Cloud portal.

▶ Video tutorial: How to Create a Bare Metal Cloud Account in Minutes

▶ Video tutorial: How to Deploy a Bare Metal Server in a Minute

Available functions

• NewDriver(): creates and returns a new instance of the PNAP driver
• getClient(): creates the pnap API Client
• GetCreateFlags(): returns the mcnflag.Flag slice representing the flags that can be set, their descriptions and defaults.
• DriverName(): returns the name of the driver
• SetConfigFromFlags(): configures the driver with the object that was returned by RegisterCreateFlags
• createSSHKey(): creates SSH key
• publicSSHKeyPath(): SSH key path appended with ".pub"
• Create(): creates a host using the driver's config
• GetSSHHostname(): returns hostname for use with ssh
• GetState(): returns the state that the host is in (running, stopped, etc)
• Kill(): force stop host
• Remove(): removes host
• Restart(): restarts host - this may just call Stop(); Start() if the provider does not have any special restart behavior
• Start(): starts host
• Stop(): force stop host
• PreCreateCheck(): allows for pre-create operations to make sure a driver is ready for creation
• GetSSHUsername(): returns username for use with ssh

API Credentials

Follow these steps to obtain your API authentication credentials.

1. Log in to the Bare Metal Cloud portal.
2. On the left side menu, click on API Credentials.
3. Click the Create Credentials button.
4. Fill in the Name and Description fields, select the permissions scope and click Create.
5. In the table, click on Actions and select View Credentials from the dropdown to view the Client ID and Client Secret.

Bare Metal Cloud Quick Start Guide: https://developers.phoenixnap.com/quick-start

Bare Metal Cloud community

Become part of the Bare Metal Cloud community to get updates on new features, help us improve the platform, and engage with developers and other users.

• Follow @phoenixNAP on Twitter
• Join the official Slack channel
• Sign up for our Developers Monthly newsletter

Resources

• Product page
• Instance pricing
• YouTube tutorials
• Developers Portal
• Knowledge Base
• Blog

Documentation

• API documentation

Contact phoenixNAP

Get in touch with us if you have questions or need help with Bare Metal Cloud.

Twitter • Facebook • LinkedIn • Instagram • YouTube • Email