Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

nvidia

A puppet module for installing NVIDIA GPU drivers, which also can detect and install the latest version.
Project URLRSS FeedReport issues

6,450 downloads

6,413 latest version

4.9 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 1.0.1 (latest)
  • 1.0.0 (deleted)
released Jan 3rd 2018
This version is compatible with:
  • Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.7.0
  • ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'rgb-nvidia', '1.0.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add rgb-nvidia
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install rgb-nvidia --version 1.0.1

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

rgb/nvidia — version 1.0.1 Jan 3rd 2018

nvidia

Table of Contents

  1. Description
  2. Setup - The basics of getting started with nvidia
  3. Usage - Configuration options and additional functionality
  4. Reference - An under-the-hood peek at what the module is doing and how
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module

Description

This module automates the installation of the closed source nvidia drivers.

The module allows you to specify which version you want to install, but it is also able to automatically detect the latest version.

The open source drivers NVIDIA drivers should always be replaced with the closed source drivers used for maximum GPU performance. For more information about open source vs. closed source NVIDIA drivers, see https://help.ubuntu.com/community/BinaryDriverHowto/Nvidia

Setup

Setup Requirements

A NVIDIA GPU must be present in order to install the drivers. If no NVIDIA GPU is detected the installation will fail.

Windows: If GPU drivers have already been installed from somewhere else than the Chocolatey package repository, please uninstall those drivers before using this module.

Beginning with nvidia

Usage

Install the lastest NVIDIA drivers:

include nvidia

Install a specific version of the NVIDIA drivers:

class { 'nvidia':
  version => 375
}

Reference

Parameters

  • version
  • Possible values are 'latest' or any valid Number.
  • Default value is latest.
  • Use this parameter if you want to install a specific version of the drivers.
  • When specifying version, it is recommended to check that the parameter being passed is a valid version that is available in the package repositories. If the version is not available the installation will fail.

On Ubuntu the latest version is detected with the 'apt-cache pkgnames nvidia-' command paired with a regular expression.

Driver origin

The drivers being installed are the closed-source drivers from NVIDIA, retrieved from the package repositories Restricted (on Ubuntu) and Chocolatey (on Windows).

The Restricted repository is an official Ubuntu repository used for packages where the source-code is not open. Read more about the repository here: https://help.ubuntu.com/community/Repositories#Restricted

Chocolatey is one of the most popular package repositories for Windows. Read more about the NVIDIA driver package on https://chocolatey.org/packages/nvidia-display-driver

Limitations

  • Supported operating systems are:
  • Ubuntu 14.04 and 16.04
  • Other versions of Ubuntu are probably also supported, but have not been tested.
  • Windows 7, 8, 10 and Server 2016.
  • Supported puppet versions are 4.7.0 and above.

On Ubuntu, a reboot might be required in order to use the new drivers after they have been installed.

The module detects if a NVIDIA GPU is present by looking at the PCI vendor ID of all the GPUs. It might not function correctly if both AMD and NVIDIA GPUs are present.

Development

Everyone is welcome to contribute to the module, for instance by making a pull request.

Please report any issues that you experience, as long as they have not already been reported.