User Tools

Site Tools


Sidebar

NetYCE Documentation


Downloads

Release notes

Setup

NetYCE accounts



menu:build:osversions

OS-Repository

Overview

The os repo form allows you to manage the OS images that are used for OS upgrades. The os files are stored in the /var/opt/yce/public/os files, categorized by vendor type, which can then be used in OS upgrade scenario commands.

Within a vendor type, os files are categorized by device type. Nodes with the same device type all use the same files for their os upgrades, which prevents you from uploading modeling the same files for every single node.

Some vendor types and device types require multiple files. Because of this, each OS image has one or more OS files. An os file is simply a reference to a file that is found on the OS repo, so if you have multiple OS images that use the same file, you don't have to upload it twice.

Adding an OS image

To add an OS image click the create-button, a form will show up that will allow you to create a new OS image. The vendor type and device type need to be filled in. The save button creates the image.

Note that a device type is mandatory, and by default you need to pick between a number of pre-defined device types. If you want to be able to enter new device types, you can turn on the tweak Allow_custom_device_types (set its Num value to 1).

Editing an OS image

To edit an OS image click the edit-button, or double click on its record in the OS images grid. A form will show up that will allow you to modify its values. The save button saves the changes. An OS image has the following properties:

Name Description
Os name version / name of the OS image
Status The status of the os image. Only one os image can be production for a Vendor type / Device type combo. If you try to set another OS image with those types to production, the older will be set to a historic status automatically
Vendor type The vendor type of the os image
Device type The device type of the os image. Custom device types are available, depending on whether the Allow_custom_device_types is set to 1
Node type The node type for this os image. Optional.
Domain The applicable domain. Optional
Os feature any OS features
Os size the image's size in bytes
Minimum storage minimal amount of free space on the node in bytes
OS files A list of files belonging to this image
OS path target path for on the device
Pre-activation commands in case you would like to execute commands on the node before the activation of the image
Post-activation commands in case you would like to execute commands on the node after the activation of the image
Notes any notes you'd like to add

Duplicating an OS image

When you want to duplicate an OS image, simply click on the Duplicate button. A new os image with the same attributes and OS files will be created. Note that the OS files will not be copied, only the references to them.

Deleting an OS image

To delete a OS image, select the image and click the delete image button to get a prompt. Confirm, and the OS image is deleted.

Creating an OS file

To create an os file, in the OS image form, you should click on the “Create” button. A form will appear that will allow you to either upload a file, or select a file that has already been uploaded for that vendor type. Any of the two will suffice, and if you pick both then the uploaded file will override the selected file in the dropdown.

Editing an OS file

To edit an OS file click the edit-button, or double click on its record in the OS files grid. A form will show up that will allow you to modify its values. The save button saves the changes.

Name Description
Os file name The filename of the OS file
Status The status of the OS file. This is set automatically. If the status is active, then everything is allright. A status of inactive means that the file is not linked to an os image. You should not see this status in the OS file form. If the status is missing, it means that the file cannot be found in the OS repo, and some outside force must have deleted it.
MD5 Hash An automatically calculated MD5 hash of the image.
Checksum A user submitted checksum for the file
Size The size of the file in bytes
Storage The minimum bytes of storage required for this OS file
File date The date the file was uploaded

Deleting an OS file

When yo want to delete an OS file you should click on the Delete button. A popup will appear to prompt whether you want to fully delete the file. If you click on the button to keep the file, then that file can still be selected by another OS file.

Note that this popup only appears when there are no other os images that use that file. In that case, only the link will be deleted, and there will be no change to the other os image that uses that file.

menu/build/osversions.txt · Last modified: 2022/05/05 15:49 by yspeerte