nre-labs-endpoint-images.md

NRE Labs Endpoint Images

The primary purpose of NRE Labs is to provide education on modern network engineering and automation principles. So, while this purpose is often accomplished by including specific tools, software, or other technologies, let us not lose sight of this over-arching mission.

That said, one of the biggest benefits of the NRE Labs platform is to use real software in real environments, spun up on demand, to provide compelling interactive experiences in which this learning can take place. In NRE Labs, we accomplish this through Endpoint Images. These are pre-built docker images that we reference from Lesson definitions to power the learner experience.

If you're looking for technical details on how Endpoint images work, and how to create or add them to the curriculum, please head on over to the Images object reference. The remainder of this document will instead help you understand the higher-level process for dealing with Images within the NRE Labs curriculum, and answer some frequently-asked questions.

Do You Need a New Image?

NRE Labs curriculum images are where all the complexity lies. To make things easy for the learner, we have to take on a lot of the complexity that would normally be on their plate, and instead do it ourselves using prebuilt Docker images, and other tools like endpoint configuration. As a content author, you should be aware that if you choose to go this direction, you need to be willing and able to shoulder this complexity.

In general, new curriculum content like Lessons should take advantage of the Endpoint images that already exist. Images are not meant to be used once, for one lesson - they are meant to be standalone resources that could be used in multiple lessons as the need arises.

There are a few options you should consider before you decide to create a new image. They are, in order:

1. There are a number of existing images that are designed to be very multi-purpose. For instance, the utility image comes with Python and a bunch of automation-related libraries pre-installed.
2. If you just want to share some basic files or scripts into the lesson environment, consider using an existing image like utility, and using NRE Labs' built-in directory mapping to make those files available.
3. Maybe there's an existing image that's just missing a dependency. Consider augmenting an existing image, by simply adding a step to that image's Dockerfile, or maybe a requirements.txt file if applicable.
4. If none of these options work for you, read the Images reference for the technical details on how to create an image. You can contribute a new image on its own, or as part of a content contribution that uses this new image.

Currently the best place to see details on existing images is to look at the NRE Labs curriculum repository manually. In the future, we'll have some better tooling around this.

Commercial Software

NRE Labs is aimed at educating about modern infrastructure engineering processes. While open source software has had a dramatic impact on this space over the last decade (which is well-represented by the presence of open-source in the NRE Labs curriculum) it's not possible for the NRE Labs project to only include open source software. Most infrastructure professionals are not able to avoid commercial software entirely, and neither can this curriculum.

All commercial software in the curriculum will continue to adhere to the Curriculum Quality Standards. Whether open source or commercial, the technology is never the sole focus of the content - it is the skill-sets that a learner can acquire. While we'll continue to have a healthy mix of open and closed software, no matter what, the focus will be on the content and improving the skills of the infrastructure professional.

All contributions that adhere to the spirit of the project are welcome. We already have network operating systems from Juniper, and Cumulus Networks (with more on the way), and software from Red Hat Ansible. This is in addition to the myriad of open source tools and projects that are heavily featured in our curriculum.

Commercial software that has been contributed doesn't have to be publicly downloadable. We have mechanisms in place that allow us to control where the commercial software is distributed, giving the learner access to the software only through the NRE Labs portal. Reach out to us via the community forums or via email for more details on this.